Update an Instance Pool

PUT /instance-pool/{id}

Path parameters

id string(uuid) Required

application/json

Body Required

anti-affinity-groups array[object] | null

Instance Pool Anti-affinity Groups

Anti-affinity Group
Hide anti-affinity-groups attributes Show anti-affinity-groups attributes object
- name string
  
  Anti-affinity Group name
  
  Minimum length is 1, maximum length is 255.
- description string
  
  Anti-affinity Group description
  
  Maximum length is 255.
description string

Instance Pool description

Maximum length is 255.
public-ip-assignment string

Determines public IP assignment of the Instances.

Values are inet4 or dual.
labels object
Hide labels attribute Show labels attribute object
- * string Additional properties
security-groups array[object] | null

Instance Pool Security Groups

Security Group
Hide security-groups attributes Show security-groups attributes object
- 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
- rules array[object]
  
  Security Group rules
  
  Security Group rule
  Hide rules attributes Show rules attributes object
  
  description string
  
  Security Group rule description
  
  Maximum length is 255.
  
  start-port integer(int64)
  
  Start port of the range
  
  Minimum value is 1, maximum value is 65535.
  
  protocol string
  
  Network protocol
  
  Values are tcp, esp, icmp, udp, gre, ah, ipip, or icmpv6.
  
  icmp object
  
  ICMP details
  
  Hide icmp attributes Show icmp attributes object
  
  code integer(int64)
  
  Minimum value is -1, maximum value is 254.
  
  type integer(int64)
  
  Minimum value is -1, maximum value is 254.
  
  end-port integer(int64)
  
  End port of the range
  
  Minimum value is 1, maximum value is 65535.
  
  security-group object
  
  Security Group
  
  Hide security-group attributes Show security-group attributes object
  
  name string
  
  Security Group name
  
  Minimum length is 1, maximum length is 255.
  
  visibility string
  
  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.
  
  Values are private or public.
  
  network string
  
  CIDR-formatted network allowed
  
  flow-direction string
  
  Network flow direction to match
  
  Values are ingress or egress.
elastic-ips array[object] | null

Instances Elastic IPs

Elastic IP
Hide elastic-ips attributes Show elastic-ips attributes object
- description string
  
  Elastic IP description
  
  Maximum length is 255.
- healthcheck object
  
  Elastic IP address healthcheck
  Hide healthcheck attributes Show healthcheck attributes object
  
  strikes-ok integer(int64)
  
  Number of attempts before considering the target healthy (default: 2)
  
  Minimum value is 1, maximum value is 20.
  
  tls-skip-verify boolean
  
  Skip TLS verification
  
  tls-sni string
  
  An optional domain or subdomain to check TLS against
  
  Minimum length is 1, maximum length is 255.
  
  strikes-fail integer(int64)
  
  Number of attempts before considering the target unhealthy (default: 3)
  
  Minimum value is 1, maximum value is 20.
  
  mode string Required
  
  Health check mode
  
  Values are tcp, http, or https.
  
  port integer(int64) Required
  
  Health check port
  
  Minimum value is 1, maximum value is 65535.
  
  uri string
  
  An endpoint to use for the health check, for example '/status'
  
  Minimum length is 1, maximum length is 255.
  
  interval integer(int64)
  
  Interval between the checks in seconds (default: 10)
  
  Minimum value is 5, maximum value is 300.
  
  timeout integer(int64)
  
  Health check timeout value in seconds (default: 2)
  
  Minimum value is 2, maximum value is 60.
- labels object
  Hide labels attribute Show labels attribute object
  
  * string Additional properties
name string

Instance Pool name

Minimum length is 1, maximum length is 255.
instance-type object

Compute instance type
min-available integer(int64) | null

Minimum number of running Instances

Minimum value is 0.
private-networks array[object] | null

Instance Pool Private Networks

Private Network
Hide private-networks attributes Show private-networks attributes object
- description string
  
  Private Network description
  
  Maximum length is 255.
- labels object
  Hide labels attribute Show labels attribute object
  
  * string Additional properties
- name string
  
  Private Network name
  
  Minimum length is 1, maximum length is 255.
- start-ip string(ipv4)
  
  Private Network start IP address
