Documentation | Snapshots › List Snapshots

Snapshots

snapshots

Methods

Create Snapshot -> { tasks }

post/v1/snapshots/{project_id}/{region_id}

Create snapshot

Delete Snapshot -> { tasks }

delete/v1/snapshots/{project_id}/{region_id}/{pk}

Delete snapshot

List Snapshots -> OffsetPage<

Snapshot

get/v1/snapshots/{project_id}/{region_id}

List snapshots

Parameters

project_id: number

region_id: number

instance_id: string

Optional

Can be used to list snapshots of any volume in a specific server instance

lifecycle_policy_id: number

Optional

Can be used to list snapshots by lifecycle policy id

limit: number

Optional

Limit the number of returned snapshots

offset: number

Optional

Offset value is used to exclude the first set of records from the result

schedule_id: string

Optional

Can be used to list snapshots by schedule id

volume_id: string

Optional

Can be used to list snapshots of a single volume

Response fields

count: number

Optional

Number of objects

results: Array<

Snapshot

Optional

Objects

Request example

curl https://api.gcore.com/cloud/v1/snapshots/$PROJECT_ID/$REGION_ID \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "count": 1,
  "results": [
    {
      "created_at": "2019-05-29T05:32:41+0000",
      "description": "mysnapshot",
      "name": "123",
      "size": 2,
      "status": "available",
      "updated_at": "2019-05-29T05:39:20+0000",
      "volume_id": "67baa7d1-08ea-4fc5-bef2-6b2465b7d227"
    }
  ]
}

Get Snapshot ->

Snapshot

get/v1/snapshots/{project_id}/{region_id}/{pk}

Get snapshot

Replace Snapshot Metadata ->

Snapshot

put/v1/snapshots/{project_id}/{region_id}/{pk}/metadata

All existing metadata is deleted and replaced with the metadata from the request. To remove metadata key send body without this key.

Domain types

Snapshot = { id, created_at, creator_task_id, 11 more... }

Snapshot object