- URL:
- https://<root>/notebooks/runtimes/<runtimeID>/update
- Methods:
POST- Version Introduced:
- 11.4
Access requirements
Required privileges
The ArcGIS Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
To access notebook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above as well as the Create and edit notebooks privilege.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the ArcGIS Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the ArcGIS Portal Directory API. For security reasons, all POST requests made to the ArcGIS Enterprise Administrator API must include a token in the request body.
Description
The update operation allows you to update the properties of a notebook runtime. These settings will be applied to every notebook deployment to which the runtime is applied.
You can use this operation to update the resource limits of the runtime, such as maximum CPU and maximum memory.
Request parameters
| Parameter | Details |
|---|---|
(Required) | The minimum number of CPU cores requested for notebook deployments that use this runtime. |
(Required) | The maximum number of CPU cores requested for notebook deployments that use this runtime. |
(Required) | The minimum amount of memory requested for notebook deployments that use this runtime. |
(Required) | The unit for the Values: |
(Required) | The maximum amount of memory allowed for notebook deployments that use this runtime. |
(Required) | The unit for the Values: |
(Optional) | The maximum amount of total memory, including swap space, that can be used by a notebook deployment when this runtime is applied to it. The default value is double that of the |
(Optional) | The unit for the Values: |
(Optional) | The amount of shared memory available for each notebook deployment. |
(Optional) | The unit specified by the Values: |
(Optional) | Specifies pod placement rules for notebook deployments, such as node affinity and tolerations, to control where pods are allowed to run in the cluster. |
(Optional) | Specifies additional Kubernetes extended resource requests and limits for notebook deployments. This parameter is used to enable GPU resources. Example: |
(Optional) | The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the update operation:
POST /<context>/admin/notebooks/runtimes/a0ae041c-d11a-4840-9b06-b11c8b1d0151/update HTTP/1.1
Host: organization.example.com
Content-Type: multipart/form-data; boundary=------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Length: []
------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Disposition: form-data; name="name"
ArcGIS Notebook Python 3 Standard
------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Disposition: form-data; name="version"
10.0
------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Disposition: form-data; name="maxCpu"
2.0
------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Disposition: form-data; name="maxMemory"
4.0
------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Disposition: form-data; name="maxMemoryUnit"
g
------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Disposition: form-data; name="maxSwapMemory"
0.0
------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Disposition: form-data; name="maxSwapMemoryUnit"
g
------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Disposition: form-data; name="sharedMemory"
2048.0
------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Disposition: form-data; name="sharedMemoryUnit"
m
------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Disposition: form-data; name="f"
pjson
------WebKitFormBoundary1Ag6MtSRAeFUUkWt
Content-Disposition: form-data; name="token"
<ACCESS_TOKEN>
------WebKitFormBoundary1Ag6MtSRAeFUUkWt--JSON Response example
{
"notebookRuntime": {
"deploymentDefaultPropertyId": "prvbxlv3nd29y2gss2xuy",
"maxCpu": 2,
"version": "10.0",
"maxMemory": 4,
"esriProvidedRuntime": true,
"revision": 1713805494563,
"name": "ArcGIS Notebook Python 3 Standard",
"maxMemoryUnit": "g",
"maxSwapMemory": 0,
"maxSwapMemoryUnit": "g",
"id": "a0ae041c-d11a-4840-9b06-b11c8b1d0151",
"requiresAdvancedPrivileges": false,
"sharedMemorySizeUnit": "m",
"sharedMemorySize": 2048
},
"status": "success"
}