Listing Snapshots

GET /v3/{project_id}/snapshots

To list all volume snapshots in your project, you can send a GET request to the /v3/{project_id}/snapshots endpoint of the volume service. This request requires an authentication token, which you should include in the request headers.

info

Source: list-accessible-snapshots

Request

Body Parameters

Name	In	Type	Description
project_id	path	string	The UUID of the project in a multi-tenancy cloud.
all_tenants (Optional)	query	string	Shows details for all projects. Admin only.
sort (Optional)	query	string	Comma-separated list of sort keys and optional sort directions in the form <key>[:<direction>]. A valid direction is asc (ascending) or desc (descending).
limit (Optional)	query	integer	Requests a page size of items. Returns a number of items up to a limit value. Use limit to make an initial limited request and use the ID of the last-seen item from the response as the marker value in a subsequent limited request.
offset (Optional)	query	integer	Used with limit to return a slice of items. offset is where to start in the list.
marker (Optional)	query	string	The ID of the last-seen item. Use limit to make an initial limited request and use the ID of the last-seen item from the response as the marker value in a subsequent limited request.
with_count (Optional)	query	boolean	Whether to show count in API response; default is false. New in version 3.45.

Sample Request

Using curl

curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://api.vietnix.cloud:8776/v3/{PROJECT_ID}/snapshots

http request

GET https://api.vietnix.cloud:8776/v3/f5d834d636c642c7bfe8af86139c6f26/snapshots

Response

Parameters

Name	Type	Description
snapshots	array	A list of snapshot objects.
user_id	string	The UUID of the user. New in version 3.41
volume_id	string	If the snapshot was created from a volume, the volume ID.
name	string	The name of the snapshot.
status	string	The status for the snapshot.
description	string	A description for the snapshot.
created_at	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.
metadata	object	One or more metadata key and value pairs for the snapshot, if any.
id	string	The snapshot UUID.
size	integer	The size of the volume, in gibibytes (GiB).
count (Optional)	integer	The total count of requested resource before pagination is applied. New in version 3.45
updated_at	string	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:mm value, if included, is the time zone as an offset from UTC.
snapshots_links (Optional)	array	Links for the snapshot.

Status Code

Success

Code	Reason
200 - OK	Request was successful.

Error

Code	Reason
400 - Bad Request	Some content in the request was invalid.

Sample Response

{
    "snapshots": [
        {
            "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": {}
        },
        {
            "id": "46e81440-3f96-470c-aada-b89e713d169a",
            "created_at": "2025-10-07T07:07:22.202796",
            "updated_at": "2025-10-07T07:07:24.092480",
            "name": "Snapshot-VM-east/Ubuntu-22.04-LTS-x64/Boot volume/2025-10-07 02:07:21",
            "description": null,
            "volume_id": "97ccf169-afa9-4610-849d-abb476a7f795",
            "volume_type_id": "e9f2ecf9-697f-4af7-b084-8d4d072d7974",
            "status": "available",
            "size": 10,
            "metadata": {}
        }
    ]
}