Query parameters

• manager-id string(uuid)
• manager-type string

  Value is instance-pool.

• ip-address string

Responses

• 200 application/json

  200

  Hide response attribute Show response attribute object

  • instances array[object]
    Hide instances attributes Show instances attributes object

    • public-ip-assignment string

      Instance public IP assignment

      Values are inet4, dual, or none.

    • labels object

      Resource labels

      Hide labels attribute Show labels attribute object

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

      Instance Security Groups

      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

    • name string

      Instance name

      Minimum length is 1, maximum length is 255.

    • instance-type object

      Instance Type

      Additional properties are allowed.

      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, titan, micro, colossus, or tiny.

      • family string

        Instance type family

        Values are gpu3, gpu2, gpu, memory, 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, or at-vie-2.

    • private-networks array[object]

      Instance Private Networks

      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

      Additional properties are allowed.

      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, or at-vie-2.

      • 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

      Instance state

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

    • ssh-key object

      Instance SSH Key

      Additional properties are allowed.

      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

    • mac-address string

      Instance MAC address

    • manager object

      Instance manager

      Additional properties are allowed.

      Hide manager attributes Show manager attributes object

      • id string(uuid)

        Manager ID

      • type string

        Manager type

        Values are sks-nodepool or instance-pool.

    • ipv6-address string

      Instance IPv6 address

    • id string(uuid)

      Instance ID

    • ssh-keys array[object]

      Instance SSH Keys

      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