ip_pool_utilization_view

Fetch IP pool utilization
get/v1/system/ip-pools/{pool}/utilization

Path Parameters

pool

Responses

Object
ipv4

Number of allocated and total available IPv4 addresses in pool

Object
allocated

The number of IPv4 addresses allocated from this pool

capacity

The total number of IPv4 addresses in the pool, i.e., the sum of the lengths of the IPv4 ranges. Unlike IPv6 capacity, can be a 32-bit integer because there are only 2^32 IPv4 addresses.

ipv6

Number of allocated and total available IPv6 addresses in pool

Object
allocated

The number of IPv6 addresses allocated from this pool. A 128-bit integer string to match the capacity field.

capacity

The total number of IPv6 addresses in the pool, i.e., the sum of the lengths of the IPv6 ranges. An IPv6 range can contain up to 2^128 addresses, so we represent this value in JSON as a numeric string with a custom "uint128" format.