v12

latestOpenAPI 3.0.3raw.githubusercontent.com2026-06-1811583196.1 KB
Networking

List floating IPs

List the account's floating (public) IP addresses, including reserved IPs and IPs currently attached to VMs. Filter to just reserved IPs with ?reserved=true.

get/api/v1/ips

Query parameters

reservedboolean

When true, return only reserved IPs (not currently attached to a VM).

status'free' | 'in-use'

Filter by IP status:

  • free — IP is in the pool. Combined with reserved=true it means held for the account but not attached to a VM.
  • in-use — currently attached to a VM.
limitinteger
offsetinteger

Headers

X-Project-IDstring uuid required

Project ID. Required for all mutating operations (create, delete, power actions, resize).

Response

List of floating IPs

successboolean
totalinteger

Example response

{
  "data": [
    {
      "ip_address": "203.0.113.42"
    }
  ]
}