REST endpoints: Floating IPs

These endpoints mirror the CLI commands described in Floating IPs, Pairing floating IPs for replication. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.

Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.

POST /floatingips/create

Create a floating IP.

CLI command: floatingips create

Body fields (JSON)

Name	Type	Required	Description
Name	string	Yes	The name for the new floating IP.
Address	string	Yes	The IP address of the floating IP.
Mask	string	Yes	The subnet mask of the floating IP.
Gateway	string	No	The gateway of the floating IP.
Nodes	array of string	Yes	The nodes to host the floating IP on, paired positionally with Interfaces.
Interfaces	array of string	Yes	The network interface on each corresponding node, paired positionally with Nodes.

DELETE /floatingips/delete

Delete a floating IP.

CLI command: floatingips delete

Query parameters

Name	Type	Required	Description
name	string	Yes	The floating IP to delete.
force	boolean	No	Skip the confirmation prompt.

PUT /floatingips/edit

Edit a floating IP.

CLI command: floatingips edit

Query parameters

Name	Type	Required	Description
name	string	Yes	The name of the floating IP to edit.

Body fields (JSON)

Name	Type	Required	Description
Name	string	Yes	The name of the floating IP to edit.
Address	string	No	The new IP address for the floating IP.
Mask	string	No	The new subnet mask for the floating IP.
Gateway	string	No	The new gateway for the floating IP.
Nodes	array of string	No	The nodes to host the floating IP on, paired positionally with Interfaces.
Interfaces	array of string	No	The network interface on each corresponding node, paired positionally with Nodes.

GET /floatingips/list

List floating IPs.

CLI command: floatingips list

Query parameters

Name	Type	Required	Description
name	string	No	Filter by floating IP name.
ip	string	No	Filter by IP address.

Response: a list of FloatingIpElement objects in Result, each with: Name (string), Address (string), Mask (string), Gateway (string), InactivePairedTarget (boolean), Usages (array of FloatingIpUsage), OwnerNode (string), Nodes (array of string), Interfaces (array of string), NodeInterfaces (array of NodeElement), PairedFloatingIps (array of PairedFloatingIpElement), VpnServerAddress (string), VpnServerPort (integer).

POST /floatingips/pair

Pair a local floating IP with a remote floating IP. Useful when replicating NAS/Object volumes.

CLI command: floatingips pair

Body fields (JSON)

Name	Type	Required	Description
Name	string	Yes	The local floating IP to pair.
TargetSystem	string	Yes	The remote system to pair with.
RemoteNodes	array of string	Yes	The remote nodes to bind the floating IP to, paired positionally with RemoteInterfaces.
RemoteInterfaces	array of string	Yes	The network interface on each corresponding remote node, paired positionally with RemoteNodes.

PUT /floatingips/transition

Activate a paired floating IP that is currently inactive (a stub), transitioning it to primary.

CLI command: floatingips transition

Body fields (JSON)

Name	Type	Required	Description
ActivateFloatingIp	string	Yes	The inactive (stub) floating IP to activate.

DELETE /floatingips/unpair

Unpair a local floating IP from a remote floating IP.

CLI command: floatingips unpair

Query parameters

Name	Type	Required	Description
name	string	Yes	The local floating IP to unpair.
targetSystem	string	Yes	The remote system to unpair from.
force	boolean	No	Skip the confirmation prompt.

---

See also: Requests and responses - Authentication - Examples