Skip to main content
GET
/
volumes
List persistent volumes
curl --request GET \
  --url https://api.blaxel.ai/v0/volumes \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "metadata": {
        "createdAt": "<string>",
        "displayName": "<string>",
        "name": "<string>",
        "updatedAt": "<string>"
      },
      "spec": {
        "region": "<string>",
        "size": 123
      },
      "state": {
        "attachedTo": "sandbox:my-sandbox"
      },
      "status": "<string>",
      "terminatedAt": "<string>"
    }
  ],
  "meta": {
    "hasMore": true,
    "nextCursor": "<string>",
    "total": 123
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.blaxel.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth2 authentication with JWT tokens

Query Parameters

​
cursor
string

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.

​
limit
integer
default:50

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

Required range: 1 <= x <= 200
​
sort
enum<string>

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.

Available options:
createdAt:desc,
createdAt:asc,
name:asc,
name:desc
​
q
string

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.

Maximum string length: 200
​
anchor
enum<string>

Start from a known pagination boundary. end is only supported for createdAt:desc listings and returns the oldest page directly without walking every cursor from the first page.

Available options:
end

Response

successful operation

Cursor-paginated list of volumes. Returned starting with API version 2026-04-28; older API versions return a bare array. Items use the lite shape (no inline event history).

​
data
object[]

Page of volumes.

​
meta
object

Pagination metadata returned alongside a page of listing results. Always present on listing endpoints starting with API version 2026-04-28.

Last modified on May 27, 2026