Sign in

v1

latestOpenAPI 3.0.32026-07-22194221292.5 KB
volumes

List persistent volumes

Returns persistent storage volumes in the workspace. Volumes can be attached to sandboxes for durable file storage that persists across sessions and sandbox deletions. Starting with API version 2026-04-28 the response is wrapped in {data, meta} and supports cursor pagination via the cursor and limit query parameters; older versions keep returning a bare array of volumes.

get/volumes

Query parameters

cursorstring

Opaque cursor returned by a previous response's meta.nextCursor. Only valid for the same query (workspace + filters); the server rejects cursors bound to a different query or older than 24h. Omit on the first page.

limitinteger

Maximum number of items to return per page. Defaults to 50, clamped to 200.

sort'createdAt:desc' | 'createdAt:asc' | 'name:asc' | 'name:desc'

Sort spec, formatted as <key>:<direction>. Allowed values are createdAt:desc (default), createdAt:asc, name:asc, name:desc. The cursor fingerprint is bound to the sort, so a cursor opened with one value cannot be reused with another. Only honoured starting on Blaxel-Version 2026-04-28.

qstring

Substring search across metadata.name, metadata.displayName and labels (keys + values). Trimmed and lowercased server-side; queries shorter than 2 characters fall back to the unfiltered listing. Bound into the cursor fingerprint so a cursor opened with one query cannot be reused with another. Only honoured starting on Blaxel-Version 2026-04-28.

anchor'end'

Start from a known pagination boundary. end is only supported for createdAt listings (asc or desc) and returns the tail page directly without walking every cursor from the first page.

externalIdstring

Filter volumes by external ID. When set, only volumes matching this caller-owned identifier are returned.

Response

successful operation

Example response

{
  "data": [
    {
      "state": {
        "attachedTo": "sandbox:my-sandbox"
      }
    }
  ]
}