Update (Runtime)

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

ParameterDetails

maxCPU

(Required)

The maximum number of CPU cores that can be used by a notebook deployment when this runtime is applied to it.

maxMemory

(Required)

The maximum amount of memory that can be used by a notebook deployment when this runtime is applied to it.

maxMemoryUnit

(Required)

The unit for the maxMemory parameter.

Values: g (gigabytes) | m (megabytes) | k (kilobytes) | b (bytes)

maxSwapMemory

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 maxMemory value.

maxSwapMemoryUnit

The unit for the maxSwapMemory parameter.

Values: g (gigabytes) | m (megabytes) | k (kilobytes) | b (bytes)

sharedMemory

The amount of shared memory available for each notebook deployment.

sharedMemoryUnit

The unit specified by the sharedMemory parameter.

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 update operation:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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"

pjson

JSON Response example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "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"
}

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

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close