Skip to main content
POST
Create snapshot
Requires the IAM action storage:CreateSnapshot. 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.

Headers

Idempotency-Key
string

Optional client-generated key that makes a create replay-safe. Retrying a request with the same key returns the original outcome verbatim instead of creating a duplicate resource. Reusing a key with a different request body is rejected (422); a request whose key is still being processed returns 409. Records are honored for 24 hours. Use a UUID or similarly unique token.

Maximum string length: 255

Body

application/json
volume
string
required

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

Example:

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

name
string
required

Resource names must not start with the literal crn: prefix or be UUIDs (canonical, compact, braced, or urn:uuid: forms, in either case).

Required string length: 1 - 128
Example:

"nightly-2026-01-15"

description
string
Example:

"Nightly backup of data-vol-01"

tags
object
Example:

Response

Snapshot create accepted (status=creating)

snapshot
object
required