Skip to main content

Snapshots

A set of operations for creating snapshots and retrieving information about your existing ones.

Endpoint NameURLDescription
Create snapshotPOST /core/virtual-machines/{id}/snapshotsCreates a snapshot for the specific virtual machine.
List snapshotsGET /core/snapshotsLists all snapshots for the specific virtual machine.
Delete SnapshotDELETE /core/virtual-machines/{id}/snapshots/{id}Deletes a specified snapshot.
Restore SnapshotPOST /core/snapshots/{id}/restoreRestores a specified snapshot.
Retrieve Snapshot DetailsGET /core/snapshots/{id}Retrieves the details of a specified snapshot.

The snapshot object​

The response to snapshot endpoint API requests includes the snapshot object, which provides comprehensive details about your snapshots.


Attributes of the Snapshot object​

status boolean​

Indicates the success or failure of the operation. In this case, it is set to true, indicating that the operation has been successful.

message string​

A message confirming the status of the operation.

snapshot object​

An object containing details about the snapshot.

Show child attributes
id integer​

The unique identifier for the snapshot.

name string​

The name of the snapshot.

status string​

The current status of the snapshot (e.g., "SUCCESSFUL").

vm_id integer​

The unique identifier for the virtual machine.

size integer​

The estimated size of the snapshot.

region_id integer​

The unique identifier for the region.

is_image boolean​

The flag to indicate whether this snapshot is intended to be used as an image.

labels array of strings​

Labels to help identifying the virtual machine

description string​

A description of the snapshot.

has_floating_ip boolean​

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

created_at string​

The timestamp when the snapshot was created.

updated_at string​

The timestamp when the snapshot was last updated.

region string​

The name of the region where the snapshot is located.

vm_name string​

The name of the source virtual machine.

vm_status string​

The status of the source virtual machine.

vm_environment object​

Details about the environment where the virtual machine was running.

vm_flavor object​

Specifications and configuration details of the virtual machine's flavor.

vm_image object​

Information about the operating system image used by the virtual machine.

vm_keypair object​

SSH key pair information associated with the virtual machine.

The snapshot object
{
  "status": true,
  "message": "string",
  "snapshot": {
    "id": 0,
    "name": "string",
    "description": "string",
    "vm_id": 0,
    "region_id": 0,
    "status": "string",
    "is_image": false,
    "size": 0,
    "has_floating_ip": false,
    "labels": [],
    "created_at": "1970-01-01T00:00:00.000Z",
    "updated_at": "1970-01-01T00:00:00.000Z",
    "region": "string",
    "vm_name": "string",
    "vm_status": "string",
    "vm_environment": {
      "id": 0,
      "name": "string",
      "region": "string",
      "created_at": "1970-01-01T00:00:00.000Z",
      "features": {
        "network_optimised": true
      }
    },
    "vm_flavor": {
      "id": 0,
      "name": "string",
      "cpu": 0,
      "ram": 0,
      "disk": 0,
      "gpu": "string",
      "gpu_count": 0,
      "labels": [
        {
          "id": 0,
          "label": "string"
        }
      ],
      "features": {
        "network_optimised": true
      }
    },
    "vm_image": {
      "id": 0,
      "name": "string",
      "type": "string",
      "version": "string",
      "size": 0,
      "display_size": "string",
      "is_public": true
    },
    "vm_keypair": {
      "id": 0,
      "name": "string",
      "environment": "string",
      "fingerprint": "string",
      "created_at": "1970-01-01T00:00:00.000Z"
    }
  }
}

Back to top​