Snapshots

Volume snapshot management

List snapshots

get

Lists all Block Storage snapshots

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Query parameters
all_tenantsstringOptional

Shows details for all project. Admin only.

sortstringOptional

Comma-separated list of sort keys and optional sort directions

sort_keystringOptional

Sorts by an attribute

sort_dirstring · enumOptional

Sorts by direction (asc or desc)

Possible values:
limitinteger · min: 1Optional

Requests a page size of items

offsetintegerOptional

Used in conjunction with limit to return items starting from the offset position

markerstringOptional

The ID of the last-seen item

with_countbooleanOptional

Whether to show count in response (microversion 3.45+)

Responses
200

OK

application/json
get
/v3/snapshots
200

OK

Create snapshot

post

Creates a volume snapshot

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Body
Responses
post
/v3/snapshots
202

Accepted

List snapshots with details

get

Lists all Block Storage snapshots with details

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Query parameters
all_tenantsstringOptional

Shows details for all project. Admin only.

sortstringOptional

Comma-separated list of sort keys and optional sort directions

sort_keystringOptional

Sorts by an attribute

sort_dirstring · enumOptional

Sorts by direction (asc or desc)

Possible values:
limitinteger · min: 1Optional

Requests a page size of items

offsetintegerOptional

Used in conjunction with limit to return items starting from the offset position

markerstringOptional

The ID of the last-seen item

with_countbooleanOptional

Whether to show count in response (microversion 3.45+)

Responses
200

OK

application/json
get
/v3/snapshots/detail
200

OK

Show snapshot details

get

Shows details for a snapshot

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
snapshot_idstring · uuidRequired

The UUID of the snapshot

Responses
200

OK

application/json
get
/v3/snapshots/{snapshot_id}
200

OK

Update snapshot

put

Updates a snapshot

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
snapshot_idstring · uuidRequired

The UUID of the snapshot

Body
Responses
200

OK

application/json
put
/v3/snapshots/{snapshot_id}
200

OK

Delete snapshot

delete

Deletes a snapshot

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
snapshot_idstring · uuidRequired

The UUID of the snapshot

Responses
delete
/v3/snapshots/{snapshot_id}
202

Request is accepted, but processing may take some time

No content

Perform snapshot action

post

Performs various actions on a snapshot

Authorizations
X-Auth-TokenstringRequired

PCD Identity Service token authentication

Path parameters
snapshot_idstring · uuidRequired

The UUID of the snapshot

Body
or
or
Responses
post
/v3/snapshots/{snapshot_id}/action
202

Request is accepted, but processing may take some time

No content

Last updated

Was this helpful?