Skip to main content
GET
List IP pools
Requires the IAM action email:ListIPPools. See EMAIL permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Query Parameters

name
string

Exact immutable account-scoped name, combined with all other filters.

crn
string

Exact CRN filter. Malformed CRNs return 400; foreign or mismatched CRNs return an empty page.

marker
string
limit
integer
default:50
Required range: 1 <= x <= 200

Response

Paginated IP-pool list.

ip_pools
object[]
required
meta
object
required