Access requirements
Required privileges
The 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 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 Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
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 Notebook enterprise function.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The default response format is Values: |
Example usage
The following is a sample request URL used to access the runtimes resource:
https://organization.example.com/<context>/admin/notebooks/runtimes?f=pjsonJSON Response example
{
"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
}
]
}