List Snapshots

URL:
https://<notebookserveradmin>/notebooks/snapshots/list
Methods:
POST
Required Capability:
Administrator or Create and Edit
Version Introduced:
10.9

Description

The list snapshots operation allows you to list all snapshots associated with a notebook item. It returns metadata associated with snapshots, such as name, description, notebook runtime information, and so on.

By default, unless the snapshot was created with the privateAccessflag set to false , only the owner of a notebook item is allowed to list the snapshots associated with that notebook item.

Request parameters

ParameterDetails

itemId

(Required)

The item ID of the notebook from which to list snapshots.

f

(Optional)

The response format. The default response format is html.

Values: html | json | pjson

Example usage

1
2
https://notebookserver.domain.com:11443/arcgis/admin/notebooks/snapshots/list?f=json
&itemId=5dbacb22922d4ead9b8b065f3ea448b8

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
{
"snapshots": [
{
"resourceKey": "<resource-key1>",
"created": "<created time in epoch milliseconds",
"properties": {
"name": "<snapshot 1 name>",
"description": "<snapshot 1 description>",
"runtime": {
"notebookRuntimeName": "<Notebook runtime name>",
"notebookRuntimeVersion": "<Notebook runtime version>"
}
}
},
{
"resourceKey": "<resource-key2>",
"created": "<created time in epoch milliseconds",
"properties": {
"name": "<snapshot 2 name>",
"description": "<snapshot 2 description>",
"runtime": {
"notebookRuntimeName": "<Notebook runtime name>",
"notebookRuntimeVersion": "<Notebook runtime version>"
}
}
},
{
"resourceKey": "<resource-key3>",
"created": "<created time in epoch milliseconds",
"properties": {
"name": "<snapshot 3 name>",
"description": "<snapshot 3 description>",
"runtime": {
"notebookRuntimeName": "<Notebook runtime name>",
"notebookRuntimeVersion": "<Notebook runtime version>"
}
}
}
],
"total": 3,
"status": "success"
}

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
38
39
40
41
42
{
"snapshots": [
{
"resourceKey": "snapshot-274ad302559440bcab2444bd34ce3b00.json",
"created": "1601952138315",
"properties": {
"name": "Snapshot 1",
"description": "This is snapshot 1",
"runtime": {
"notebookRuntimeName": "ArcGIS Notebook Python 3 Advanced",
"notebookRuntimeVersion": "5.0"
}
}
},
{
"resourceKey": "snapshot-efe1a311bdba41eab86a6f760a5cf6a1.json",
"created": "1601952138713",
"properties": {
"name": "Snapshot 2",
"description": "This is snapshot 2",
"runtime": {
"notebookRuntimeName": "ArcGIS Notebook Python 3 Advanced",
"notebookRuntimeVersion": "5.0"
}
}
},
{
"resourceKey": "snapshot-cc949259e5144e3bade2423bc70adb00.json",
"created": "1601952138961",
"properties": {
"name": "Snapshot 3",
"description": "This is snapshot 3",
"runtime": {
"notebookRuntimeName": "ArcGIS Notebook Python 3 Advanced",
"notebookRuntimeVersion": "5.0"
}
}
}
],
"total": 3,
"status": "success"
}

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