Skip to main content

Core Virtual Machine Operations

A set of operations for creating virtual machines and retrieving information about your existing virtual machines.

Endpoint NameURLDescription
Create virtual machines /core/virtual-machinesCreates one or more virtual machines with the specified custom configuration and features.
List virtual machinesGET /core/virtual-machinesReturns a list of your existing virtual machines.
Retrieve virtual machine detailsGET /core/virtual-machines/{id}Retrieves the details of an existing virtual machine.

The instances object

The response to virtual machine endpoint API requests includes the instances object, which provides comprehensive details about your virtual machines. This information includes hardware specifications, security configuration, current power state, storage details, date and time of initiation, and more.


Attributes


id integer

The unique identifier for the virtual machine.


name string

The name of the virtual machine.


status string

The current status of the virtual machine (e.g., "ACTIVE").


environment object

An object containing information about the environment in which the virtual machine is deployed.

Show child attributes
id integer

The unique identifier for the environment.


name string

The name of the environment.


org_id integer

The organization ID associated with the environment.


region string

The name of the region where the environment is deployed.


features object

An object containing feature flags enabled in the environment.

Show child attributes
network_optimised boolean

Whether high-speed networking is enabled for this environment.


green_status string

The sustainability indicator for the environment (e.g., "GREEN").


image object

An object containing information about the operating system image installed on the virtual machine.

Show child attributes
name string

The name of the operating system image.


flavor object

An object containing details about the flavor (hardware configuration) of the virtual machine.

Show child attributes
id integer

The unique identifier for the flavor.


name string

The name of the flavor.


cpu integer

The number of CPUs in the flavor.


ram number

The amount of RAM in the flavor (in gigabytes).


disk integer

The size of the disk associated with the flavor (in gigabytes).


ephemeral integer

The size of ephemeral storage associated with the flavor (in gigabytes).


gpu string

The type of GPU associated with the flavor.


gpu_count integer

The number of GPUs associated with the flavor.


labels array

An array of labels associated with the flavor.


features object

An object containing feature flags for the flavor.

Show child attributes
network_optimised boolean

Whether the flavor supports high-speed networking.


no_hibernation boolean

Whether hibernation is disabled for this flavor.


no_snapshot boolean

Whether snapshotting is disabled for this flavor.


local_storage_only boolean

Whether the flavor only supports local storage.


os string

The operating system installed on the virtual machine.


keypair object

An object containing information about the SSH key pair associated with the virtual machine.

Show child attributes
name string

The name of the key pair.


volume_attachments array

An array containing information about attached volumes.

Show child attributes
volume object

An object containing details about the attached volume.

Show child attributes
id integer

The unique identifier for the volume.


name string

The name of the volume.


description string

The description of the volume.


volume_type string

The type of the volume.


size integer

The size of the volume (in gigabytes).


bootable boolean

Indicates whether the volume is bootable.


status string

The status of the volume attachment.


device string

The device name associated with the volume attachment.


created_at date-time

The timestamp when the volume attachment was created.


security_rules array

An array containing objects providing details on firewall rules applied to the virtual machine.

Show child attributes
id integer

The unique identifier for the firewall rule.


direction string

The direction of the firewall rule (e.g., "egress", "ingress").


protocol string

The protocol associated with the firewall rule.


port_range_min integer

The minimum port range for the firewall rule.


port_range_max integer

The maximum port range for the firewall rule.


ethertype string

The Ethernet type for the firewall rule (e.g., "IPv4", "IPv6").


remote_ip_prefix string

The remote IP prefix associated with the firewall rule.


status string

The status of the firewall rule (e.g., "SUCCESS").


created_at date-time

The timestamp when the firewall rule was created.


power_state string

The power state of the virtual machine (e.g., "RUNNING").


vm_state string

The state of the virtual machine (e.g., "active").


fixed_ip string

The fixed IP address assigned to the virtual machine.


floating_ip string or null

The floating IP address assigned to the virtual machine.


floating_ip_status string

The status of the floating IP address (e.g., "NO FLOATING IP").


callback_url string or null

A callback URL that can be used for notifications related to this VM.


locked boolean

Indicates whether the VM is locked from certain operations.


contract_id integer or null

The ID of the contract that affects the billing agreement for this virtual machine.


labels array of strings

An array of labels applied to the virtual machine for organizational and identification purposes. These labels can be updated after VM deployment using the update virtual machine labels endpoint.


created_at date-time

The timestamp when the virtual machine was created.


features object

An object containing additional feature flags associated with the VM.

Show child attributes
network_optimised boolean

Whether high-speed networking is enabled on the VM.


green_status string

The sustainability indicator for the VM (e.g., "GREEN").


is_snapshotting boolean

Whether the VM is currently undergoing a snapshot operation.


cluster_id integer or null

The ID of the Kubernetes cluster the VM is attached to, if applicable.


port_randomization boolean

Indicates if random port assignment is enabled for public access.


port_randomization_status string

The status of port randomization (e.g., "NO_FLOATING_IP").


requires_public_ip boolean

Whether the VM requires a floating IP to function correctly.

The instances object
{
"id": 287713,
"name": "example-vm",
"status": "ACTIVE",
"environment": {
"id": 29862,
"name": "example-env",
"org_id": 3971,
"region": "CANADA-1",
"features": {
"network_optimised": true,
"green_status": "GREEN"
}
},
"image": {
"name": "Ubuntu Server 22.04 LTS R535 CUDA 12.2 with Docker"
},
"flavor": {
"id": 111,
"name": "n3-RTX-A6000x1",
"cpu": 28,
"ram": 58.0,
"disk": 100,
"ephemeral": 0,
"gpu": "RTX-A6000",
"gpu_count": 1,
"labels": [],
"features": {
"network_optimised": false,
"no_hibernation": false,
"no_snapshot": false,
"local_storage_only": false
}
},
"os": "Ubuntu Server 22.04 LTS R535 CUDA 12.2 with Docker",
"keypair": {
"name": "example-key"
},
"volume_attachments": [
{
"volume": {
"id": 20020,
"name": "example-volume",
"description": "",
"volume_type": "Cloud-SSD",
"size": 100,
"bootable": false
},
"status": "ATTACHED",
"device": "/dev/vdb",
"created_at": "2025-07-03T13:59:12"
}
],
"power_state": "RUNNING",
"vm_state": "active",
"fixed_ip": "10.0.11.152",
"floating_ip": null,
"floating_ip_status": "NO FLOATING IP",
"security_rules": [
{
"id": 984202,
"direction": "ingress",
"protocol": "tcp",
"port_range_min": 22,
"port_range_max": 22,
"ethertype": "IPv4",
"remote_ip_prefix": "0.0.0.0/0",
"status": "SUCCESS",
"created_at": "2025-07-03T13:09:59"
},
{...}
],
"callback_url": null,
"locked": false,
"contract_id": null,
"labels": [],
"created_at": "2025-07-03T13:08:49",
"features": {
"network_optimised": false,
"green_status": "GREEN"
},
"is_snapshotting": false,
"cluster_id": null,
"port_randomization": true,
"port_randomization_status": "NO_FLOATING_IP",
"requires_public_ip": false
}

Back to top