8.4. Updating snapshots

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

Update a snapshot.

Source: https://docs.openstack.org/api-ref/block-storage/v3/index.html#update-a-snapshot

8.4.1. Request

Name In Type Description
project_id path string The UUID of the project in a multi-tenancy cloud.
snapshot_id path string The UUID of the snapshot.
snapshot body object A snapshot object.
description (Optional) body string A description for the snapshot. Default is None.
name body string The name of the Volume Transfer.

8.4.1.1. Example

# curl -ks -X PUT -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' -d '
{
  "snapshot": {
    "name": "snapshot2",
    "description": "New description"
  }
}' https://<node_IP_addr>:8776/v3/f5d834d636c642c7bfe8af86139c6f26/snapshots/aebe052f-6c13-417a-8ea9-771f40d6667f

8.4.2. Response

Name In Type Description
status body string The status for the snapshot.
description body string A description for the snapshot.
created_at body string

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:mm value, if included, is the time zone as an offset from UTC.

name body string The name of the Volume Transfer.
snapshot body object A snapshot object.
id body string The snapshot UUID.
size body integer The size of the volume, in gibibytes (GiB).
volume_id body string If the snapshot was created from a volume, the volume ID.
user_id body string

The UUID of the user.

New in version 3.41

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

8.4.2.1. Status codes

8.4.2.1.1. Success

Code Reason
200 - OK Request was successful.

8.4.2.2. Example

{
  "snapshot": {
    "status": "available",
    "size": 2,
    "metadata": {},
    "name": "snapshot2",
    "volume_id": "cb623b3c-f14a-48d6-a339-d9fda95be662",
    "created_at": "2020-03-11T14:01:54.381048",
    "description": "New description",
    "id": "aebe052f-6c13-417a-8ea9-771f40d6667f",
    "updated_at": "2020-03-11T14:01:56.522040"
  }
}