Version 2.4.7.20261116085428 · latest

IP pools ip-pools

IP pools and the IPs inside them, maintained by admins. A pool belongs to a region and its name is unique platform-wide.

Pick an endpoint to see its example call on the right.

IP product lineAuthentication: Admin only12 endpoints

Authentication

Send the X-API-Key header (create a key on the API Keys page; the key is shown only once at creation). An Authorization: Bearer token obtained by logging in also works.

X-API-Key

Authentication failures return 401; forbidden returns 403 (code such as insufficient_scope).

Conventions

Paging uses page (from 1) and page_size; sort with sort=field or sort=-field.

Times are RFC 3339 (UTC); amounts are in cents.

Writes return 200/201/204 on success; duplicates of a unique key return 409.

GET/api/v2/ip-poolsList IP pools

Authentication: Admin only

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
sortstring Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
region_idinteger Filter by region.
POST/api/v2/ip-poolsCreate IP pool

Authentication: Admin only

Request body application/json

FieldTypeDescription
desstring Description
nameRequiredstring Name
region_idRequiredinteger Region ID
GET/api/v2/ip-pools/candidatesIP pool candidate node IPs

Authentication: Admin only

Query parameters

FieldTypeDescription
region_idRequiredinteger Region ID.
GET/api/v2/ip-pools/{id}Get IP pool

Authentication: Admin only

PUT/api/v2/ip-pools/{id}Update IP pool

Authentication: Admin only

Request body application/json

FieldTypeDescription
desstring Description
nameRequiredstring Name
region_idRequiredinteger Region ID
DELETE/api/v2/ip-pools/{id}Delete IP pool

Authentication: Admin only

GET/api/v2/ip-pools/{id}/refsIP pool referencing sites

Authentication: Admin only

Query parameters

FieldTypeDescription
ip_idinteger Show only this pool IP.
limitinteger Maximum number of sites listed per IP.
Default 20
GET/api/v2/ip-pools/{pool_id}/ipsList IPs in pool

Authentication: Admin only

Query parameters

FieldTypeDescription
pageinteger Page number, starting from 1
Default 1
page_sizeinteger Items per page
Default 20
sortstring Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
POST/api/v2/ip-pools/{pool_id}/ipsAdd IP to pool

Authentication: Admin only

Request body application/json

FieldTypeDescription
bind_addrstring The local address the node actually listens on (NAT setups); null means use ip.
node_idRequiredinteger Node ID
PUT/api/v2/ip-pools/{pool_id}/ips/{id}Update pool IP

Authentication: Admin only

Request body application/json

FieldTypeDescription
bind_addrstring The local address the node actually listens on (NAT setups); null means use ip.
enabledboolean Whether enabled
POST/api/v2/ip-pools/{pool_id}/ips/{id}/issue-certIssue platform certificate for pool IP

Authentication: Admin only

Request body application/json

FieldTypeDescription
confirmboolean Confirm re-issuing when a valid certificate already exists.

IP pools object

FieldTypeDescription
bind_addrstring The local address the node actually listens on (NAT setups); null means use ip.
certIpCertState Platform IP certificate status.
confirmboolean Confirm re-issuing when a valid certificate already exists.
created_atstring Created at
read-only
desstring Description
enabledboolean Whether enabled
hintsstring[] Hints (e.g. the node reported no NIC addresses, so the pool entry was not verified).
read-only
idinteger Record ID
read-only
ipstring IP address.
read-only
ip_countinteger Number of IPs in the pool.
read-only
ipsobject[] Pool IPs that have references, with their referencing sites.
itemsIpCandidate[] Items on this page
namestring Name
node_idinteger Node ID
node_namestring Name of the node that owns the IP.
read-only
node_stateIpNodeState State of the owning primary node: disabled if the node is disabled; otherwise online if a heartbeat arrived in the last 2 minutes, else offline.
Values ["online","offline","disabled"]
pool_idinteger ID of the IP pool it belongs to.
read-only
region_idinteger Region ID
region_namestring Region name.
read-only
site_countinteger Number of IP sites referencing IPs in the pool (deduplicated by site).
read-only
updated_atstring Updated at
read-only

Responses and errors

Success returns the resource JSON directly (HTTP 2xx); failures return application/problem+json (code, detail, plus errors on validation failures); lists carry items + total.

Success
{
  "id": 1,
  "name": "example"
}
List
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
Error
{
  "code": "validation_failed",
  "detail": "Invalid request parameters",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name is required"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
Get started

Try the live demo

Open the live demo, or contact us for a quote and the install command