Skip to content

Latest commit

 

History

History
257 lines (134 loc) · 6.97 KB

ElasticIpApi.md

File metadata and controls

257 lines (134 loc) · 6.97 KB

\ElasticIpApi

All URIs are relative to https://api-ch-gva-2.exoscale.com/v2

Method HTTP request Description
attach_instance_to_elastic_ip PUT /elastic-ip/{id}:attach Attach a Compute instance to an Elastic IP
create_elastic_ip POST /elastic-ip Create an Elastic IP
delete_elastic_ip DELETE /elastic-ip/{id} Delete an Elastic IP
detach_instance_from_elastic_ip PUT /elastic-ip/{id}:detach Detach a Compute instance from an Elastic IP
get_elastic_ip GET /elastic-ip/{id} Retrieve Elastic IP details
list_elastic_ips GET /elastic-ip List Elastic IPs
reset_elastic_ip_field DELETE /elastic-ip/{id}/{field} Reset an Elastic IP field to its default value
update_elastic_ip PUT /elastic-ip/{id} Update an Elastic IP

attach_instance_to_elastic_ip

models::Operation attach_instance_to_elastic_ip(id, attach_block_storage_volume_to_instance_request) Attach a Compute instance to an Elastic IP

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
attach_block_storage_volume_to_instance_request AttachBlockStorageVolumeToInstanceRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_elastic_ip

models::Operation create_elastic_ip(create_elastic_ip_request) Create an Elastic IP

Parameters

Name Type Description Required Notes
create_elastic_ip_request CreateElasticIpRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_elastic_ip

models::Operation delete_elastic_ip(id) Delete an Elastic IP

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

detach_instance_from_elastic_ip

models::Operation detach_instance_from_elastic_ip(id, attach_block_storage_volume_to_instance_request) Detach a Compute instance from an Elastic IP

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
attach_block_storage_volume_to_instance_request AttachBlockStorageVolumeToInstanceRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_elastic_ip

models::ElasticIp get_elastic_ip(id) Retrieve Elastic IP details

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]

Return type

models::ElasticIp

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_elastic_ips

models::ListElasticIps200Response list_elastic_ips() List Elastic IPs

Parameters

This endpoint does not need any parameter.

Return type

models::ListElasticIps200Response

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reset_elastic_ip_field

models::Operation reset_elastic_ip_field(id, field) Reset an Elastic IP field to its default value

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
field String [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_elastic_ip

models::Operation update_elastic_ip(id, update_elastic_ip_request) Update an Elastic IP

Parameters

Name Type Description Required Notes
id uuid::Uuid [required]
update_elastic_ip_request UpdateElasticIpRequest [required]

Return type

models::Operation

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]