List Floating IPs

GET/v2.0/floatingips

Lists floating IPs.

info

Source: list-floating-ips

Request

Parameters

idstring

Filter the list result by the ID of the resource.

router_idstring

Filter the floating IP list result by the ID of the router for the floating IP.

statusstring

Filter the floating IP list result by the status of the floating IP. Values are ACTIVE, DOWN and ERROR.

descriptionstring

Filter the list result by the human-readable description of the resource.

tenant_idstring

Filter the list result by the ID of the project that owns the resource.

revision_numberinteger

Filter the list result by the revision number of the resource.

project_idstring

Filter the list result by the ID of the project that owns the resource.

floating_network_idstring

Filter the floating IP list result by the ID of the network associated with the floating IP.

fixed_ip_addressstring

Filter the floating IP list result by the fixed IP address that is associated with the floating IP address.

floating_ip_addressstring

Filter the floating IP list result by the floating IP address.

port_idstring

Filter the floating IP list result by the ID of a port associated with the floating IP.

sort_dirstring

Sort direction. A valid value is asc (ascending) or desc (descending). You can specify multiple pairs of sort key and sort direction query parameters.

sort_keystring

Sorts by a floatingip attribute. You can specify multiple pairs of sort key and sort direction query parameters. The sort keys are limited to: fixed_ip_address, floating_ip_address, floating_network_id, id, router_id, status, tenant_id, project_id

tagsstring

A list of tags to filter the list result by. Resources that match all tags in this list will be returned. Tags in query must be separated by comma.

tags-anystring

A list of tags to filter the list result by. Resources that match any tag in this list will be returned. Tags in query must be separated by comma.

not-tagsstring

A list of tags to filter the list result by. Resources that match all tags in this list will be excluded. Tags in query must be separated by comma.

not-tags-anystring

A list of tags to filter the list result by. Resources that match any tag in this list will be excluded. Tags in query must be separated by comma.

fieldsstring

The fields that you want the server to return. If no fields query parameter is specified, the networking API returns all attributes allowed by the policy settings. By using the fields parameter, the API returns only the requested set of attributes. The fields parameter can be specified multiple times. For example, if you specify fields=id&fields=name in the request URL, only the id and name attributes will be returned.

Sample Request

cURL

curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://api.vietnix.cloud:9696/v2.0/floatingips

HTTP

GET https://api.vietnix.cloud:9696/v2.0/floatingips

Response

Response Parameters

floatingipsarrayrequired

A list of floatingip objects.

idstringrequired

The ID of the floating IP address.

router_idstringrequired

The ID of the router for the floating IP.

statusstringrequired

The status of the floating IP. Values are ACTIVE, DOWN and ERROR.

descriptionstringrequired

A human-readable description for the resource.

dns_domainstringrequired

A valid DNS domain.

dns_namestringrequired

A valid DNS name.

port_detailsstringrequired

The information of the port that this floating IP associates with. In particular, if the floating IP is associated with a port, this field contains some attributes of the associated port, including name, network_id, mac_address, admin_state_up, status, device_id and device_owner. If the floating IP is not associated with a port, this field is null.

tenant_idstringrequired

The ID of the project.

created_atstringrequired

The date and time when the resource was created. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm±hh. For example, 2015-08-27T09:49:58-05:00. The ±hh value, if included, is the time zone as an offset from UTC. In this example, the offset value is -05:00.

updated_atstringrequired

The date and time when the resource was updated. If the resource has not been updated, this field will be null. The date and time stamp format is ISO 8601: CCYY-MM-DDThh:mm±hh. For example, 2015-08-27T09:49:58-05:00. The ±hh value, if included, is the time zone as an offset from UTC. In this example, the offset value is -05:00.

revision_numberintegerrequired

The revision number of the resource.

project_idstringrequired

The ID of the project.

floating_network_idstringrequired

The ID of the network associated with the floating IP.

fixed_ip_addressstringrequired

The fixed IP address that is associated with the floating IP address.

floating_ip_addressstringrequired

The floating IP address.

port_idstringrequired

The ID of a port associated with the floating IP.

tagsarrayrequired

The list of tags on the resource.

port_forwardingsarrayrequired

The associated port forwarding resources for the floating IP. If the floating IP has multiple port forwarding resources, this field has multiple entries. Each entry consists of network IP protocol (protocol), the fixed IP address of internal neutron port (internal_ip_address), the TCP or UDP port used by internal neutron port (internal_port) and the TCP or UDP port used by floating IP (external_port).

Sample Response

Response body

{
    "floatingips": [
        {
            "id": "15adb7f5-05ce-4ec0-a146-b4921dcc5b4c",
            "tenant_id": "f33507157a634f1cac71e06a70fb558e",
            "floating_ip_address": "45.115.16.163",
            "floating_network_id": "79cab11a-122d-43a7-9427-3575d9512413",
            "router_id": "2740d75c-9a36-48fe-b660-16d47c2d0b29",
            "port_id": "92f0c431-a2d6-4d74-94c4-74136353759b",
            "fixed_ip_address": "192.168.0.131",
            "status": "DOWN",
            "description": "",
            "qos_policy_id": null,
            "port_details": {
                "name": "kub02-og2n27k6f2kz-kube_masters-6vvzptxbvy5x-0-c7l5byvrp3xu-kube_master_eth0-wmsgxbcjat4h-0-qthrc3kaycd6",
                "network_id": "87aa2b20-580c-420c-9ca0-15f20144024b",
                "mac_address": "fa:16:3e:4f:0f:d9",
                "admin_state_up": true,
                "status": "ACTIVE",
                "device_id": "3503c7d0-d59b-4996-9fd8-7ca5b479351f",
                "device_owner": "compute:nova"
            },
            "tags": [],
            "created_at": "2025-09-25T01:33:46Z",
            "updated_at": "2025-09-25T01:33:54Z",
            "revision_number": 6,
            "project_id": "f33507157a634f1cac71e06a70fb558e"
        }
    ]
}

Status Code

Success

Status Code	Description
200 - OK	Request was successful.

Error

Status Code	Description
401 - Unauthorized	User must authenticate before making a request.