UBubicloud
Virtual Machine

Get VM details

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

Request

  • Base URL
    https://api.ubicloud.com
  • URL
    https://api.ubicloud.com/project/{project_id}/location/{location}/vm/{vm_reference}
  • Auth
    HTTP bearer

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

maintenance_window_start_atinteger nullable required

Maintenance window start time

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

  • 69e3a1f69304Revision changes
    • info

      added the required property //// to the response with the status

  • 162c73892508Revision changes
    • info

      added the required property //// to the response with the status