Notebooks (Deployment)

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

Description

The notebooks resource returns a list of all notebooks currently open in a deployment object.

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 notebooks resource:

Use dark colors for code blocksCopy
1
https://organization.domain.com/context/admin/notebooks/deployments/e243d523-40a7-4c37-8266-9e7b5bc0c229/notebooks?f=pjson

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "notebooks": [
    {
      "itemId": "2ff206ba534541428409e327d03588d1",
      "notebookUrl": "/notebooks/fa80941bbca9404ab837c5967c80c07a/notebooks/2ff206ba534541428409e327d03588d1.ipynb",
      "itemTitle": "NBA-2",
      "dateLastActivity": 1713927612251,
      "id": "3c9b5f774a2f418dadf48c7f24a9ef1a",
      "notebookDeploymentId": "fa80941bbca9404ab837c5967c80c07a",
      "username": "jane",
      "revision": 1713915973506
    }
  ]
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.