Instance Pool

Instance Pools is an Exoscale service allowing users to provision managed groups of identical Compute instances automatically.

create-instance-pool

Create an Instance Pool

POST /instance-pool

Request body

Content-Type: application/json

Property	Type	Required	Description
`disk-size`	integer	yes	Instances disk size in GiB
`instance-type`	Instance type reference	yes	Instances type
`name`	string	yes	Instance Pool name
`size`	integer	yes	Number of Instances
`template`	Template reference	yes	Instances template
`anti-affinity-groups`	array of Anti-affinity group reference	no	Instance Pool Anti-affinity Groups
`application-consistent-snapshot-enabled`	boolean	no	Enable application consistent snapshots
`deploy-target`	Deploy target reference	no	Deploy Target to deploy Instances on
`description`	string	no	Instance Pool description
`elastic-ips`	array of Elastic IP reference	no	Instances Elastic IPs
`instance-prefix`	string	no	Prefix to apply to Instances names (default: pool)
`ipv6-enabled`	boolean	no	Enable IPv6. DEPRECATED: use `public-ip-assignments`.
`labels`	object	no	Instance Pool Labels
`min-available`	integer	no	Minimum number of running Instances
`private-networks`	array of Private network reference	no	Instance Pool Private Networks
`public-ip-assignment`	string	no	Determines public IP assignment of the Instances. Type `none` is final and can’t be changed later on. Allowed values: `inet4`, `dual`, `none`.
`security-groups`	array of Security group reference	no	Instance Pool Security Groups
`ssh-key`	SSH key reference	no	Instances SSH key
`ssh-keys`	array of SSH key reference	no	Instances SSH Keys
`user-data`	string	no	Instances Cloud-init user-data

Example

