Skip to main content
GET
List snapshot policies
Requires the IAM action storage:ListSnapshotPolicies. 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.

Path Parameters

volume_id
string<uuid>
required

Volume ID

Query Parameters

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

50

marker
string<uuid>

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

Example:

"3c9f1b2e-6d4a-4e8b-9f1c-2a3b4c5d6e7f"

enabled
boolean

Narrow to enabled (or paused) policies.

Example:

true

name
string

Exact volume-scoped name match; an empty value matches nothing.

Example:

"nightly"

crn
string

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

Response

A page of snapshot policies

snapshot_policies
object[]
required
meta
object
required