Notebooks | ArcGIS REST APIs

URL:: https://<root>/notebooks
Methods:: GET
Operations:: Open Notebook, Execute notebook, Update Default Template, Restore Default Template
Child Resources:: Deployments, Jobs, Runtimes, Snapshots, Configuration, Snippets, Workspaces, Webhook Receivers, Data Access
Version Introduced:: 11.4

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.

Manage licenses Link to organization-specific group Update Delete Security and infrastructure Servers Organization website Organization webhooks

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 generateToken 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.

Learn how to generate a token

Description

The notebooks resource provides a list of all ArcGIS Notebooks currently running in an organization. The returned information includes each notebook's unique ID and the username of the notebook's owner.

Request parameters

Parameter	Details
`f`	The response format. The default format is `html`. Values: `html` \| `json` \| `pjson`

Example usage

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

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/notebooks?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "operations": [
    "openNotebook",
    "executeNotebook",
    "updateDefaultTemplate",
    "restoreDefaultTemplate"
  ],
  "notebooks": [
    {
      "itemId": "<notebook 1 itemId>",
      "notebookUrl": "<notebook 1 url>",
      "itemTitle": "<Notebook Title 1>",
      "dateLastActivity": "<epoch time in milliseconds>",
      "id": "<notebook1 id>",
      "notebookDeploymentId": "<notebook1 deployment id>",
      "username": "<notebook 1 owner username>",
      "revision": "<revision number>"
    },
    {
      "itemId": "<notebook 2 itemId>",
      "notebookUrl": "<notebook 2 url>",
      "itemTitle": "<Notebook Title 2>",
      "dateLastActivity": "<epoch time in milliseconds>",
      "id": "<notebook1 id>",
      "notebookDeploymentId": "<notebook2 deployment id>",
      "username": "<notebook 2 owner username>",
      "revision": "<revision number>"
    }
  ]
  "resources": [
    "deployments",
    "jobs",
    "runtimes",
    "snapshots",
    "configuration",
    "snippets",
    "workspaces"
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "operations": [
    "openNotebook",
    "executeNotebook",
    "updateDefaultTemplate",
    "restoreDefaultTemplate"
  ],
  "notebooks": [
    {
      "itemId": "bf84530f0fd3482bac8bf1bf2f4a0dae",
      "notebookUrl": "/notebooks/5189b5c7a09544f3b64f562158ad55a9/notebooks/bf84530f0fd3482bac8bf1bf2f4a0dae.ipynb",
      "itemTitle": "Notebook Title 1",
      "dateLastActivity": 1713897499743,
      "id": "c493f410b16c42f895e47c8163b14907",
      "notebookDeploymentId": "5189b5c7a09544f3b64f562158ad55a9",
      "username": "jane",
      "revision": 1713896888616
    },
    {
      "itemId": "2ff206ba534541428409e327d03588d1",
      "notebookUrl": "/notebooks/4f8d50afb143459a8b3adee800acee3f/notebooks/2ff206ba534541428409e327d03588d1.ipynb",
      "itemTitle": "Notebook Title 2",
      "dateLastActivity": 1713897636436,
      "id": "4409daa27b9447f8b85b426b117d8598",
      "notebookDeploymentId": "4f8d50afb143459a8b3adee800acee3f",
      "username": "joe",
      "revision": 1713897615946
    }
  ],
  "resources": [
    "deployments",
    "jobs",
    "runtimes",
    "snapshots",
    "configuration",
    "snippets",
    "workspaces"
  ]
}