Notebooks

URL:
https://<notebookserveradmin>/notebooks
Methods:
GET
Operations:
Restore Default Template, Update Default Template
Child Resources:
Notebook, Notebook Runtimes
Required Capability:
Administrator or Create and Edit
Version Introduced:
10.7

Description

This resource provides a list of all ArcGIS Notebooks currently running on your ArcGIS Notebook Server site. The unique ID of each notebook is shown, with the user who owns it in parentheses.

Request parameters

ParameterDetails

start

The number of the first entry in the result set response. The index number is 1-based.

The default value is 1.

Example:

1
start=5

num

The maximum number of results that will be included in the result set response. The default value is 10, and the maximum allowed value is 100.

Example:

1
2
//Returns a maximum of 50 results in a response
num=50

f

The response format. The default response format 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
{
  "total" : <total number of results>,
  "notebooks": [
    {
      "itemId": "<notebook 1 itemId>",
      "notebookUrl": "<notebook 1 url>",
      "dateLastActivity": "<epoch time in milliseconds>",
      "id": "<notebook1 id>",
      "containerId": "<containerId>",
      "username": "<notebook 1 owner username>"
    },
    {
      "itemId": "<notebook 2 itemId>",
      "notebookUrl": "<notebook 2 url>",
      "dateLastActivity": "<epoch time in milliseconds>",
      "id": "<notebook2 id>",
      "containerId": "<containerId>",
      "username": "<notebook 2 owner username>"
    }
  ],
  "num": < maximum number of results to be included in the result set response >,
  "start" : <The number of the first entry in the result set response>
}

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
{
  "total": 3,
  "notebooks": [
    {
      "itemId": "b57954c0e08b4f7db8fa4a80d8f1ab95",
      "notebookUrl": "/notebooks/84fb308295fc413cb7d6680c266cfab5/notebooks/b57954c0e08b4f7db8fa4a80d8f1ab95.ipynb",
      "dateLastActivity": "1548975258795",
      "id": "22f1b51c4cd3451e8c026eacab1114aa",
      "containerId": "84fb308295fc413cb7d6680c266cfab5",
      "username": "joe"
    },
    {
      "itemId": "5bfbb4aaa221443db4e2ddbadccafb3d",
      "notebookUrl": "/notebooks/4f8d50afb143459a8b3adee800acee3f/notebooks/5bfbb4aaa221443db4e2ddbadccafb3d.ipynb",
      "dateLastActivity": "1548976247002",
      "id": "2c914a07f80d49b7ab876d0e4c197e6c",
      "containerId": "4f8d50afb143459a8b3adee800acee3f",
      "username": "jane"
    },
    {
      "itemId": "5bfbb4aaa221443db4e2ddbadccafb3d",
      "notebookUrl": "/notebooks/84fb308295fc413cb7d6680c266cfab5/notebooks/5bfbb4aaa221443db4e2ddbadccafb3d.ipynb",
      "dateLastActivity": "1548975767414",
      "id": "33a48f6f1a7c45b5a5bb6c59ab369292",
      "containerId": "84fb308295fc413cb7d6680c266cfab5",
      "username": "joe"
    }
  ],
  "num": 10,
  "start": 1
}

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