ip_pool_list

List IP pools
get/v1/system/ip-pools

Query Parameters

limit

Maximum number of items returned by a single call

page_token

Token returned by previous call to retrieve the subsequent page

sort_by

Supported set of sort modes for scanning by name or id

Responses

Object
items

list of items on this page of results

A collection of IP ranges. If a pool is linked to a silo, IP addresses from the pool can be allocated within that silo

Object
description

human-readable free-form text about a resource

id

unique, immutable, system-controlled identifier for each resource

ip_version

The IP version for the pool.

v4v6

The IP address version.

name

unique, mutable, user-controlled identifier for each resource

Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Names cannot be a UUID, but they may contain a UUID. They can be at most 63 characters long.

pool_type

Type of IP pool (unicast or multicast)

Type of IP pool.

time_created

timestamp when this resource was created

time_modified

timestamp when this resource was last modified

next_page

token used to fetch the next page of results (if any)