Skip to main content
GET
Get snapshot policy
Requires the IAM action storage:GetSnapshotPolicy. 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

policy_id
string<uuid>
required

Snapshot policy ID

Response

Snapshot policy details

snapshot_policy
object
required

A schedule attached to one volume: take a snapshot every interval_minutes, then keep at most retention_count of the snapshots this policy created.

Retention only ever deletes snapshots the policy itself created (those carrying its snapshot_policy reference) — a snapshot taken by hand is never reaped. It also never deletes a snapshot something depends on: a snapshot a volume was created from, including a restore still in progress, is skipped and re-examined later.