Update snapshot
Rename snapshot or update tags.
Authorizations
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
1
Region ID
1
Unique identifier of the snapshot
"726ecfcc-7fd0-4e30-a86e-7892524aa483"
Body
Display name for the snapshot (3-63 chars). Used in customer portal and API. Does not affect snapshot data.
^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$"my-backup-snapshot"
Update key-value tags using JSON Merge Patch semantics (RFC 7386). Provide key-value pairs to add or update tags. Set tag values to null to remove tags. Unspecified tags remain unchanged. Read-only tags are always preserved and cannot be modified.
Examples:
- Add/update tags:
{'tags': {'environment': 'production', 'team': 'backend'}}adds new tags or updates existing ones. - Delete tags:
{'tags': {'old_tag': null}}removes specific tags. - Remove all tags:
{'tags': null}removes all user-managed tags (read-only tags are preserved). - Partial update:
{'tags': {'environment': 'staging'}}only updates specified tags. - Mixed operations:
{'tags': {'environment': 'production', 'cost_center': 'engineering', 'deprecated_tag': null}}adds/updates 'environment' and 'cost_center' while removing 'deprecated_tag', preserving other existing tags. - Replace all: first delete existing tags with null values, then add new ones in the same request.
Response
OK
Datetime when the snapshot was created
"2019-05-29T05:32:41+0000"
Task that created this entity
"2358e3b1-5c42-4705-8950-6ddcfc19c3bd"
Snapshot description
"Snapshot description"
Snapshot ID
"726ecfcc-7fd0-4e30-a86e-7892524aa483"
Snapshot name
"my-snapshot"
Project ID
1337
Region name
"Luxembourg 1"
Region ID
7
Snapshot size, GiB
20
Snapshot status
available, backing-up, creating, deleted, deleting, error, error_deleting, restoring, unmanaging "available"
List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
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.
null
Datetime when the snapshot was last updated
"2019-05-29T05:39:20+0000"
ID of the volume this snapshot was made from
"67baa7d1-08ea-4fc5-bef2-6b2465b7d227"