Skip to main content
GET
List snapshots
Requires the IAM action storage:ListSnapshots. See STORAGE permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 500
Example:

50

marker
string<uuid>

Resume token — the last snapshot id from the previous page.

Example:

"7b1e9c4d-3a2f-4b8c-9d6e-0f1a2b3c4d5e"

volume
string

Account-owned volume UUID, CRN, or exact name.

Example:

"5f8d2c1a-9b3e-4d7a-8c6f-1e2a3b4c5d6e"

name
string

Exact snapshot name within an explicitly supplied volume filter; missing volume returns 400.

Example:

"nightly-2026-01-15"

status
enum<string>
Available options:
creating,
available,
deleting,
error
Example:

"available"

crn
string

Exact CRN filter. Malformed CRNs return 400; foreign accounts, regions or resource types return an empty page. Intersects all other filters.

snapshot_policy
string

Account-owned snapshot policy UUID or nested CRN (volume//snapshot-policy/), or exact name when volume is supplied.

Response

A page of snapshots

snapshots
object[]
required
meta
object
required