- URL:
- https://<root>/notebooks/deployments
- Methods:
GET- Child Resources:
- Deployment
- Required Capability:
- Access allowed with "Create and edit notebooks" privilege
- Version Introduced:
- 11.4
Description
The deployments resource returns a list of Kubernetes deployment objects, and their properties, that are present in the cluster for a user. An administrator can view and manage notebook deployments that are owned by all users. Non-administrator organization members will only see the notebook deployments they own.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Response properties
| Property | Details |
|---|---|
| The version of the notebook runtime used for this notebook deployment. |
| The name of the notebook runtime used for this notebook deployment. |
| When the notebook deployment was created. |
| By default, hidden files, files that have names starting with a dot (.), stored in a user's workspace cannot be downloaded using the data access download API. Set this property to |
| The ID of the notebook deployment in the site. |
| The ID of the notebook runtime used for this notebook deployment. |
| The user the notebook deployment is assigned to. Only one user can be assigned any given container. |
Example usage
The following is a sample request URL used to access the deployments resource:
https://organization.domain.com/context/admin/notebooks/deployments?f=pjsonJSON Response example
{
"nbDeployments": [
{
"privateUrl": "",
"type": "openNotebook",
"url": "/notebooks/fa80941bbca9404ab837c5967c80c07a",
"notebookRuntimeVersion": "10.0",
"revision": 1713915907561,
"notebookRuntimeName": "ArcGIS Notebook Python 3 Advanced",
"dateCreated": 1713915907560,
"numNotebooks": 1,
"deploymentId": "ktdqlmr8nyebm0qox7ivu",
"id": "fa80941bbca9404ab837c5967c80c07a",
"notebookRuntimeId": "7715c753-2be8-43ce-949d-9688279ebeb0",
"username": "jane",
"notebookToken": ""
},
{
"privateUrl": "",
"type": "openNotebook",
"url": "/notebooks/6a2cec58844e4a0a8c2ab94e8c1e9590",
"notebookRuntimeVersion": "10.0",
"revision": 1713931004917,
"notebookRuntimeName": "ArcGIS Notebook Python 3 Standard",
"dateCreated": 1713931004916,
"numNotebooks": 0,
"deploymentId": "kf2371z89qln4q9e6ddkk",
"id": "6a2cec58844e4a0a8c2ab94e8c1e9590",
"notebookRuntimeId": "a0ae041c-d11a-4840-9b06-b11c8b1d0151",
"username": "joe",
"notebookToken": ""
}
]
}