Skip to main content
GET
List snapshots

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project ID

Example:

1

region_id
integer
required

Region ID

Example:

1

Query Parameters

instance_id
string

Optional. Filter snapshots by the instance whose volumes were snapshotted

Example:

"550e8400-e29b-41d4-a716-446655440000"

lifecycle_policy_id
integer

Optional. Filter by lifecycle policy ID

Example:

1

limit
integer
default:1000

Limit of items on a single page

Required range: x <= 1000
Example:

1000

offset
integer
default:0

Offset in results list

Required range: x >= 0
Example:

0

schedule_id
string

Optional. Filter by schedule ID

Example:

"67baa7d1-08ea-4fc5-bef2-6b2465b7d227"

volume_id
string

Optional. Filter by volume ID

Example:

"3ed9e2ce-f906-47fb-ba32-c25a3f63df4f"

Response

200 - application/json

OK

count
integer
required

Number of objects

Required range: x >= 0
Example:

1

results
SnapshotSerializer · object[]
required

Objects