Attach a Compute instance to a Security Group

PUT /security-group/{id}:attach

Path parameters

id string(uuid) Required

application/json

Body Required

instance object Required

Instance
Hide instance attributes Show instance attributes object
- application-consistent-snapshot-enabled boolean
  
  Indicates if the instance will take application-consistent snapshots
- anti-affinity-groups array[object]
  
  Instance 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
- public-ip-assignment string
  
  Values are inet4, dual, or none.
- labels object
  Hide labels attribute Show labels attribute object
  
  * string Additional properties
- security-groups array[object]
  
  Instance Security Groups
  
  Security group reference
  Hide security-groups attribute Show security-groups attribute object
  
  id string(uuid)
  
  Security group ID
- elastic-ips array[object]
  
  Instance Elastic IPs
  
  Elastic IP reference
  Hide elastic-ips attribute Show elastic-ips attribute object
  
  id string(uuid)
  
  Elastic IP ID
- name string
  
  Instance name
  
  Minimum length is 1, maximum length is 255.
- instance-type object
  
  Compute instance type
- private-networks array[object]
  
  Instance Private Networks
  
  Private Network
  Hide private-networks attributes Show private-networks attributes object
  
  id string(uuid)
  
  Private Network ID
  
  mac-address string
  
  Private Network MAC address
- template object
  
  Instance template
  Hide template attributes Show template attributes object
  
  application-consistent-snapshot-enabled boolean
  
  Template with Qemu Guest Agent installed for application consistent snapshot
  
  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, at-vie-2, or hr-zag-1.
  
  url string
  
  Template source URL
- state string
  
  Values are expunging, starting, destroying, running, stopping, stopped, migrating, error, or destroyed.
- secureboot-enabled boolean
  
  Indicates if the instance has secure boot enabled
- 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.
- user-data string
  
  Instance Cloud-init user-data (base64 encoded)
  
  Minimum length is 1.
- manager object
  
  Resource manager
  Hide manager attributes Show manager attributes object
  
  id string(uuid)
  
  Manager ID
  
  type string
  
  Manager type
  
  Values are sks-nodepool or instance-pool.
- tpm-enabled boolean
  
  Indicates if the instance has tpm enabled
- deploy-target object
  
  Deploy target reference
  Hide deploy-target attribute Show deploy-target attribute object
  
  id string(uuid)
  
  Deploy target ID
- snapshots array[object]
  
  Instance Snapshots
  
  Snapshot reference
  Hide snapshots attribute Show snapshots attribute object
  
  id string(uuid)
  
  Snapshot ID
- disk-size integer(int64)
  
  Instance disk size in GiB
  
  Minimum value is 10, maximum value is 51200.
- ssh-keys array[object]
  
  Instance 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 /security-group/{id}:attach

curl \
 --request PUT 'https://api-ch-gva-2.exoscale.com/v2/security-group/{id}:attach' \
 --header "Content-Type: application/json" \
 --data '{"instance":{"application-consistent-snapshot-enabled":true,"anti-affinity-groups":[{"id":"string"}],"public-ip-assignment":"inet4","labels":{"additionalProperty1":"string","additionalProperty2":"string"},"security-groups":[{"id":"string"}],"elastic-ips":[{"id":"string"}],"name":"string","instance-type":{},"private-networks":[{"id":"string","mac-address":"string"}],"template":{"application-consistent-snapshot-enabled":true,"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"},"state":"expunging","secureboot-enabled":true,"ssh-key":{"name":"string"},"user-data":"string","manager":{"id":"string","type":"sks-nodepool"},"tpm-enabled":true,"deploy-target":{"id":"string"},"snapshots":[{"id":"string"}],"disk-size":42,"ssh-keys":[{"name":"string"}]}}'

Request examples

{
  "instance": {
    "application-consistent-snapshot-enabled": true,
    "anti-affinity-groups": [
      {
        "id": "string"
      }
    ],
    "public-ip-assignment": "inet4",
    "labels": {
      "additionalProperty1": "string",
      "additionalProperty2": "string"
    },
    "security-groups": [
      {
        "id": "string"
      }
    ],
    "elastic-ips": [
      {
        "id": "string"
      }
    ],
    "name": "string",
    "instance-type": {},
    "private-networks": [
      {
        "id": "string",
        "mac-address": "string"
      }
    ],
    "template": {
      "application-consistent-snapshot-enabled": true,
      "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"
    },
    "state": "expunging",
    "secureboot-enabled": true,
    "ssh-key": {
      "name": "string"
    },
    "user-data": "string",
    "manager": {
      "id": "string",
      "type": "sks-nodepool"
    },
    "tpm-enabled": true,
    "deploy-target": {
      "id": "string"
    },
    "snapshots": [
      {
        "id": "string"
      }
    ],
    "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"
}