Skip to main content

Updating Snapshots

PUT/v3/{project_id}/snapshots/{snapshot_id}

Updates a snapshot. This request requires an authentication token, which you should include in the request headers.

info

Source: update-a-snapshot

Request​

Body Parameters​

project_idstringrequiredpath

The UUID of the project in a multi-tenancy cloud.

snapshot_idstringrequiredpath

The UUID of the snapshot.

snapshotobjectrequiredbody

A snapshot object.

namestringrequiredbody

The name of the snapshot.

descriptionstringbody

A description for the snapshot. Default is None.

Sample Request​

curl -ks -X PUT -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
-d '{
  "snapshot": {
    "name": "Snapshot-VM-west",
    "description": "Snapshot-VM-west - Ubuntu 22"
  }
}' https://api.vietnix.cloud:8776/v3/f33507157a634f1cac71e06a70fb558e/snapshots/40181172-d8b9-46a2-a9d8-c40ed9e098b5

with body

{
  "snapshot": {
    "name": "Snapshot-VM-west",
    "description": "Snapshot-VM-west - Ubuntu 22"
  }
}

Response​

Parameters​

snapshotobjectrequired

A snapshot object.

user_idstringrequired

The UUID of the user. New in version 3.41

volume_idstringrequired

If the snapshot was created from a volume, the volume ID.

namestringrequired

The name of the snapshot.

statusstringrequired

The status for the snapshot.

descriptionstringrequired

A description for the snapshot.

created_atstringrequired

The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm. For example, 2015-08-27T09:49:58-05:00. The ±hh value, if included, is the time zone as an offset from UTC.

metadataobjectrequired

One or more metadata key and value pairs for the snapshot, if any.

idstringrequired

The snapshot UUID.

sizeintegerrequired

The size of the volume, in gibibytes (GiB).

updated_atstringrequired

The date and time when the resource was updated. If the resource has not been updated, this field will be null. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm:ss±hh:mm. For example, 2015-08-27T09:49:58-05:00. The ±hh value, if included, is the time zone as an offset from UTC.

Status Codes​

Success​

CodeReason
200 - OKRequest was successful.

Sample Response​

Response body
{
    "snapshot": {
        "id": "40181172-d8b9-46a2-a9d8-c40ed9e098b5",
        "created_at": "2025-10-07T07:07:26.294739",
        "updated_at": "2025-10-07T07:07:27.932048",
        "name": "Snapshot-VM-west",
        "description": "Snapshot-VM-west - Ubuntu 22",
        "volume_id": "b0738bcc-3513-4066-852d-c70b8d966ffd",
        "volume_type_id": "e9f2ecf9-697f-4af7-b084-8d4d072d7974",
        "status": "available",
        "size": 10,
        "metadata": {}
    }
}