{
  "anti-affinity-groups": [
    {
      "id": "string"
    }
  ],
  "application-consistent-snapshot-enabled": true,
  "deploy-target": {
    "id": "string"
  },
  "description": "string",
  "disk-size": 0,
  "elastic-ips": [
    {
      "id": "string"
    }
  ],
  "instance-prefix": "string",
  "instance-type": {
    "id": "string"
  },
  "ipv6-enabled": true,
  "labels": {},
  "min-available": 0,
  "name": "string",
  "private-networks": [
    {
      "id": "string"
    }
  ],
  "public-ip-assignment": "inet4",
  "security-groups": [
    {
      "id": "string"
    }
  ],
  "size": 0,
  "ssh-key": {
    "name": "string"
  },
  "ssh-keys": [
    {
      "name": "string"
    }
  ],
  "template": {
    "id": "string"
  },
  "user-data": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for create-instance-pool: golang | Python | Java

CLI: exo api create-instance-pool

get-instance-pool

Retrieve Instance Pool details

GET /instance-pool/{id}

Path parameters

Name	In	Description
`id`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`anti-affinity-groups`	array of Anti-affinity group reference	Instance Pool Anti-affinity Groups
`application-consistent-snapshot-enabled`	boolean	Enable application consistent snapshots
`deploy-target`	Deploy target reference	Instance Pool Deploy Target
`description`	string	Instance Pool description
`disk-size`	integer	Instances disk size in GiB
`elastic-ips`	array of Elastic IP reference	Instances Elastic IPs
`id`	string	Instance Pool ID
`instance-prefix`	string	The instances created by the Instance Pool will be prefixed with this value (default: pool)
`instance-type`	Instance type reference	Instances type
`instances`	array of Target Instance	Instances
`ipv6-enabled`	boolean	Enable IPv6 for instances
`labels`	object	Instance Pool Labels
`manager`	Resource manager	Instance Pool manager
`min-available`	integer	Minimum number of running instances
`name`	string	Instance Pool name
`private-networks`	array of Private network reference	Instance Pool Private Networks
`public-ip-assignment`	string	Instance Pool public IP assignment Allowed values: `inet4`, `dual`, `none`.
`security-groups`	array of Security group reference	Instance Pool Security Groups
`size`	integer	Number of instances
`ssh-key`	SSH key reference	Instances SSH key
`ssh-keys`	array of SSH key reference	Instances SSH keys
`state`	string	Instance Pool state Allowed values: `scaling-up`, `scaling-down`, `destroying`, `creating`, `suspended`, `running`, `updating`.
`template`	Template reference	Instances template
`user-data`	string	Instances Cloud-init user-data

Example output

{
  "anti-affinity-groups": [
    {
      "id": "string"
    }
  ],
  "application-consistent-snapshot-enabled": true,
  "deploy-target": {
    "id": "string"
  },
  "description": "string",
  "disk-size": 0,
  "elastic-ips": [
    {
      "id": "string"
    }
  ],
  "id": "string",
  "instance-prefix": "string",
  "instance-type": {
    "id": "string"
  },
  "instances": [
    {
      "id": "string"
    }
  ],
  "ipv6-enabled": true,
  "labels": {},
  "manager": {
    "id": "string",
    "type": "sks-nodepool"
  },
  "min-available": 0,
  "name": "string",
  "private-networks": [
    {
      "id": "string"
    }
  ],
  "public-ip-assignment": "inet4",
  "security-groups": [
    {
      "id": "string"
    }
  ],
  "size": 0,
  "ssh-key": {
    "name": "string"
  },
  "ssh-keys": [
    {
      "name": "string"
    }
  ],
  "state": "scaling-up",
  "template": {
    "id": "string"
  },
  "user-data": "string"
}

SDK reference for get-instance-pool: golang | Python | Java

CLI: exo api get-instance-pool

scale-instance-pool

Scale an Instance Pool

PUT /instance-pool/{id}:scale

Path parameters

Name	In	Description
`id`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`size`	integer	yes	Number of managed Instances

Example

{
  "size": 0
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for scale-instance-pool: golang | Python | Java

CLI: exo api scale-instance-pool

update-instance-pool

Update an Instance Pool

PUT /instance-pool/{id}

Path parameters

Name	In	Description
`id`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`anti-affinity-groups`	array of Anti-affinity group reference	no	Instance Pool Anti-affinity Groups
`application-consistent-snapshot-enabled`	boolean	no	Enable application consistent snapshots
`deploy-target`	Deploy target reference	no	Instance Pool Deploy Target
`description`	string	no	Instance Pool description
`disk-size`	integer	no	Instances disk size in GiB
`elastic-ips`	array of Elastic IP reference	no	Instances Elastic IPs
`instance-prefix`	string	no	Prefix to apply to Instances names (default: pool)
`instance-type`	Instance type reference	no	Instances type
`ipv6-enabled`	boolean	no	Enable IPv6. DEPRECATED: use `public-ip-assignments`.
`labels`	object	no	Instance Pool Labels
`min-available`	integer	no	Minimum number of running Instances
`name`	string	no	Instance Pool name
`private-networks`	array of Private network reference	no	Instance Pool Private Networks
`public-ip-assignment`	string	no	Determines public IP assignment of the Instances. Allowed values: `inet4`, `dual`.
`security-groups`	array of Security group reference	no	Instance Pool Security Groups
`ssh-key`	SSH key reference	no	Instances SSH key
`ssh-keys`	array of SSH key reference	no	Instances SSH keys
`template`	Template reference	no	Instances template
`user-data`	string	no	Instances Cloud-init user-data

Example

{
  "anti-affinity-groups": [
    {
      "id": "string"
    }
  ],
  "application-consistent-snapshot-enabled": true,
  "deploy-target": {
    "id": "string"
  },
  "description": "string",
  "disk-size": 0,
  "elastic-ips": [
    {
      "id": "string"
    }
  ],
  "instance-prefix": "string",
  "instance-type": {
    "id": "string"
  },
  "ipv6-enabled": true,
  "labels": {},
  "min-available": 0,
  "name": "string",
  "private-networks": [
    {
      "id": "string"
    }
  ],
  "public-ip-assignment": "inet4",
  "security-groups": [
    {
      "id": "string"
    }
  ],
  "ssh-key": {
    "name": "string"
  },
  "ssh-keys": [
    {
      "name": "string"
    }
  ],
  "template": {
    "id": "string"
  },
  "user-data": "string"
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for update-instance-pool: golang | Python | Java

CLI: exo api update-instance-pool

delete-instance-pool

Delete an Instance Pool

DELETE /instance-pool/{id}

Path parameters

Name	In	Description
`id`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for delete-instance-pool: golang | Python | Java

CLI: exo api delete-instance-pool

Other Operations

evict-instance-pool-members

Evict Instance Pool members

PUT /instance-pool/{id}:evict

This operation evicts the specified Compute instances member from the Instance Pool, shrinking it to <current pool size> - <# evicted members>.

Path parameters

Name	In	Description
`id`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`instances`	array[string]	no

Example

{
  "instances": [
    "string"
  ]
}

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for evict-instance-pool-members: golang | Python | Java

CLI: exo api evict-instance-pool-members

reset-instance-pool-field

Reset an Instance Pool field to its default value

DELETE /instance-pool/{id}/{field}

Path parameters

Name	In	Description
`id`	`path`
`field`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`id`	string	Operation ID
`message`	string	Operation message
`reason`	string	Operation failure reason Allowed values: `incorrect`, `unknown`, `unavailable`, `forbidden`, `busy`, `fault`, `partial`, `not-found`, `interrupted`, `unsupported`, `conflict`.
`reference`	Reference	Related resource reference
`state`	string	Operation status Allowed values: `failure`, `pending`, `success`, `timeout`.

Example output

{
  "id": "string",
  "message": "string",
  "reason": "incorrect",
  "reference": {
    "command": "string",
    "id": "string",
    "link": "string"
  },
  "state": "failure"
}

SDK reference for reset-instance-pool-field: golang | Python | Java

CLI: exo api reset-instance-pool-field

list-instance-pools

List Instance Pools

GET /instance-pool

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`instance-pools`	array of Instance Pool

Example output

{
  "instance-pools": [
    {
      "anti-affinity-groups": [
        {
          "id": "string"
        }
      ],
      "application-consistent-snapshot-enabled": true,
      "deploy-target": {
        "id": "string"
      },
      "description": "string",
      "disk-size": 0,
      "elastic-ips": [
        {
          "id": "string"
        }
      ],
      "id": "string",
      "instance-prefix": "string",
      "instance-type": {
        "id": "string"
      },
      "instances": [
        {
          "id": "string"
        }
      ],
      "ipv6-enabled": true,
      "labels": {},
      "manager": {
        "id": "string",
        "type": "sks-nodepool"
      },
      "min-available": 0,
      "name": "string",
      "private-networks": [
        {
          "id": "string"
        }
      ],
      "public-ip-assignment": "inet4",
      "security-groups": [
        {
          "id": "string"
        }
      ],
      "size": 0,
      "ssh-key": {
        "name": "string"
      },
      "ssh-keys": [
        {
          "name": "string"
        }
      ],
      "state": "scaling-up",
      "template": {
        "id": "string"
      },
      "user-data": "string"
    }
  ]
}

SDK reference for list-instance-pools: golang | Python | Java

CLI: exo api list-instance-pools

Last updated on March 9, 2026