Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
Snapshots

Update snapshot

Rename snapshot or update tags.

patch/cloud/v1/snapshots/{project_id}/{region_id}/{snapshot_id}

Path parameters

project_idinteger required

Project ID

Example:1

Project ID

region_idinteger required

Region ID

Example:1

Region ID

snapshot_idstring uuid4 required

Unique identifier of the snapshot

Example:726ecfcc-7fd0-4e30-a86e-7892524aa483

Unique identifier of the snapshot

Request body

namestring

Display name for the snapshot (3-63 chars). Used in customer portal and API. Does not affect snapshot data.

tagsUpdateTagsSerializer

Example request

{
  "name": "my-backup-snapshot"
}

Response

OK

created_atstring date-time required

Datetime when the snapshot was created

creator_task_idstring uuid4 required

Task that created this entity

descriptionstring nullable required

Snapshot description

idstring uuid4 required

Snapshot ID

namestring required

Snapshot name

project_idinteger required

Project ID

regionstring required

Region name

region_idinteger required

Region ID

sizeinteger required

Snapshot size, GiB

status'available' | 'backing-up' | 'creating' | 'deleted' | 'deleting' | 'error' | 'error_deleting' | 'restoring' | 'unmanaging' required
task_idstring uuid4 nullable required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

updated_atstring date-time required

Datetime when the snapshot was last updated

volume_idstring uuid4 required

ID of the volume this snapshot was made from

Example response

{
  "created_at": "2019-05-29T05:32:41+0000",
  "creator_task_id": "2358e3b1-5c42-4705-8950-6ddcfc19c3bd",
  "description": "Snapshot description",
  "id": "726ecfcc-7fd0-4e30-a86e-7892524aa483",
  "name": "my-snapshot",
  "project_id": 1337,
  "region": "Luxembourg 1",
  "region_id": 7,
  "size": 20,
  "tags": [
    {
      "key": "my-tag",
      "read_only": false,
      "value": "my-tag-value"
    }
  ],
  "updated_at": "2019-05-29T05:39:20+0000",
  "volume_id": "67baa7d1-08ea-4fc5-bef2-6b2465b7d227"
}