Sign in
Virtual Machine

Get VM details

get/project/{project_id}/location/{location}/vm/{vm_reference}

Response

A VM

boot_imagestring required

Boot image of the VM

idstring required

ID of the VM

ip4string ipv4 nullable required

IPv4 address

ip4_enabledboolean required

Whether IPv4 is enabled

ip6string ipv6 nullable required

IPv6 address

locationstring required

Location of the VM

namestring required

Name of the VM

sizestring required

Size of the underlying VM

statestring required

State of the VM

storage_size_gibinteger required

Storage size in GiB

unix_userstring required

Unix user of the VM

private_ipv4string ipv4 required

Private IPv4 address

private_ipv6string ipv6 required

Private IPv6 address

subnetstring required

Subnet of the VM

gpustring

GPU configuration

Example response

{
  "id": "vmhfy8gff8c67hasb0eez2k1pd",
  "location": "eu-central-h1",
  "name": "my-vm-name",
  "firewalls": [
    {
      "firewall_rules": [
        {
          "id": "fraz0q3vbrpa7pkg7zbmah9csn"
        }
      ],
      "id": "fwfg7td83em22qfw9pq5xyfqb7"
    }
  ]
}

Changes

Changed in 3 of the 59 revisions of this API.3

  • 162c738925081See the full diff
    • ○

      added the required property allOf[Vm]/boot_image to the response with the 200 status

      response-required-property-added

  • 65eaca27bbb71See the full diff
    • ○

      added the required property allOf[subschema #2]/firewalls/items/firewall_rules/items/protocol to the response with the 200 status

      response-required-property-added

  • d81708f425bb1See the full diff
    • ○

      added the required property allOf[subschema #2]/firewalls/items/firewall_rules/items/description to the response with the 200 status

      response-required-property-added