Elastic IP

Elastic IPs are additional public IPv4/6 addresses that can be attached to Compute instances, with optional healthcheck support.

create-elastic-ip

Create an Elastic IP

POST /elastic-ip

Request body

Content-Type: application/json

Property	Type	Required	Description
`addressfamily`	string	no	Elastic IP address family (default: :inet4) Allowed values: `inet4`, `inet6`.
`description`	string	no	Elastic IP description
`healthcheck`	object	no	Elastic IP address healthcheck schema details
`labels`	object	no	Resource labels

Example

{
  "addressfamily": "inet4",
  "description": "string",
  "healthcheck": {
    "interval": 0,
    "mode": "tcp",
    "port": 0,
    "strikes-fail": 0,
    "strikes-ok": 0,
    "timeout": 0,
    "tls-skip-verify": true,
    "tls-sni": "string",
    "uri": "string"
  },
  "labels": {}
}

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`	object	Related resource reference schema details
`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-elastic-ip: golang | Python | Java

CLI: exo api create-elastic-ip

get-elastic-ip

Retrieve Elastic IP details

GET /elastic-ip/{id}

Path parameters

Name	In	Description
`id`	`path`

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`addressfamily`	string	Elastic IP address family Allowed values: `inet4`, `inet6`.
`cidr`	string	Elastic IP cidr
`description`	string	Elastic IP description
`healthcheck`	object	Elastic IP address healthcheck schema details
`id`	string	Elastic IP ID
`ip`	string	Elastic IP address
`labels`	object	Resource labels

Example output

{
  "addressfamily": "inet4",
  "cidr": "string",
  "description": "string",
  "healthcheck": {
    "interval": 0,
    "mode": "tcp",
    "port": 0,
    "strikes-fail": 0,
    "strikes-ok": 0,
    "timeout": 0,
    "tls-skip-verify": true,
    "tls-sni": "string",
    "uri": "string"
  },
  "id": "string",
  "ip": "string",
  "labels": {}
}

SDK reference for get-elastic-ip: golang | Python | Java

CLI: exo api get-elastic-ip

update-elastic-ip

Update an Elastic IP

PUT /elastic-ip/{id}

Path parameters

Name	In	Description
`id`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`description`	string	no	Elastic IP description
`healthcheck`	object	no	Elastic IP address healthcheck schema details
`labels`	object	no	Resource labels

Example

{
  "description": "string",
  "healthcheck": {
    "interval": 0,
    "mode": "tcp",
    "port": 0,
    "strikes-fail": 0,
    "strikes-ok": 0,
    "timeout": 0,
    "tls-skip-verify": true,
    "tls-sni": "string",
    "uri": "string"
  },
  "labels": {}
}

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`	object	Related resource reference schema details
`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-elastic-ip: golang | Python | Java

CLI: exo api update-elastic-ip

delete-elastic-ip

Delete an Elastic IP

DELETE /elastic-ip/{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`	object	Related resource reference schema details
`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-elastic-ip: golang | Python | Java

CLI: exo api delete-elastic-ip

Other Operations

reset-elastic-ip-field

Reset an Elastic IP field to its default value

DELETE /elastic-ip/{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`	object	Related resource reference schema details
`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-elastic-ip-field: golang | Python | Java

CLI: exo api reset-elastic-ip-field

list-elastic-ips

List Elastic IPs

GET /elastic-ip

Responses

Status: 200 - 200

Content-Type: application/json

Property	Type	Description
`elastic-ips`	array[object]	schema details

Example output

{
  "elastic-ips": [
    {
      "addressfamily": "inet4",
      "cidr": "string",
      "description": "string",
      "healthcheck": {
        "interval": 0,
        "mode": "tcp",
        "port": 0,
        "strikes-fail": 0,
        "strikes-ok": 0,
        "timeout": 0,
        "tls-skip-verify": true,
        "tls-sni": "string",
        "uri": "string"
      },
      "id": "string",
      "ip": "string",
      "labels": {}
    }
  ]
}

SDK reference for list-elastic-ips: golang | Python | Java

CLI: exo api list-elastic-ips

detach-instance-from-elastic-ip

Detach a Compute instance from an Elastic IP

PUT /elastic-ip/{id}:detach

Path parameters

Name	In	Description
`id`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`instance`	object	yes	Target Instance schema details

Example

{
  "instance": {
    "id": "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`	object	Related resource reference schema details
`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 detach-instance-from-elastic-ip: golang | Python | Java

CLI: exo api detach-instance-from-elastic-ip

attach-instance-to-elastic-ip

Attach a Compute instance to an Elastic IP

PUT /elastic-ip/{id}:attach

Path parameters

Name	In	Description
`id`	`path`

Request body

Content-Type: application/json

Property	Type	Required	Description
`instance`	object	yes	Target Instance schema details

Example

{
  "instance": {
    "id": "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`	object	Related resource reference schema details
`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 attach-instance-to-elastic-ip: golang | Python | Java

CLI: exo api attach-instance-to-elastic-ip

Last updated on January 28, 2026