Floating IPs

Contents

Floating IPs

Allow the user to manage floating IPs.

List floating IPs

GET /v3/network/floating_ips

Lists all floating IPs.

Inputs

Field Type Description Required
server_id String Id of a server to return only the floating IPs that are attached with that server   No

Returns

An array of floating IPs of the following format:

Field Type Description
id String Identifier of the floating IP.
name String Name of the floating IP.
address String The IP address of the public IP.
state String State of the floating IP.
cloud_account_id String Identifier of the cloud account of the floating IP.
realm_id String Identifier of the realm in which the floating IP is.
attached_server_id String Identifier of the server which the floating IP is attached. Nil If floating IP is not attached.
brownfield Boolean Flag indicating if the floating IP is brownfield (imported).
resource_type String An identifier for the type of resource, specifically "floating_ip".
label_ids Array of Strings List of ids corresponding to the labels the floating IP has assigned.

Back to top

Show floating IP

GET /v3/network/floating_ips/:id

Shows information about a specific floating IP.

Inputs

None

Returns

a floating IP of the following format:

Field Type Description
id String Identifier of the floating IP.
name String Name of the floating IP.
address String The IP address of the public IP.
state String State of the floating IP.
cloud_account_id String Identifier of the cloud account of the floating IP.
realm_id String Identifier of the realm in which the floating IP is.
attached_server_id String Identifier of the server which the floating IP is attached. Nil If floating IP is not attached.
resource_type String An identifier for the type of resource, specifically "floating_ip".
label_ids Array of Strings List of ids corresponding to the labels the floating IP has assigned.
brownfield Boolean Flag indicating if the floating IP is brownfield (imported).

Back to top

Create floating IP

POST /v3/network/floating_ips

Creates a new floating IP.

Inputs

Field Type Description Required
name String Name of the floating IP Yes
cloud_account_id String Identifier of the cloud account of the floating IP. Yes
realm_id String Identifier of the realm in which the floating IP is. Yes
label_ids String List of ids corresponding to the labels the floating IP has assigned. Yes

Returns

a floating IP of the following format:

Field Type Description
id String Identifier of the floating IP.
name String Name of the floating IP.
address String The IP address of the public IP.
state String State of the floating IP.
cloud_account_id String Identifier of the cloud account of the floating IP.
realm_id String Identifier of the realm in which the floating IP is.
attached_server_id String Identifier of the server which the floating IP is attached. Nil If floating IP is not attached.
resource_type String An identifier for the type of resource, specifically "floating_ip".
label_ids Array of Strings List of ids corresponding to the labels the floating IP has assigned.
brownfield Boolean Flag indicating if the floating IP is brownfield (imported).

Back to top

Update floating IP

PUT /v3/network/floating_ips/:id

Updates an existing floating IP.

Inputs

Field Type Description Required
name String The new name of the floating IP. No

Returns

a floating IP of the following format:

Field Type Description
id String Identifier of the floating IP.
name String Name of the floating IP.
address String The IP address of the public IP.
state String State of the floating IP.
cloud_account_id String Identifier of the cloud account of the floating IP.
realm_id String Identifier of the realm in which the floating IP is.
attached_server_id String Identifier of the server which the floating IP is attached. Nil If floating IP is not attached.
resource_type String An identifier for the type of resource, specifically "floating_ip".
label_ids Array of Strings List of ids corresponding to the labels the floating IP has assigned.
brownfield Boolean Flag indicating if the floating IP is brownfield (imported).

Back to top

Destroy floating IP

DELETE /v3/network/floating_ips/:id

Deletes a floating IP.

Inputs

None

Returns

the deleted floating IP with the following format:

Field Type Description
id String Identifier of the floating IP.
name String Name of the floating IP.
address String The IP address of the public IP.
state String state of the floating IP.
cloud_account_id String Identifier of the cloud account of the floating IP.
realm_id String Identifier of the realm in which the floating IP is.
attached_server_id String Identifier of the server which the floating IP is attached. Nil If floating IP is not attached.
resource_type String An identifier for the type of resource, specifically "floating_ip".
label_ids Array of Strings List of ids corresponding to the labels the floating IP has assigned.
brownfield Boolean Flag indicating if the floating IP is brownfield (imported).

Back to top

Discard floating IP

DELETE /v3/network/floating_ips/:id/discard

Discards a floating IP from IMCO but does not delete it from the cloud provider.

Inputs

None

Returns

the discarded floating IP with the following format:

Field Type Description
id String Identifier of the floating IP.
name String Name of the floating IP.
address String The IP address of the public IP.
state String state of the floating IP.
cloud_account_id String Identifier of the cloud account of the floating IP.
realm_id String Identifier of the realm in which the floating IP is.
attached_server_id String Identifier of the server which the floating IP is attached. Nil If floating IP is not attached.
resource_type String An identifier for the type of resource, specifically "floating_ip".
label_ids Array of Strings List of ids corresponding to the labels the floating IP has assigned.
brownfield Boolean Flag indicating if the floating IP is brownfield (imported).

Back to top

Attach floating IP to server

POST /v3/network/floating_ips/:floating_ip_id/attached_server

Attaches a floating IP to a server

Inputs

Field Type Description Required
attached_server_id String Identifier of the server where the floating IP will be attached. Yes

Returns

a floating IP of the following format:

Field Type Description
id String Identifier of the floating IP.
name String Name of the floating IP.
address String The IP address of the public IP.
state String State of the floating IP.
cloud_account_id String Identifier of the cloud account of the floating IP.
realm_id String Identifier of the realm in which the floating IP is.
attached_server_id String Identifier of the server which the floating IP is attached. Nil If floating IP is not attached.
resource_type String An identifier for the type of resource, specifically "floating_ip".
label_ids Array of Strings List of ids corresponding to the labels the floating IP has assigned.
brownfield Boolean Flag indicating if the floating IP is brownfield (imported).

Back to top

Detach floating IP from server

DELETE /v3/network/floating_ips/:floating_ip_id/attached_server

Detaches a floating IP from a server

Inputs

None

Returns

a floating IP of the following format:

Field Type Description
id String Identifier of the floating IP.
name String Name of the floating IP.
address String The IP address of the public IP.
state String State of the floating IP.
cloud_account_id String Identifier of the cloud account of the floating IP.
realm_id String Identifier of the realm in which the floating IP is.
attached_server_id String Identifier of the server which the floating IP is attached. Nil If floating IP is not attached.
resource_type String An Identifier for the type of resource, specifically "floating_ip".
label_ids Array of Strings List of ids corresponding to the labels the floating IP has assigned.
brownfield Boolean Flag indicating if the floating IP is brownfield (imported).

Back to top