Path parameters

• id string(uuid) Required

Responses

• 200 application/json

  200

  Hide response attributes Show response attributes object

  • anti-affinity-groups array[object]

    Instance Anti-affinity Groups

    Anti-affinity Group

    Hide anti-affinity-groups attributes Show anti-affinity-groups attributes object

    • id string(uuid)

      Anti-affinity Group ID

    • name string

      Anti-affinity Group name

      Minimum length is 1, maximum length is 255.

    • description string

      Anti-affinity Group description

      Maximum length is 255.

    • instances array[object]

      Anti-affinity Group instances

      Instance

      Instance

  • public-ip-assignment string

    Values are inet4, dual, or none.

  • labels object
    Hide labels attribute Show labels attribute object

    • * string Additional properties
  • security-groups array[object]

    Instance Security Groups

    Security Group

    Hide security-groups attributes Show security-groups attributes object

    • id string(uuid)

      Security Group ID

    • name string

      Security Group name

      Minimum length is 1, maximum length is 255.

    • description string

      Security Group description

      Maximum length is 255.

    • external-sources array[string]

      Security Group external sources

  • elastic-ips array[object]

    Instance Elastic IPs

    Elastic IP

    Hide elastic-ips attributes Show elastic-ips attributes object

    • id string(uuid)

      Elastic IP ID

    • ip string

      Elastic IP address

    • addressfamily string

      Elastic IP address family

      Values are inet4 or inet6.

    • cidr string

      Elastic IP cidr

    • description string

      Elastic IP description

      Maximum length is 255.

    • healthcheck object

      Elastic IP address healthcheck

      Hide healthcheck attributes Show healthcheck attributes object

      • strikes-ok integer(int64)

        Number of attempts before considering the target healthy (default: 2)

        Minimum value is 1, maximum value is 20.

      • tls-skip-verify boolean

        Skip TLS verification

      • tls-sni string

        An optional domain or subdomain to check TLS against

        Minimum length is 1, maximum length is 255.

      • strikes-fail integer(int64)

        Number of attempts before considering the target unhealthy (default: 3)

        Minimum value is 1, maximum value is 20.

      • mode string Required

        Health check mode

        Values are tcp, http, or https.

      • port integer(int64) Required

        Health check port

        Minimum value is 1, maximum value is 65535.

      • uri string

        An endpoint to use for the health check, for example '/status'

        Minimum length is 1, maximum length is 255.

      • interval integer(int64)

        Interval between the checks in seconds (default: 10)

        Minimum value is 5, maximum value is 300.

      • timeout integer(int64)

        Health check timeout value in seconds (default: 2)

        Minimum value is 2, maximum value is 60.

    • labels object
      Hide labels attribute Show labels attribute object

      • * string Additional properties
  • name string

    Instance name

    Minimum length is 1, maximum length is 255.

  • instance-type object

    Compute instance type

    Hide instance-type attributes Show instance-type attributes object

    • id string(uuid)

      Instance type ID

    • size string

      Instance type size

      Values are large, huge, jumbo, medium, mega, small, extra-large, titan48c, titan, micro, colossus, or tiny.

    • family string

      Instance type family

      Values are gpu3, gpua30, gpu3080ti, gpu2, gpu, memory, gpua5000, storage, standard, colossus, or cpu.

    • cpus integer(int64)

      CPU count

      Minimum value is 0.

    • gpus integer(int64)

      GPU count

      Minimum value is 0.

    • authorized boolean

      Requires authorization or publicly available

    • memory integer(int64)

      Available memory

      Minimum value is 0.

    • zones array[string]

      Instance Type available zones

      Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, at-vie-2, or hr-zag-1.

  • private-networks array[object]

    Instance Private Networks

    Private Network

    Hide private-networks attributes Show private-networks attributes object

    • id string(uuid)

      Private Network ID

    • mac-address string

      Private Network MAC address

  • template object

    Instance template

    Hide template attributes Show template attributes object

    • maintainer string

      Template maintainer

    • description string

      Template description

      Maximum length is 255.

    • ssh-key-enabled boolean

      Enable SSH key-based login

    • family string

      Template family

    • name string

      Template name

      Minimum length is 1, maximum length is 255.

    • default-user string

      Template default user

      Minimum length is 1, maximum length is 255.

    • size integer(int64)

      Template size

      Minimum value is 0.

    • password-enabled boolean

      Enable password-based login

    • build string

      Template build

    • checksum string

      Template MD5 checksum

    • boot-mode string

      Boot mode (default: legacy)

      Values are legacy or uefi.

    • id string(uuid)

      Template ID

    • zones array[string]

      Zones availability

      Values are ch-dk-2, de-muc-1, ch-gva-2, at-vie-1, de-fra-1, bg-sof-1, at-vie-2, or hr-zag-1.

    • url string

      Template source URL

    • version string

      Template version

    • created-at string(date-time)

      Template creation date

    • visibility string

      Template visibility

      Values are private or public.

  • state string

    Values are expunging, starting, destroying, running, stopping, stopped, migrating, error, or destroyed.

  • secureboot-enabled boolean

    Indicates if the instance has secure boot enabled

  • ssh-key object

    SSH key

    Hide ssh-key attributes Show ssh-key attributes object

    • name string

      SSH key name

      Minimum length is 1, maximum length is 255.

    • fingerprint string

      SSH key fingerprint

  • user-data string

    Instance Cloud-init user-data (base64 encoded)

    Minimum length is 1.

  • mac-address string

    Instance MAC address

  • manager object

    Resource manager

    Hide manager attributes Show manager attributes object

    • id string(uuid)

      Manager ID

    • type string

      Manager type

      Values are sks-nodepool or instance-pool.

  • tpm-enabled boolean

    Indicates if the instance has tpm enabled

  • deploy-target object

    Deploy target

    Hide deploy-target attributes Show deploy-target attributes object

    • id string(uuid) Required

      Deploy Target ID

    • name string

      Deploy Target name

      Minimum length is 1, maximum length is 255.

    • type string

      Deploy Target type

      Values are edge or dedicated.

    • description string

      Deploy Target description

      Maximum length is 255.

  • ipv6-address string

    Instance IPv6 address

  • id string(uuid)

    Instance ID

  • snapshots array[object]

    Instance Snapshots

    Snapshot

    Hide snapshots attributes Show snapshots attributes object

    • id string(uuid)

      Snapshot ID

    • name string

      Snapshot name

      Minimum length is 1, maximum length is 255.

    • created-at string(date-time)

      Snapshot creation date

    • state string

      Snapshot state

      Values are snapshotting, deleted, exporting, ready, deleting, error, or exported.

    • size integer(int64)

      Snapshot size in GiB

      Minimum value is 10, maximum value is 51200.

    • export object

      Exported snapshot information

      Hide export attributes Show export attributes object

      • presigned-url string

        Exported snapshot disk file pre-signed URL

      • md5sum string

        Exported snapshot disk file MD5 checksum

    • instance object

      Instance

  • disk-size integer(int64)

    Instance disk size in GiB

    Minimum value is 10, maximum value is 51200.

  • ssh-keys array[object]

    Instance SSH Keys

    SSH key

    Hide ssh-keys attributes Show ssh-keys attributes object

    • name string

      SSH key name

      Minimum length is 1, maximum length is 255.

    • fingerprint string

      SSH key fingerprint

  • created-at string(date-time)

    Instance creation date

  • public-ip string(ipv4)

    Instance public IPv4 address