Workspaces

URL:
https://<root>/notebooks/workspaces
Methods:
GET
Child Resources:
Create, Workspace, Status, Delete
Required Capability:
Access allowed with the "Security and infrastructure" privilege
Version Introduced:
11.4

Description

The workspaces resource returns a notebook workspace that is registered with your organization. The properties of a workspace include properties defined during the workspace creation, as well as auto-generated information provided after the workspace was created (the mountPath and id properties). This resource also provides access to the Create operation that administrators can use to create a notebook workspace.

Only one notebook workspace can be registered with your ArcGIS Enterprise Organization. The Workspaces resource will return the information for this workspace.

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

Use dark colors for code blocksCopy
1
https://organization.domain.com/context/admin/notebooks/workspaces?f=json

JSON Response example

Use dark colors for code blocksCopy
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
{
    "operations": [],
    "notebookWorkspace": {
        "name": "arcgis-notebooks-workspace",
        "id": "utz5kgaz4vd6dpj3xrsyb",
        "type": "PVC",
        "spec": {
            "storageClassName": "arcgis-storage-default",
            "volumeName": "",
            "resources": {
                "requests": {"storage": "100Gi"},
                "limits": {}
            },
            "accessModes": ["ReadWriteMany"],
            "volumeMode": "Filesystem"
        },
        "managedKubernetesResources": [{
            "purpose": "pvc",
            "kind": "PersistentVolumeClaim",
            "name": "arcgis-nb-workspace-volume-utz5kgaz4vd6dpj3xrsyb"
        }],
        "revision": 1,
        "info": {
            "volumeIdentifier": "",
            "volumePath": "/arcgis/home"
        }
    },
    "resources": []
}

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