FloatingIpsResource


Create a floating ip in a location


Reserve/create an IP in the location's provider. The provider must support the creation of floating IPs.

The IP will be free and available to all the location's virtual datacenters.

POST https://example.com/api/cloud/locations/{location}/ips

Roles : [ROLE_MANAGE_FLOATINGIPS]

Accept : publicip

Error Codes

  • ENTERPRISE-10 - The enterprise does not have permission to use the requested datacenter
  • FLOATINGIP-3 - Cannot create a floating IP in the given location
  • GEN-5 - Invalid credentials
  • LOCATION-4 - The location does not exist
  • PUBLIC-10 - The enterprise does not have credentials for this provider

Example

Create a floating ip in a location and attach to a virtual datacenter


Reserve/create an IP in the location's provider. The provider must support the creation of floating IPs.

Assign the created floating IP to the virtual datacenter provided as a link in the request body.

POST https://example.com/api/cloud/locations/{location}/ips

Roles : [ROLE_MANAGE_FLOATINGIPS]

Content-Type : links Accept : publicip

Error Codes

  • LOCATION-5 - The given virtual datacenter is not compatible with the given location
  • VDC-0 - The requested virtual datacenter does not exist
  • VDC-9 - The provided virtual datacenter link is invalid

Example

List floating ips in a location


Returns the list of IPs reserved in the location. These IPs may be already assigned to virtual datacenters or attached to VMs. This resource can also synchronize the provider's floating IPs with the platform, ie. adding already created and deleting nonexistent floating IPs. The synchronization process will ignore IPs that are attached to VMs.

GET https://example.com/api/cloud/locations/{location}/ips

Roles : [ROLE_MANAGE_FLOATINGIPS]

Parameter Type Default Value Description
startwith Integer 0 The first element to be retrieved of the filtered search
by String ip Order by
has String If present filter to apply in the search.
ip String If present, filter by the provided IP literal
limit Integer 25 The number of entities to retrieve
asc Boolean true If the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)
all Boolean false If true, also returns the unavailable floating IPs
source String LOCAL Use ''REMOTE'' to force syncrhonization with the provider

Accept : publicips

Error Codes

  • ENTERPRISE-10 - The enterprise does not have permission to use the requested datacenter
  • LOCATION-4 - The location does not exist

Example

Delete a floating ip from a location


Remove an IP from Abiquo and the provider.

Detach the IP from the VM before performing this action.

DELETE https://example.com/api/cloud/locations/{location}/ips/{ip}

Roles : [ROLE_MANAGE_FLOATINGIPS]

Parameter Type Default Value Description
force boolean false If true, logical delete is performed

Example

Get a floating ip in a location


Returns a floating IP available to an enterprise in a location

GET https://example.com/api/cloud/locations/{location}/ips/{ip}

Roles : [ROLE_MANAGE_FLOATINGIPS]

Accept : publicip

Error Codes

  • FLOATINGIP-1 - The floating IP does not exist

Example