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

Parameter	Details
`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:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/notebooks/workspaces/utz5kgaz4vd6dpj3xrsyb?f=json

JSON Response example

Use dark colors for code blocksCopy
{
    "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

Use dark colors for code blocksCopy
{
    "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"
    }
}