Skip to main content

List Snapshots

GET https://infrahub-api.nexgencloud.com/v1/core/snapshots​

Retrieves a list of your current snapshots. For more information about snapshots, click here.


Query string parameters​

search string or integer  optional​

Search for the name or ID of the snapshot to retrieve it.

page integer  optional​

The page number to retrieve snapshots from.

pageSize integer  optional​

Specify the number of snapshots to return per page.


Attributes​

status boolean​

Indicates the result of the request to retrieve a list of snapshots. true signifies success, while false indicates an error.

message string​

A description of the status of the request.

snapshots array of objects​

An array of snapshots objects, each containing details about a snapshot.

For descriptions of the fields within the snapshots object returned in response to your request, please refer to the documentation here.


Example request
curl -X GET "https://infrahub-api.nexgencloud.com/v1/core/snapshots" \
 -H "accept: application/json"\
 -H "api_key: YOUR API KEY"
Response
{
  "status": true,
  "message": "string",
  "snapshots": [
    {
      "id": 0,
      "name": "string",
      "description": "string",
      "vm_id": 0,
      "region_id": 0,
      "status": "string",
      "is_image": true,
      "size": 0,
      "labels": ["string"]
    }
  ],
  "count": 0,
  "page": 0,
  "page_size": 0
}

Returns​

Returns a list of your snapshots as snapshot objects, each containing details about the snapshot.



Back to top​