POST /instance-pool
application/json

Body Required

  • application-consistent-snapshot-enabled boolean

    Enable application consistent snapshots

  • anti-affinity-groups array[object]

    Instance Pool Anti-affinity Groups

    Anti-affinity group reference

    Hide anti-affinity-groups attribute Show anti-affinity-groups attribute object
    • id string(uuid)

      Anti-affinity group ID

  • description string

    Instance Pool description

    Maximum length is 255.

  • public-ip-assignment string

    Determines public IP assignment of the Instances. Type none is final and can't be changed later on.

    Values are inet4, dual, or none.

  • labels object
    Hide labels attribute Show labels attribute object
    • * string Additional properties
  • security-groups array[object]

    Instance Pool Security Groups

    Security group reference

    Hide security-groups attribute Show security-groups attribute object
    • id string(uuid)

      Security group ID

  • elastic-ips array[object]

    Instances Elastic IPs

    Elastic IP reference

    Hide elastic-ips attribute Show elastic-ips attribute object
    • id string(uuid)

      Elastic IP ID

  • name string Required

    Instance Pool name

    Minimum length is 1, maximum length is 255.

  • instance-type object Required

    Instance type reference

    Hide instance-type attribute Show instance-type attribute object
    • id string(uuid)

      Instance type ID

  • min-available integer(int64)

    Minimum number of running Instances

    Minimum value is 0.

  • private-networks array[object]

    Instance Pool Private Networks

    Private network reference

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

      Private network ID

  • template object Required

    Template reference

    Hide template attribute Show template attribute object
    • id string(uuid)

      Template ID

  • size integer(int64) Required

    Number of Instances

    Minimum value is 0.

  • ssh-key object

    SSH key reference

    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

    Prefix to apply to Instances names (default: pool)

    Minimum length is 1, maximum length is 30.

  • user-data string

    Instances Cloud-init user-data

    Minimum length is 1, maximum length is 32768.

  • deploy-target object

    Deploy target reference

    Hide deploy-target attribute Show deploy-target attribute object
    • id string(uuid)

      Deploy target ID

  • ipv6-enabled boolean

    Enable IPv6. DEPRECATED: use public-ip-assignments.

  • disk-size integer(int64) Required

    Instances disk size in GiB

    Minimum value is 10, maximum value is 51200.

  • ssh-keys array[object]

    Instances SSH Keys

    SSH key reference

    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.
POST /instance-pool 
curl \
 --request POST 'https://api-ch-gva-2.exoscale.com/v2/instance-pool' \
 --header "Content-Type: application/json" \
 --data '{"application-consistent-snapshot-enabled":true,"anti-affinity-groups":[{"id":"string"}],"description":"string","public-ip-assignment":"inet4","labels":{"additionalProperty1":"string","additionalProperty2":"string"},"security-groups":[{"id":"string"}],"elastic-ips":[{"id":"string"}],"name":"string","instance-type":{"id":"string"},"min-available":42,"private-networks":[{"id":"string"}],"template":{"id":"string"},"size":42,"ssh-key":{"name":"string"},"instance-prefix":"string","user-data":"string","deploy-target":{"id":"string"},"ipv6-enabled":true,"disk-size":42,"ssh-keys":[{"name":"string"}]}'
Request examples 
{
  "application-consistent-snapshot-enabled": true,
  "anti-affinity-groups": [
    {
      "id": "string"
    }
  ],
  "description": "string",
  "public-ip-assignment": "inet4",
  "labels": {
    "additionalProperty1": "string",
    "additionalProperty2": "string"
  },
  "security-groups": [
    {
      "id": "string"
    }
  ],
  "elastic-ips": [
    {
      "id": "string"
    }
  ],
  "name": "string",
  "instance-type": {
    "id": "string"
  },
  "min-available": 42,
  "private-networks": [
    {
      "id": "string"
    }
  ],
  "template": {
    "id": "string"
  },
  "size": 42,
  "ssh-key": {
    "name": "string"
  },
  "instance-prefix": "string",
  "user-data": "string",
  "deploy-target": {
    "id": "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"
}