---
title: "List Compute instances"
method: GET
path: "/instance"
tags: ["instance"]
---

# List Compute instances

`GET /instance`

## Request

- Base URL: `https://api-ch-gva-2.exoscale.com/v2`
- URL: `https://api-ch-gva-2.exoscale.com/v2/instance`
- Auth: none declared
- TypeScript: <https://skmtc.dev/exoscale/apis/exoscale-api/docs/instance/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `manager-id` string, uuid
- `manager-type` 'instance-pool'
- `ip-address` string
- `labels` string

## Response `200`

200

- object
  - `instances` object[]
    - `public-ip-assignment` 'inet4' | 'dual' | 'none'
    - `labels` Labels
    - `security-groups` SecurityGroup[]: Instance Security Groups
      - `id` string, uuid: Security Group ID
      - `name` string: Security Group name
      - `description` string: Security Group description
      - `external-sources` string[]: Security Group external sources
      - `rules` SecurityGroupRule[]: Security Group rules
        - `description` string: Security Group rule description
        - `start-port` integer: Start port of the range
        - `protocol` 'tcp' | 'esp' | 'icmp' | 'udp' | 'gre' | 'ah' | 'ipip' | 'icmpv6': Network protocol
        - `icmp` object: ICMP details
          - `code` integer
          - `type` integer
        - `end-port` integer: End port of the range
        - `security-group` SecurityGroupResource: Security Group
          - `id` string, uuid: Security Group ID
          - `name` string: Security Group name
          - `visibility` 'private' | 'public': Whether this points to a public security group. This is only valid when in the context of a rule addition which uses a public security group as a source or destination.
        - `id` string, uuid: Security Group rule ID
        - `network` string: CIDR-formatted network allowed
        - `flow-direction` 'ingress' | 'egress': Network flow direction to match
    - `name` string: Instance name
    - `instance-type` InstanceType: Compute instance type
      - `id` string, uuid: Instance type ID
      - `size` 'large' | 'huge' | 'jumbo' | 'medium' | 'mega' | 'small' | 'extra-large' | 'titan48c' | 'titan' | 'micro' | 'colossus' | 'tiny': Instance type size
      - `family` 'gpu3' | 'gpua30' | 'gpu3080ti' | 'gpu2' | 'gpu' | 'memory' | 'gpua5000' | 'gpub300' | 'gpurtx6000pro' | 'storage' | 'standard' | 'colossus' | 'cpu': Instance type family
      - `cpus` integer: CPU count
      - `gpus` integer: GPU count
      - `authorized` boolean: Requires authorization or publicly available
      - `memory` integer: Available memory
      - `zones` ZoneName[]: Instance Type available zones
    - `private-networks` object[]: Instance Private Networks
      - `id` string, uuid: Private Network ID
      - `mac-address` string: Private Network MAC address
    - `template` Template: Instance template
      - `application-consistent-snapshot-enabled` boolean: Template with Qemu Guest Agent installed for application consistent snapshot
      - `maintainer` string: Template maintainer
      - `description` string: Template description
      - `ssh-key-enabled` boolean: Enable SSH key-based login
      - `family` string: Template family
      - `name` string: Template name
      - `default-user` string: Template default user
      - `size` integer: Template size
      - `password-enabled` boolean: Enable password-based login
      - `build` string: Template build
      - `checksum` string: Template MD5 checksum
      - `boot-mode` 'legacy' | 'uefi': Boot mode (default: legacy)
      - `id` string, uuid: Template ID
      - `zones` ZoneName[]: Zones availability
      - `url` string: Template source URL
      - `version` string: Template version
      - `created-at` string, date-time: Template creation date
      - `visibility` 'private' | 'public': Template visibility
    - `state` 'expunging' | 'starting' | 'destroying' | 'running' | 'stopping' | 'stopped' | 'migrating' | 'error' | 'destroyed'
    - `ssh-key` SshKey: SSH key
      - `name` string: SSH key name
      - `fingerprint` string: SSH key fingerprint
    - `mac-address` string: Instance MAC address
    - `manager` Manager: Resource manager
      - `id` string, uuid: Manager ID
      - `type` 'sks-nodepool' | 'instance-pool': Manager type
    - `ipv6-address` string: Instance IPv6 address
    - `id` string, uuid: Instance ID
    - `ssh-keys` SshKey[]: Instance SSH Keys
      - `name` string: SSH key name
      - `fingerprint` string: SSH key fingerprint
    - `created-at` string, date-time: Instance creation date
    - `public-ip` string, ipv4: Instance public IPv4 address

## Changes

- **2026-11-06** `63da6f74c845`: 1 warning
  - added the new `gpub300` enum value to the `instances/items/instance-type/family` response property for the response status `200`
- **2026-03-16** `e05707a7b346`: 1 warning, 2 info
  - added the new `gpurtx6000pro` enum value to the `instances/items/instance-type/family` response property for the response status `200`
  - added the new optional `query` request parameter `labels`
  - added the optional property `instances/items/template/application-consistent-snapshot-enabled` to the response with the `200` status
- **2025-11-14** `352cae63dff6`: 1 warning
  - added the new `titan48c` enum value to the `instances/items/instance-type/size` response property for the response status `200`
- **2025-08-10** `814bf1ccd925`: 2 warning
  - added the new `hr-zag-1` enum value to the `instances/items/instance-type/zones/items/` response property for the response status `200`
  - added the new `hr-zag-1` enum value to the `instances/items/template/zones/items/` response property for the response status `200`
- **2025-05-22** `37a05010e8b4`: 1 warning
  - added the new `gpua30` enum value to the `instances/items/instance-type/family` response property for the response status `200`

[Operation history](https://skmtc.dev/exoscale/apis/exoscale-api/changes/instance/get.md)

---

[API](https://skmtc.dev/exoscale/apis/exoscale-api.md) - [All operations](https://skmtc.dev/exoscale/apis/exoscale-api/llms.txt) - [OpenAPI document](https://skmtc.dev/exoscale/apis/exoscale-api/revisions/63da6f74c845?raw)