Snapshots

statusboolean

Whether the request succeeded.

Example: true

messagestring

Human-readable description of the result.

Example: Successfully retrieved Snapshots

snapshots object[]

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

Array [

created_atstring<date-time>

ISO 8601 UTC timestamp marking when the snapshot was created.

Example: 2026-05-06T16:04:09Z

descriptionstring

Description of the snapshot.

Example: example

idinteger

Unique numeric identifier for the snapshot.

Example: 1402

is_imageboolean

Whether the snapshot is intended to be used as an image.

Example: false

namestring

Name of the snapshot.

Example: example-snapshot

region_idinteger

Identifier of the region the snapshot is in.

Example: 1129

sizeinteger

Size of the snapshot in GB.

Example: 0

statusstring

Current status of the snapshot.

Example: CREATING

updated_atstring<date-time>

ISO 8601 UTC timestamp marking when the snapshot was last updated.

Example: 2026-05-06T16:04:09Z

vm_idinteger

Identifier of the virtual machine the snapshot was created from.

Example: 2058

has_floating_ipboolean

Whether the virtual machine had a floating IP when the snapshot was created.

Example: false

labelsstring[]

Labels applied to the snapshot.

]

countinteger

Number of items returned in the current page.

Example: 0

pageintegernullable

1-indexed page number of the current result set.

page_sizeintegernullable

Number of items per page in the current result set.

Snapshots

{
  "status": true,
  "message": "Successfully retrieved Snapshots",
  "snapshots": [
    {
      "created_at": "2026-05-06T16:04:09Z",
      "description": "example",
      "id": 1402,
      "is_image": false,
      "name": "example-snapshot",
      "region_id": 1129,
      "size": 0,
      "status": "CREATING",
      "updated_at": "2026-05-06T16:04:09Z",
      "vm_id": 2058,
      "has_floating_ip": false,
      "labels": [
        "string"
      ]
    }
  ],
  "count": 0,
  "page": 0,
  "page_size": 0
}