Endpoint

/v1/network/static-ip-allocation

GET

Returns total/used/available numbers of IPs based on the current network configuration. Returns status code 400 if the server is in DHCP mode unless the try/floating query parameters are provided.

Parameters

Name Description Required
netmask Netmask to apply to the try and/or floating range arguments, overriding whatever is currently configured. Required if network is currently in DHCP mode. No
try Comma-separated static IP range(s) to try. Defaults to currently configured static IP range. No
floating Comma-separated floating IP range(s) to try. Defaults to currently configured floating IP range. No

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_static_ip_allocation_summary",
  "type": "object",
  "properties": {
    "total_ips": {
      "description": "Total number of IP addresses in the given IP ranges",
      "type": "number"
    },
    "used_ips": {
      "description": "Number of IP addresses currently assigned to nodes",
      "type": "number"
    },
    "available_ips": {
      "description": "Number of IP addresses available; can be negative",
      "type": "number"
    },
    "total_floating_ips": {
      "description": "Total floating ips",
      "type": "number"
    },
    "surplus_floating_ips": {
      "description": "Floating ip count too small or large",
      "type": "number"
    }
  }
}