- vni integer(int64)
  
  Private Network VXLAN ID
  
  Minimum value is 0.
- netmask string(ipv4)
  
  Private Network netmask
- options object
  
  Private Network DHCP Options
  Hide options attributes Show options attributes object
  
  routers array[string(ipv4)]
  
  Routers
  
  dns-servers array[string(ipv4)]
  
  DNS Servers
  
  ntp-servers array[string(ipv4)]
  
  NTP Servers
  
  domain-search array[string]
  
  Domain search list, limited to 255 octets
- end-ip string(ipv4)
  
  Private Network end IP address
template object

Instance template
Hide template attributes Show template attributes object
- description string
  
  Template description
  
  Maximum length is 255.
- ssh-key-enabled boolean
  
  Enable SSH key-based login
- 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
- checksum string
  
  Template MD5 checksum
- boot-mode string
  
  Boot mode (default: legacy)
  
  Values are legacy or uefi.
- 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
ssh-key object

SSH key
Hide ssh-key attribute Show ssh-key attribute object
- name string
  
  SSH key name
  
  Minimum length is 1, maximum length is 255.
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

Deploy target
Hide deploy-target attributes Show deploy-target attributes object
- id string(uuid) Required
  
  Deploy Target ID
- name string
  
  Deploy Target name
  
  Minimum length is 1, maximum length is 255.
- type string
  
  Deploy Target type
  
  Values are edge or dedicated.
- description string
  
  Deploy Target description
  
  Maximum length is 255.
ipv6-enabled boolean

Enable IPv6. DEPRECATED: use public-ip-assignments.
disk-size integer(int64)

Instances disk size in GiB

Minimum value is 10, maximum value is 51200.
ssh-keys array[object] | null

Instances SSH keys

SSH key
Hide ssh-keys attribute Show ssh-keys attribute object
- name string
  
  SSH key name
  
  Minimum length is 1, maximum length is 255.

Responses

200 application/json

200
Hide response attributes Show response attributes object
- id string(uuid)
  
  Operation ID
- reason string
  
  Operation failure reason
  
  Values are incorrect, unknown, unavailable, forbidden, busy, fault, partial, not-found, interrupted, unsupported, or conflict.
- reference object
  
  Related resource reference
  
  Hide reference attributes Show reference attributes object
  
  id string(uuid)
  
  Reference ID
  
  link string
  
  Link to the referenced resource
  
  command string
  
  Command name
- message string
  
  Operation message
- state string
  
  Operation status
  
  Values are failure, pending, success, or timeout.

PUT /instance-pool/{id}

curl \
 --request PUT 'https://api-ch-gva-2.exoscale.com/v2/instance-pool/{id}' \
 --header "Content-Type: application/json" \
 --data '{"anti-affinity-groups":[{"name":"string","description":"string"}],"description":"string","public-ip-assignment":"inet4","labels":{"additionalProperty1":"string","additionalProperty2":"string"},"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":{"additionalProperty1":"string","additionalProperty2":"string"}}],"name":"string","instance-type":{},"min-available":42,"private-networks":[{"description":"string","labels":{"additionalProperty1":"string","additionalProperty2":"string"},"name":"string","start-ip":"string","vni":42,"netmask":"string","options":{"routers":["string"],"dns-servers":["string"],"ntp-servers":["string"],"domain-search":["string"]},"end-ip":"string"}],"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 examples

{
  "anti-affinity-groups": [
    {
      "name": "string",
      "description": "string"
    }
  ],
  "description": "string",
  "public-ip-assignment": "inet4",
  "labels": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "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": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      }
    }
  ],
  "name": "string",
  "instance-type": {},
  "min-available": 42,
  "private-networks": [
    {
      "description": "string",
      "labels": {
        "additionalProperty1": "string",
        "additionalProperty2": "string"
      },
      "name": "string",
      "start-ip": "string",
      "vni": 42,
      "netmask": "string",
      "options": {
        "routers": [
          "string"
        ],
        "dns-servers": [
          "string"
        ],
        "ntp-servers": [
          "string"
        ],
        "domain-search": [
          "string"
        ]
      },
      "end-ip": "string"
    }
  ],
  "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"
}