List Compute instances

GET /instance

Query parameters

Responses

  • • 200 application/json

    200

    Hide response attribute Show response attribute object
    • instances array[object]

      Instance

      Hide instances attributes Show instances attributes object
      • public-ip-assignment string

        Instance public IP assignment

        Values are inet4, dual, or none.

      • labels object

        Private Network labels

        Hide labels attribute Show labels attribute
      • security-groups array[object]

        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

      • name string

        Instance name

        Minimum length is 1, maximum length is 255.

      • instance-type object

        Instance Type

        Hide instance-type attributes Show instance-type attributes
        • 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]

        Private Network

        Hide private-networks attributes Show private-networks attributes object
        • id string(uuid)

          Private Network ID

        • name string

          Private Network name

          Minimum length is 1, maximum length is 255.

        • description string

          Private Network description

          Maximum length is 255.

        • netmask string(ipv4)

          Private Network netmask

        • start-ip string(ipv4)

          Private Network start IP address

        • end-ip string(ipv4)

          Private Network end IP address

        • leases array[object]

          Private Network leased IP address

          Hide leases attributes Show leases attributes object
          • ip string(ipv4)

            Private Network IP address

          • instance-id string(uuid)

            Attached instance ID

        • labels object

          Private Network labels

          Hide labels attribute Show labels attribute
      • template object

        Instance Template

        Hide template attributes Show template attributes
        • 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

        Hide ssh-key attributes Show ssh-key attributes
        • name string

          SSH key name

          Minimum length is 1, maximum length is 255.

        • fingerprint string

          SSH key fingerprint

      • manager object

        Instance manager

        Hide manager attributes Show manager attributes
        • 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 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
GET /instance 
curl \
 -X GET https://api-ch-gva-2.exoscale.com/v2/instance
Response examples (200) 
{
  "instances": [
    {
      "public-ip-assignment": "inet4",
      "labels": {},
      "security-groups": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "external-sources": [
            "string"
          ]
        }
      ],
      "name": "string",
      "instance-type": {
        "id": "string",
        "size": "large",
        "family": "gpu3",
        "cpus": 42,
        "gpus": 42,
        "authorized": true,
        "memory": 42,
        "zones": [
          "ch-dk-2"
        ]
      },
      "private-networks": [
        {
          "id": "string",
          "name": "string",
          "description": "string",
          "netmask": "string",
          "start-ip": "string",
          "end-ip": "string",
          "leases": [
            {
              "ip": "string",
              "instance-id": "string"
            }
          ],
          "labels": {}
        }
      ],
      "template": {
        "maintainer": "string",
        "description": "string",
        "ssh-key-enabled": true,
        "family": "string",
        "name": "string",
        "default-user": "string",
        "size": 42,
        "password-enabled": true,
        "build": "string",
        "checksum": "string",
        "boot-mode": "legacy",
        "id": "string",
        "zones": [
          "ch-dk-2"
        ],
        "url": "string",
        "version": "string",
        "created-at": "2023-05-04T09:42:00+00:00",
        "visibility": "private"
      },
      "state": "expunging",
      "ssh-key": {
        "name": "string",
        "fingerprint": "string"
      },
      "manager": {
        "id": "string",
        "type": "sks-nodepool"
      },
      "ipv6-address": "string",
      "id": "string",
      "ssh-keys": [
        {
          "name": "string",
          "fingerprint": "string"
        }
      ],
      "created-at": "2023-05-04T09:42:00+00:00",
      "public-ip": "string"
    }
  ]
}