Snapshots

Retrieve list of snapshots with pagination

Retrieves a list of your current snapshots. See Snapshots for more information.

get/core/snapshots

Request

  • Base URL: https://infrahub-api.nexgencloud.com/v1
  • URL: https://infrahub-api.nexgencloud.com/v1/core/snapshots
  • Auth: API key in header api_key

Query parameters

pageinteger

Page number of results to return.

pageSizeinteger

Data Per Page

searchstring

Search By Snapshot ID or Name

Response

Success

statusboolean

Whether the request succeeded.

messagestring

Human-readable description of the result.

countinteger

Number of items returned in the current page.

pageinteger nullable

1-indexed page number of the current result set.

page_sizeinteger nullable

Number of items per page in the current result set.

Example response

{
  "status": true,
  "message": "Successfully retrieved Snapshots",
  "snapshots": [
    {
      "created_at": "2026-05-06T16:04:09Z",
      "description": "example",
      "id": 1402,
      "name": "example-snapshot",
      "region_id": 1129,
      "status": "CREATING",
      "updated_at": "2026-05-06T16:04:09Z",
      "vm_id": 2058
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.