Workspace

URL:
https://<root>/notebooks/workspaces/<workspaceId>
Methods:
GET
Required Capability:
Access allowed with the "Security and infrastructure" privilege
Version Introduced:
11.4

Description

A workspace resource returns information about the notebook workspace that is registered with your organization. The properties of a workspace includes 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 Status resource for checking the status of the workspace and the Delete operation that administrators can use to delete the notebook 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 a workspace resource:

1
https://organization.domain.com/context/admin/notebooks/workspaces/utz5kgaz4vd6dpj3xrsyb?f=json

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
{
    "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"
    }
}

JSON Response example 2

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
{
    "name": "arcgis-notebooks-workspace",
    "id": "uokbqwtd8ciyeb07oyal2",
    "type": "PVC",
    "spec": {
        "storageClassName": "",
        "volumeName": "notebooksworkspace-pv-ar-123456789",
        "resources": {
            "requests": {"storage": "135Gi"},
            "limits": {}
        },
        "accessModes": ["ReadWriteMany"],
        "volumeMode": "Filesystem"
    },
    "managedKubernetesResources": [{
        "purpose": "pvc",
        "kind": "PersistentVolumeClaim",
        "name": "arcgis-nb-workspace-volume-uokbqwtd8ciyeb07oyal2"
    }],
    "revision": 1,
    "info": {
        "volumeIdentifier": "",
        "volumePath": "/arcgis/home"
    }
}

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