Reference
Exoscale API
Compute
Elastic IP

Elastic IP

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

Read more

create-elastic-ip

Create an Elastic IP

POST /elastic-ip

Request body

  • application/json
    • addressfamily (string): Elastic IP address family (default: :inet4)
    • description (string): Elastic IP description
    • healthcheck (object): Elastic IP address healthcheck - schema details
    • labels (object)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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

  • id in path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Elastic IP ID
      • ip (string): Elastic IP address
      • addressfamily (string): Elastic IP address family
      • cidr (string): Elastic IP cidr
      • description (string): Elastic IP description
      • healthcheck (object): Elastic IP address healthcheck - schema details
      • labels (object)

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

  • id in path (required)

Request body

  • application/json
    • description (string): Elastic IP description
    • healthcheck (object): Elastic IP address healthcheck - schema details
    • labels (object)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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

  • id in path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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

  • id in path (required)
  • field in path (required)

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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

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

  • id in path (required)

Request body

  • application/json

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

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

  • id in path (required)

Request body

  • application/json

Responses

  • 200: 200
    • application/json
      • id (string): Operation ID
      • reason (string): Operation failure reason
      • reference (object): Related resource reference - schema details
      • message (string): Operation message
      • state (string): Operation status

SDK reference for attach-instance-to-elastic-ip: golang | Python | Java

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

Last updated on