Showing Snapshot Details
/v3/{project_id}/snapshots/{snapshot_id}Shows the details of a snapshot with the specified ID. This request requires an authentication token, which you should include in the request headers.
Source: show-a-snapshot-s-details
Request
Body Parameters
project_idstringrequiredThe UUID of the project in a multi-tenancy cloud.
snapshot_idstringrequiredThe UUID of the snapshot.
Sample Request
- cURL
- HTTP
curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://api.vietnix.cloud:8776/v3/f33507157a634f1cac71e06a70fb558e/snapshots/40181172-d8b9-46a2-a9d8-c40ed9e098b5
GET https://api.vietnix.cloud:8776/v3/f33507157a634f1cac71e06a70fb558e/snapshots/40181172-d8b9-46a2-a9d8-c40ed9e098b5
Response
Parameters
snapshotobjectrequiredA snapshot object.
user_idstringrequiredThe UUID of the user. New in version 3.41
volume_idstringrequiredIf the snapshot was created from a volume, the volume ID.
namestringrequiredThe name of the snapshot.
statusstringrequiredThe status for the snapshot.
os-extended-snapshot-attributesstringrequiredA percentage value for the build progress.
os-extended-snapshot-attributesstringrequiredThe UUID of the owning project.
descriptionstringrequiredA description for the snapshot.
created_atstringrequiredThe 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.
metadataobjectrequiredOne or more metadata key and value pairs for the snapshot, if any.
idstringrequiredThe snapshot UUID.
sizeintegerrequiredThe size of the volume, in gibibytes (GiB).
updated_atstringrequiredThe 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 Code
Success
| Code | Reason |
|---|---|
| 200 - OK | Request 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/Ubuntu-22.04-LTS-x64/Boot volume/2025-10-07 02:07:25",
"description": null,
"volume_id": "b0738bcc-3513-4066-852d-c70b8d966ffd",
"volume_type_id": "e9f2ecf9-697f-4af7-b084-8d4d072d7974",
"status": "available",
"size": 10,
"metadata": {},
"os-extended-snapshot-attributes:project_id": "f33507157a634f1cac71e06a70fb558e",
"os-extended-snapshot-attributes:progress": "100%"
}
}