Status (Workspace) | ArcGIS REST APIs

URL:: https://<root>/notebooks/workspaces/<workspaceId>/status
Methods:: GET
Version Introduced:: 11.4

Access requirements

Required privileges

The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.

Security and infrastructure Servers

To access notebook-related endpoints, administrators must be assigned a custom role that includes any of the privileges listed above as well as the Create and edit notebooks privilege.

Tokens

This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.

Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generateToken operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.

Learn how to generate a token

Description

The status resource returns the status of the notebook workspace. When the status is pending, ensure that the PV used for registering the workspace exists and can be bound. Details on a failure to bind a PV will be returned as part of eventLogs property in the notebook workspace status response. Attempting to enable the Notebook Services capability when the workspace status is pending will result in a failure.

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 the status resource:

Use dark colors for code blocksCopy
https://organization.example.com/<context>/admin/notebooks/workspaces/utz5kgaz4vd6dpj3xrsyb/status?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"
    },
    "status": "Bound"
}

JSON Response example 2

Use dark colors for code blocksCopy
{
    "eventLogs": "Kubernetes Resource PersistentVolumeClaim/arcgis-nb-workspace-volume-uiqfeuaqq3fyt7cdiszuf reported event; count: 2, reason: FailedBinding, message: volume \"notebooksworkspace-pv-ar-123456789\" already bound to a different claim.. ",
    "name": "arcgis-notebooks-workspace",
    "id": "uiqfeuaqq3fyt7cdiszuf",
    "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-uiqfeuaqq3fyt7cdiszuf"
    }],
    "revision": 1,
    "info": {
        "volumeIdentifier": "",
        "volumePath": "/arcgis/home"
    },
    "status": "Pending"
}