Update an Instance Pool
PUT
/instance-pool/{id}
Path parameters
-
id string(uuid) Required
Body Required
-
anti-affinity-groups array[object] | null
Anti-affinity Group
-
description string
Instance Pool description
Maximum length is
255
. -
public-ip-assignment string
Instance public IP assignment
Values are
inet4
,dual
, ornone
. -
labels object
Private Network labels
-
security-groups array[object] | null
Security Group
-
elastic-ips array[object] | null
Elastic IP
-
name string
Instance Pool name
Minimum length is
1
, maximum length is255
. -
instance-type object
Instance Type
-
min-available integer(int64) | null
Minimum number of running Instances
Minimum value is
0
. -
private-networks array[object] | null
Private Network
-
template object
Instance Template
-
ssh-key object
Instance SSH Key
-
instance-prefix string | null
Prefix to apply to Instances names (default: pool)
-
user-data string | null
Instances Cloud-init user-data
Minimum length is
1
. -
deploy-target object
Instance Deploy Target
-
ipv6-enabled boolean
Enable IPv6. DEPRECATED: use
public-ip-assignments
. -
disk-size integer(int64)
Instances disk size in GB
Minimum value is
10
, maximum value is50000
. -
ssh-keys array[object] | null
Instance SSH Key
PUT /instance-pool/{id}
curl \
-X PUT https://api-ch-gva-2.exoscale.com/v2/instance-pool/{id} \
-H "Content-Type: application/json" \
-d '{"anti-affinity-groups":[{"name":"string","description":"string"}],"description":"string","public-ip-assignment":"inet4","labels":{},"security-groups":[{"name":"string","description":"string","external-sources":["string"],"rules":[{"description":"string","start-port":42,"protocol":"tcp","icmp":{"code":42,"type":42},"end-port":42,"security-group":{"name":"string","visibility":"private"},"network":"string","flow-direction":"ingress"}]}],"elastic-ips":[{"description":"string","healthcheck":{"strikes-ok":42,"tls-skip-verify":true,"tls-sni":"string","strikes-fail":42,"mode":"tcp","port":42,"uri":"string","interval":42,"timeout":42},"labels":{}}],"name":"string","instance-type":{},"min-available":42,"private-networks":[{"name":"string","description":"string","netmask":"string","start-ip":"string","end-ip":"string","labels":{}}],"template":{"description":"string","ssh-key-enabled":true,"name":"string","default-user":"string","size":42,"password-enabled":true,"checksum":"string","boot-mode":"legacy","zones":["ch-dk-2"],"url":"string"},"ssh-key":{"name":"string"},"instance-prefix":"string","user-data":"string","deploy-target":{"id":"string","name":"string","type":"edge","description":"string"},"ipv6-enabled":true,"disk-size":42,"ssh-keys":[{"name":"string"}]}'
Request example
{
"anti-affinity-groups": [
{
"name": "string",
"description": "string"
}
],
"description": "string",
"public-ip-assignment": "inet4",
"labels": {},
"security-groups": [
{
"name": "string",
"description": "string",
"external-sources": [
"string"
],
"rules": [
{
"description": "string",
"start-port": 42,
"protocol": "tcp",
"icmp": {
"code": 42,
"type": 42
},
"end-port": 42,
"security-group": {
"name": "string",
"visibility": "private"
},
"network": "string",
"flow-direction": "ingress"
}
]
}
],
"elastic-ips": [
{
"description": "string",
"healthcheck": {
"strikes-ok": 42,
"tls-skip-verify": true,
"tls-sni": "string",
"strikes-fail": 42,
"mode": "tcp",
"port": 42,
"uri": "string",
"interval": 42,
"timeout": 42
},
"labels": {}
}
],
"name": "string",
"instance-type": {},
"min-available": 42,
"private-networks": [
{
"name": "string",
"description": "string",
"netmask": "string",
"start-ip": "string",
"end-ip": "string",
"labels": {}
}
],
"template": {
"description": "string",
"ssh-key-enabled": true,
"name": "string",
"default-user": "string",
"size": 42,
"password-enabled": true,
"checksum": "string",
"boot-mode": "legacy",
"zones": [
"ch-dk-2"
],
"url": "string"
},
"ssh-key": {
"name": "string"
},
"instance-prefix": "string",
"user-data": "string",
"deploy-target": {
"id": "string",
"name": "string",
"type": "edge",
"description": "string"
},
"ipv6-enabled": true,
"disk-size": 42,
"ssh-keys": [
{
"name": "string"
}
]
}
Response examples (200)
{
"id": "string",
"reason": "incorrect",
"reference": {
"id": "string",
"link": "string",
"command": "string"
},
"message": "string",
"state": "failure"
}