Replace snapshot tags

All existing tags are deleted and replaced with the tags from the request. To remove tag key send body without this key.

PUT /cloud/v1/snapshots/{project_id}/{region_id}/{snapshot_id}/metadata

Replace snapshot tags

cURL

curl --request PUT \
  --url https://api.gcore.com/cloud/v1/snapshots/{project_id}/{region_id}/{snapshot_id}/metadata \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "created_at": "2023-11-07T05:31:56Z",
  "creator_task_id": "<string>",
  "description": "Snapshot description",
  "id": "<string>",
  "name": "<string>",
  "project_id": 123,
  "region": "<string>",
  "region_id": 123,
  "size": 123,
  "status": "available",
  "tags": [
    {
      "key": "<string>",
      "read_only": true,
      "value": "<string>"
    }
  ],
  "task_id": null,
  "updated_at": "2023-11-07T05:31:56Z",
  "volume_id": "<string>"
}

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

region_id · integer · required

Region ID

snapshot_id · string · required

Snapshot ID

Body

application/json

{key} · string | null

Tag value. The maximum size for a value is 1024 bytes. Set to null in order to delete this tag.

Required string length: 1 - 1024

Example:

"my-tag-value"

Response

200 - application/json

Returned snapshot

created_at · string<date-time> · required

Datetime when the volume was created

Example:

"2019-05-29T05:32:41+0000"

creator_task_id · string<uuid4> · required

Task that created this entity

Example:

"2358e3b1-5c42-4705-8950-6ddcfc19c3bd"

description · string | null · required

Snapshot description

Example:

"Snapshot description"

id · string<uuid4> · required

Snapshot ID

Example:

"726ecfcc-7fd0-4e30-a86e-7892524aa483"

name · string · required

Snapshot name

Example:

"my-snapshot"

project_id · integer · required

Project ID

Example:

1337

region · string · required

Region name

Example:

"Luxembourg 1"

region_id · integer · required

Region ID

Example:

7

size · integer · required

Snapshot size, GiB

Example:

20

status · enum<string> · required

Snapshot status

Available options: available, backing-up, creating, deleted, deleting, error, error_deleting, restoring, unmanaging

Example:

"available"

tags · TagSerializer · object[] · required

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.

Show child attributes

Example:

[
  {
    "key": "my-tag",
    "read_only": false,
    "value": "my-tag-value"
  }
]

task_id · string<uuid4> | null · 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.

Example:

null

updated_at · string<date-time> · required

Datetime when the volume was last updated

Example:

"2019-05-29T05:39:20+0000"

volume_id · string<uuid4> · required

ID of the volume this snapshot was made from

Example:

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