Floating IPs

API Reference

GPU Droplets

Floating IPs

Create a New Floating IP

post/v2/floating_ips

Delete a Floating IP

delete/v2/floating_ips/{floating_ip}

List All Floating IPs

get/v2/floating_ips

Retrieve an Existing Floating IP

get/v2/floating_ips/{floating_ip}

ModelsExpand Collapse

FloatingIP = object { droplet, ip, locked, 2 more }

droplet: optional unknown or Droplet

The Droplet that the floating IP has been assigned to. When you query a floating IP, if it is assigned to a Droplet, the entire Droplet object will be returned. If it is not assigned, the value will be null.

Requires droplet:read scope.

Accepts one of the following:

Null = unknown

If the floating IP is not assigned to a Droplet, the value will be null.

Droplet

ip: optional string

The public IP address of the floating IP. It also serves as its identifier.

formatipv4

locked: optional boolean

A boolean value indicating whether or not the floating IP has pending actions preventing new ones from being submitted.

project_id: optional string

The UUID of the project to which the reserved IP currently belongs.

Requires project:read scope.

formatuuid

region: optional Region

The region that the floating IP is reserved to. When you query a floating IP, the entire region object will be returned.

Floating IPsActions

Initiate a Floating IP Action

post/v2/floating_ips/{floating_ip}/actions

List All Actions for a Floating IP

get/v2/floating_ips/{floating_ip}/actions

Retrieve an Existing Floating IP Action

get/v2/floating_ips/{floating_ip}/actions/{action_id}