Skip to main content
GET
List volumes
Related guide: Sandbox volumes.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Headers

X-Team-Id
string

Optional team ID. Must match the team_id query parameter when both are supplied. If neither selector is supplied, defaults to the caller's only accessible team. Callers with multiple accessible teams must select a team. Requests without access to any team are forbidden.

Minimum string length: 1

Query Parameters

team_id
string

Optional team ID. Must match X-Team-Id when both are supplied. If neither selector is supplied, defaults to the caller's only accessible team. Callers with multiple accessible teams must select a team. Requests without access to any team are forbidden.

Minimum string length: 1
cursor
string

Opaque cursor from the previous page; omit for the first page.

Example:

"eyJ2IjoxLCJsYXN0X2tleSI6ImJhc2V0ZW4tYXBpLXJldmlldy0wOTE2Iiwic29ydCI6ImRlc2MifQ"

limit
integer
default:20

Maximum number of items to return.

Required range: 1 <= x <= 100
Example:

20

q
string

Search volume names. Search is applied before pagination.

Example:

"datasets"

status
enum<string>[]

Volume statuses. Repeat the query parameter for each status, for example status=DEPLOYED&status=FAILED. Unknown values are rejected.

Minimum array length: 1

Volume status, always uppercase.

Available options:
DEPLOYING,
DEPLOYED,
FAILED,
DELETING

Response

Successful operation.

One page of volumes.

items
object[]
required

Resources on this page.

pagination
object
required

Cursor pagination information. The cursor is present only when another page is available.

Example: