Workspaces

List workspaces

Changed on
get/api/v1/workspaces

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/workspaces
  • Auth: none declared

Query parameters

ownerstring

Admin-only owner filter.

phase'Queued' | 'Creating' | 'Starting' | 'Running' | 'Degraded' | 'Failed' | 'Stopped' | 'Deleting' | 'Deleted' | 'Pending'

Derived from compute service phase + replicas. Hoisted to the top of Workspace for B-tree filtering.

qstring

Keyword (matches displayName / image).

limitinteger

Page size (default 50, max 200).

continuestring

Opaque continue token from the previous response.

Headers

X-Axisml-Tenantstring

Active tenant for the request (fallback for the axisml.tenant cookie).

Response

A page of workspaces.

continueTokenstring

Opaque token to fetch the next page.

countinteger required

Number of workspaces in this page.

partialboolean

True if the list was truncated by an upstream limit.

Example response

{
  "continueToken": "",
  "count": 1,
  "items": [
    {
      "args": [
        "--NotebookApp.token="
      ],
      "command": [
        "start-notebook.sh"
      ],
      "computeNamespace": "axisml-team-vision",
      "containerPort": 8888,
      "createdAt": "2026-06-20T08:00:00Z",
      "description": "JupyterLab interactive development environment.",
      "desiredState": "Running",
      "displayName": "Vision team dev environment",
      "endpoint": {
        "accessUrl": "https://axisml.example.com/ws/team-vision/notebook-dev/",
        "internalDns": "notebook-dev.axisml-team-vision.svc.cluster.local",
        "tools": [
          {
            "label": "JupyterLab",
            "name": "jupyter",
            "url": "https://axisml.example.com/ws/team-vision/notebook-dev/lab"
          },
          {
            "label": "VS Code",
            "name": "vscode",
            "url": "https://axisml.example.com/ws/team-vision/notebook-dev/vscode/"
          },
          {
            "label": "Terminal",
            "name": "terminal",
            "url": "https://axisml.example.com/ws/team-vision/notebook-dev/terminals/1"
          }
        ]
      },
      "env": [
        {
          "name": "JUPYTER_ENABLE_LAB",
          "value": "yes"
        }
      ],
      "id": "f1e2d3c4-5b6a-4798-8c0d-1e2f3a4b5c6d",
      "image": "registry.axisml.io/dev/jupyter:3.0.0",
      "lastStartedAt": "2026-06-28T09:00:00Z",
      "lifecycle": {
        "idleTimeoutSeconds": 3600
      },
      "message": "Workspace is ready.",
      "name": "notebook-dev",
      "namespace": "team-vision",
      "owner": "li.wei",
      "ownerId": "3a2b1c0d-4e5f-6789-abcd-ef0123456789",
      "phase": "Running",
      "poolName": "gpu-a100",
      "readyReplicas": 1,
      "replicas": 1,
      "resources": {
        "cpu": "4",
        "memory": "32Gi",
        "nvidia.com/gpu": "1"
      },
      "tenantDisplayName": "Vision Team",
      "tenantName": "team-vision",
      "unitName": "a100-1x",
      "updatedAt": "2026-06-28T09:30:00Z",
      "volumes": [
        {
          "mountPath": "/home/jovyan/work",
          "name": "notebook-data",
          "used": "12Gi"
        }
      ]
    }
  ],
  "partial": false
}

Changes

  • c37335303c98Revision changes
    • warning

      added the new Queued enum value to the ////// response property for the response status

    • info

      added the new enum value Queued to the query request parameter phase

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • f32021921d33Revision changes
    • warning

      removed the optional property // from the response with the status