Runtimes

URL:
https://<root>/notebooks/runtimes
Methods:
GET
Child Resources:
Runtime
Required Capability:
Access allowed with "Create and edit notebooks" privilege
Version Introduced:
11.4

Description

The runtimes resource provides a list of registered notebook runtimes.

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

By default, there are two runtimes: ArcGIS Notebook Python 3 Standard and ArcGIS Notebook Python 3 Advanced. These runtimes are loaded with their corresponding container images during ArcGIS Enterprise on Kubernetes deployment by enabling the NotebookServer enterprise function.

Request parameters

ParameterDetails

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample request URL used to access the runtimes resource:

1
https://organization.domain.com/context/admin/notebooks/runtimes?f=pjson

JSON Response example

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
{
  "currentRuntimeVersion": "10.0",
  "runtimes": [
    {
      "deploymentDefaultPropertyId": "prvbxlv3nd29y2gss2xuy",
      "maxCpu": 1,
      "version": "10.0",
      "maxMemory": 4,
      "esriProvidedRuntime": true,
      "revision": 1713805494562,
      "name": "ArcGIS Notebook Python 3 Standard",
      "maxMemoryUnit": "g",
      "maxSwapMemory": 0,
      "maxSwapMemoryUnit": "g",
      "id": "a0ae041c-d11a-4840-9b06-b11c8b1d0151",
      "requiresAdvancedPrivileges": false,
      "sharedMemorySizeUnit": "m",
      "sharedMemorySize": 2048
    },
    {
      "deploymentDefaultPropertyId": "pf3pjy3e0ysivi2jhxfpv",
      "maxCpu": 2,
      "version": "10.0",
      "maxMemory": 6,
      "esriProvidedRuntime": true,
      "revision": 1713805494609,
      "name": "ArcGIS Notebook Python 3 Advanced",
      "maxMemoryUnit": "g",
      "maxSwapMemory": 0,
      "maxSwapMemoryUnit": "g",
      "id": "7715c753-2be8-43ce-949d-9688279ebeb0",
      "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