Instance

statusboolean

Whether the request succeeded.

Example: true

messagestring

Human-readable description of the result.

Example: Getting VM detail successful

instance object

Virtual machine the entry refers to.

idinteger

Unique numeric identifier for the virtual machine.

Example: 1402

namestring

Name of the virtual machine.

Example: example-vm

statusstring

Current status of the virtual machine.

Example: CREATING

environment object

Environment the virtual machine is deployed in.

idinteger

Unique numeric identifier for the environment.

Example: 9876

namestring

Name of the environment.

Example: example-environment

org_idinteger

Identifier of the organization the environment belongs to.

Example: 7613

regionstring

Region the environment is in: CANADA-1, NORWAY-1, or US-1.

Example: NORWAY-1

features object

Feature flags enabled in the environment.

network_optimisedboolean

Whether high-speed networking is enabled for the environment.

Example: false

green_statusstring

Indicator of how much of the region's capacity is running on green energy.

Possible values: [GREEN, PARTIALLY_GREEN, NOT_GREEN]

Example: GREEN

image objectnullable

Operating system image installed on the VM.

namestring

Name of the operating system image installed on the virtual machine.

Example: Ubuntu Server 24.04 LTS (Noble Numbat)

flavor object

Flavor (GPU and CPU configuration) of the virtual machine.

idinteger

Unique numeric identifier for the flavor.

Example: 8429

namestring

Name of the flavor.

Example: n1-cpu-small

cpuinteger

Number of CPU cores.

Example: 4

raminteger

Memory allocated to the flavor, in GB.

Example: 4

diskinteger

Root disk capacity, in GB.

Example: 100

ephemeralinteger

Ephemeral disk capacity, in GB. Cleared when the VM is deleted.

Example: 0

gpustring

GPU model name. Empty string if the flavor has no GPU.

Example:

gpu_countinteger

Number of GPUs attached to the flavor.

Example: 0

labels object[]

Labels associated with the flavor.

Array [

idinteger

Unique numeric identifier for the label.

labelstring

The label name.

]

features object

Feature flags for the flavor, such as high-speed networking and hibernation or snapshot restrictions.

object

osstring

Operating system installed on the virtual machine.

Example: Ubuntu Server 24.04 LTS (Noble Numbat)

keypair object

SSH key pair attached to the VM.

namestring

Name of the SSH key pair attached to the virtual machine.

Example: example-keypair

volume_attachments object[]

Volumes currently attached to the VM.

Array [

idinteger

Unique numeric identifier for the volume attachment.

volume object

Volume attached to the virtual machine.

idinteger

Unique numeric identifier for the volume.

Example: 1402

namestring

Name of the volume.

Example: example-volume

descriptionstring

Description of the volume.

Example: example

volume_typestring

Storage tier of the volume.

Example: Cloud-SSD

bootableboolean

Whether the volume is a bootable volume.

Example: false

sizeinteger

Volume capacity in GB.

Example: 10

statusstring

Status of the volume attachment.

Example: ATTACHING

devicestring

Device path the volume is attached at on the VM.

Example: /dev/disk/by-id/virtio-a66fd1a8-e198-4eb4-a

protectedboolean

When true, the volume attachment is protected from deletion.

Example: false

created_atstring<date-time>

ISO 8601 UTC timestamp marking when the volume attachment was created.

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

]

security_rules object[]

Firewall rules applied to the virtual machine.

Array [

idinteger

Unique numeric identifier for the firewall rule.

Example: 1129

directionstring

Direction of traffic the rule applies to, ingress or egress.

Example: egress

protocolstring

Protocol, one of tcp, udp, icmp, or any.

Example: any

port_range_mininteger

Lower bound (inclusive) of the port range the rule applies to.

Example: 1

port_range_maxinteger

Upper bound (inclusive) of the port range the rule applies to.

Example: 65535

ethertypestring

Internet Protocol version, IPv4 or IPv6.

Example: IPv4

remote_ip_prefixstring

CIDR block the rule applies to.

Example: 0.0.0.0/0

statusstring

Status of the firewall rule.

Example: SUCCESS

created_atstring<date-time>

ISO 8601 UTC timestamp marking when the firewall rule was created.

Example: 2026-05-06T15:18:42Z

]

