Floating IP API reference

See https://docs.openstack.org/api-ref/network/. For error handling guidance, see the API error reference.

In these methods, {floating_ip_id} is the ID of the floating IP, {port_id} is the ID of the instance port a floating IP associates with, and {server_id} is the ID of the instance. These endpoints list floating IPs, allocate a floating IP from an external network, associate and disassociate a floating IP, and release a floating IP.

Quake AI public networks#

Neutron floating IP endpoints#

List floating IPs#

GET /v2.0/floatingips

Show floating IP details#

GET /v2.0/floatingips/{floating_ip_id}

Allocate a floating IP#

POST /v2.0/floatingips

Request body

{
  "floatingip": {
    "floating_network_id": "PUBLIC_STATIC_NETWORK_ID"
  }
}

• floating_network_id is the ID of the PublicStatic external network. Retrieve it with GET /v2.0/networks?name=PublicStatic.

Response (201 Created)

{
  "floatingip": {
    "id": "d46257a1-c6d0-46ae-a146-dc36ad19a430",
    "floating_ip_address": "203.0.113.50",
    "floating_network_id": "PUBLIC_STATIC_NETWORK_ID",
    "status": "DOWN",
    "port_id": null
  }
}

Associate a floating IP with a port#

PUT /v2.0/floatingips/{floating_ip_id}

Request body

{
  "floatingip": {
    "port_id": "PORT_ID"
  }
}

• port_id is the ID of the instance port that receives the floating IP. Neutron returns 200 OK with the resolved fixed_ip_address.

Disassociate a floating IP from a port#

PUT /v2.0/floatingips/{floating_ip_id}

Request body

{
  "floatingip": {
    "port_id": null
  }
}

Release a floating IP#

DELETE /v2.0/floatingips/{floating_ip_id}

• Neutron returns 204 No Content.

Legacy Nova os-floating-ips endpoints (deprecated)#

List floating IPs (legacy)#

GET /os-floating-ips

Show floating IP details (legacy)#

GET /os-floating-ips/{floating_ip_id}

Allocate a floating IP (legacy)#

POST /os-floating-ips

Request body

{
  "pool": "PublicStatic"
}

• pool is the name of the external network to allocate from, either PublicStatic or PublicEphemeral. The pool name must match the external network name; the literal string public returns 404 Floating IP pool not found.

Associate a floating IP with an instance#

POST /servers/{server_id}/action

Request body

{
  "addFloatingIp": {
    "address": "FLOATING_IP_ADDRESS"
  }
}

• address is the floating IP address to associate. This action returns 404 on microversion 2.44 or later; use the Neutron PUT /v2.0/floatingips/{floating_ip_id} associate call with a port_id instead.

Disassociate a floating IP from an instance#

POST /servers/{server_id}/action

Request body

{
  "removeFloatingIp": {
    "address": "FLOATING_IP_ADDRESS"
  }
}

• This action returns 404 on microversion 2.44 or later; use the Neutron PUT /v2.0/floatingips/{floating_ip_id} disassociate call with port_id set to null instead.

Release a floating IP (legacy)#

DELETE /os-floating-ips/{floating_ip_id}