Terminate Deployment

URL:
https://<root>/notebooks/deployments/<deploymentId>/terminateDeployment
Methods:
POST
Required Capability:
Access allowed with "Create and edit notebooks" privilege
Version Introduced:
11.4

Description

The terminateDeployment operation stops a running notebook deployment. Administrators can terminate notebook deployments owned by any user. Other users can only terminate notebook deployments they own.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the terminateDeployment operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
 POST /context/admin/notebooks/deployments/<deploymentId>/terminateDeployment HTTP/1.1
 Host: organization.domain.com
 Content-Type: application/x-www-form-urlencoded
 Content-Length: []

 f=pjson&token=<token>

JSON Response example

Use dark colors for code blocksCopy
1
2
3
{
  "status": "success"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.