power_statestringnullable

Current power state reported by the hypervisor.

Example: NOSTATE

vm_statestringnullable

Current VM lifecycle state.

Example: building

fixed_ipstringnullable

Fixed (private) IP address assigned to the VM in its environment.

Example: 192.0.2.91

floating_ipstringnullable

Floating (public) IP address attached to the VM, or null if none.

Example: 203.0.113.205

floating_ip_statusstringnullable

Status of the floating IP address.

Example: NO FLOATING IP

port_randomization_statusstringnullable

Status of port randomization.

Example: NO_FLOATING_IP

port_randomizationboolean

Whether random port assignment is enabled for public access.

Example: true

callback_urlstringnullable

Webhook URL called with notifications about this virtual machine, or null if none is set.

lockedboolean

Whether the virtual machine is locked from certain operations.

Example: false

contract_idintegernullable

Identifier of the contract the virtual machine is billed under, or null if none.

created_atstring<date-time>

ISO 8601 UTC timestamp marking when the virtual machine was created.

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

labelsstring[]

User-supplied tags applied to the virtual machine for grouping and identification.

features object

Feature flags enabled on the virtual machine, such as high-speed networking.

object

requires_public_ipboolean

Whether the virtual machine requires a floating IP to function correctly.

Example: false

Instance

{
  "status": true,
  "message": "Getting VM detail successful",
  "instance": {
    "id": 1402,
    "name": "example-vm",
    "status": "CREATING",
    "environment": {
      "id": 9876,
      "name": "example-environment",
      "org_id": 7613,
      "region": "NORWAY-1",
      "features": {
        "network_optimised": false,
        "green_status": "GREEN"
      }
    },
    "image": {
      "name": "Ubuntu Server 24.04 LTS (Noble Numbat)"
    },
    "flavor": {
      "id": 8429,
      "name": "n1-cpu-small",
      "cpu": 4,
      "ram": 4,
      "disk": 100,
      "ephemeral": 0,
      "gpu": "",
      "gpu_count": 0,
      "labels": [
        {
          "id": 0,
          "label": "string"
        }
      ],
      "features": {}
    },
    "os": "Ubuntu Server 24.04 LTS (Noble Numbat)",
    "keypair": {
      "name": "example-keypair"
    },
    "volume_attachments": [
      {
        "id": 0,
        "volume": {
          "id": 1402,
          "name": "example-volume",
          "description": "example",
          "volume_type": "Cloud-SSD",
          "bootable": false,
          "size": 10
        },
        "status": "ATTACHING",
        "device": "/dev/disk/by-id/virtio-a66fd1a8-e198-4eb4-a",
        "protected": false,
        "created_at": "2026-05-06T16:04:09Z"
      }
    ],
    "security_rules": [
      {
        "id": 1129,
        "direction": "egress",
        "protocol": "any",
        "port_range_min": 1,
        "port_range_max": 65535,
        "ethertype": "IPv4",
        "remote_ip_prefix": "0.0.0.0/0",
        "status": "SUCCESS",
        "created_at": "2026-05-06T15:18:42Z"
      }
    ],
    "power_state": "NOSTATE",
    "vm_state": "building",
    "fixed_ip": "192.0.2.91",
    "floating_ip": "203.0.113.205",
    "floating_ip_status": "NO FLOATING IP",
    "port_randomization_status": "NO_FLOATING_IP",
    "port_randomization": true,
    "callback_url": "string",
    "locked": false,
    "contract_id": 0,
    "created_at": "2026-05-06T16:04:09Z",
    "labels": [
      "string"
    ],
    "features": {},
    "requires_public_ip": false
  }
}