ip_pool_view

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

Path Parameters

pool

Name or ID of the IP pool

Responses

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.

is_default

When a pool is the default for a silo, floating IPs and instance ephemeral IPs will come from that pool when no other pool is specified.

A silo can have at most one default pool per combination of pool type (unicast or multicast) and IP version (IPv4 or IPv6), allowing up to 4 default pools total.

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