- URL:
- https://<root>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 property in Notebook Configurations. The default value for that property 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/7f64ace427684e90a8397a5e476a4190/closeNotebook HTTP/1.1
Host: organization.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: [ ]
f=pjson&token=<token>JSON Response syntax
{
"status": "<success | failure>"
}JSON Response example
{
"status": "success"
}