- URL:
- https://<root>/notebooks/runtimes/<runtimeID>/update
- Methods:
POST- Required Capability:
- Access allowed with either the "Create and edit notebooks", "Servers", or "Security and infrastructure" privileges
- Version Introduced:
- 11.4
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 maximum number of CPU cores that can be used by a notebook deployment when this runtime is applied to it. |
(Required) | The maximum amount of memory that can be used by a notebook deployment when this runtime is applied to it. |
(Required) | The unit for the Values: |
| The maximum amount of total memory, including swap space, that can be used by a notebook deployment when this runtime is applied to it. If left unspecified, the value is double that of the |
| The unit for the Values: |
| The amount of shared memory available for each notebook deployment. |
| The unit specified by the |
| 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.domain.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"
pjsonJSON 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"
}