- URL:
- https://<root>/notebooks/deployments/<deploymentId>/notebooks/<notebookId>/closeNotebook
- Methods:
POST- Required Capability:
- Access allowed with "Create and edit notebooks" privilege
- Version Introduced:
- 11.4
Description
The close operation stops a running notebook. Idle notebooks are automatically cleaned up according to the duration defined by the idle notebook configuration.
The default value for idle is 12 hours.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the close operation:
POST /context/admin/notebooks/deployments/e243d523-40a7-4c37-8266-9e7b5bc0c229/notebooks/4565c98f-e815-4ef5-a813-63e8ba22e41b/closeNotebook HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
f=pjson&token=<token>JSON Response example
{
"status": "success"
}