Skip to main content

Retrieve Snapshot Details

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

Retrieve details of a snapshot. For more information about snapshots, click here.


Path parameters​

snapshot_id integer  required​

The unique identifier of the snapshto to retrieve.


Attributes​

status integer​

HTTP status code indicating the result of the request.

message string​

A description of the status of the request.

snapshot object​

An object containing details about the specified snapshot.

For descriptions of the fields within the snapshot 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/{snapshot_id}" \
 -H "accept: application/json"\
 -H "api_key: YOUR API KEY"
Response
{
  "status": true,
  "message": "Retrieved snapshot 15",
  "snapshot": {
    "id": 15,
    "name": "test-a-snapshot",
    "description": "Snapshot for VM with ID 2030",
    "vm_id": 2030,
    "created_at": "2024-11-04T10:48:13",
  }
}

Returns​

Returns a snapshot object containing details on the specified snapshot. If details on the specified snapshot are not retrieved, an error will be returned.


Back to top​