Notebook Runtimes

URL:
https://<notebookserveradmin>/notebooks/runtimes/
Methods:
GET
Operations:
Register Runtime, Restore Factory Runtimes, Validate Runtimes
Child Resources:
Notebook Runtime
Required Capability:
Administrator or Create and Edit
Version Introduced:
10.7

Description

This resource provides a list of the notebook runtimes that have been registered with your ArcGIS Notebook Server site.

There is one runtime included in each Docker container image, which is applied to a container at launch time. Notebook authors open ArcGIS Notebooks in their individual containers. The runtime included with the container image makes a precise collection of Python modules available to each notebook in the container.

By default, there are two runtimes for ArcGIS Notebook Server: ArcGIS Notebook Python 3 Standard and ArcGIS Notebook Python 3 Advanced . These runtimes are loaded with their corresponding container images during ArcGIS Notebook Server installation, by running the postinstallation utility.

Request parameters

ParameterDetails

f

The response format. The default is html .

Values: html | json | pjson

JSON Response syntax

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
{
    "currentRuntimeVersion": "<currentRuntimeVersion>",
    "runtimes": [
        {
            "deprecationDate": <epoch time in milliseconds>,
            "imageId": "<runtime1 imageId>",
            "containerType": "<containerType>",
            "imagePullString": "<imagePullString>",
            "maxCpu": <maxCpu cores>,
            "version": "<runtime1 version>",
            "maxMemory": <maxMemory>,
            "esriProvidedRuntime": true|false,
            "dockerRuntime": "<dockerRuntime>",
            "name": "<runtime1 name>",
            "maxMemoryUnit": "<maxMemoryUnit>",
            "maxSwapMemory": <maxSwapMemory>,
            "maxSwapMemoryUnit": "<maxSwapMemoryUnit>",
            "disabled": true|false,
            "id": "runtime1 id",
            "requiresAdvancedPrivileges": true|false,
            "sharedMemorySizeUnit": "<sharedMemorySizeUnit>",
            "sharedMemorySize": <sharedMemorySize>
        },
        {
            "deprecationDate": <epoch time in milliseconds>,
            "imageId": "<runtime2 imageId>",
            "containerType": "<containerType>",
            "imagePullString": "<imagePullString>",
            "maxCpu": <maxCpu cores>,
            "version": "<runtime2 version>",
            "maxMemory": <maxMemory>,
            "esriProvidedRuntime": true|false,
            "dockerRuntime": "<dockerRuntime>",
            "name": "<runtime2 name>",
            "maxMemoryUnit": "<maxMemoryUnit>",
            "maxSwapMemory": <maxSwapMemory>,
            "maxSwapMemoryUnit": "<maxSwapMemoryUnit>",
            "disabled": true|false,
            "id": "runtime2 id",
            "requiresAdvancedPrivileges": true|false,
            "sharedMemorySizeUnit": "<sharedMemorySizeUnit>",
            "sharedMemorySize": <sharedMemorySize>
        }
    ]
}

JSON Response example

The following example demonstrates the response returned when the two default runtimes are loaded into the site:

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
{
    "currentRuntimeVersion": "10.0",
    "runtimes": [
        {
            "deprecationDate": 1796112000000,
            "imageId": "fc46755b0a77cb7f6dadf6818cbea6545abdf2d4bcc58fd2ff9a805ee562c09",
            "containerType": "docker",
            "imagePullString": "",
            "maxCpu": 2,
            "version": "10.0",
            "maxMemory": 6,
            "esriProvidedRuntime": true,
            "dockerRuntime": "",
            "name": "ArcGIS Notebook Python 3 Standard",
            "maxMemoryUnit": "g",
            "maxSwapMemory": 0,
            "maxSwapMemoryUnit": "g",
            "disabled": false,
            "id": "7897276e-dc36-4616-8874-7beaf6ff45d3",
            "requiresAdvancedPrivileges": false,
            "sharedMemorySizeUnit": "m",
            "sharedMemorySize": 2048
        },
        {
            "deprecationDate": 1796112000000,
            "imageId": "fc46755b0a77cb7f6dadf6818cbea6545abdf2d4bcc58fd2ff9a805ee562c09",
            "containerType": "docker",
            "imagePullString": "",
            "maxCpu": 2,
            "version": "10.0",
            "maxMemory": 6,
            "esriProvidedRuntime": true,
            "dockerRuntime": "",
            "name": "ArcGIS Notebook Python 3 Advanced",
            "maxMemoryUnit": "g",
            "maxSwapMemory": 0,
            "maxSwapMemoryUnit": "g",
            "disabled": false,
            "id": "bae2177f-4393-4201-b7af-5284f7b6cd1b",
            "requiresAdvancedPrivileges": true,
            "sharedMemorySizeUnit": "m",
            "sharedMemorySize": 2048
        }
    ]
}

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