Version 2.1.1792967583 · latest Download OpenAPI Markdown

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.

ip-poolsIP product lineAuthentication: Admin only12 endpoints

List IP pools

GET/api/v2/ip-pools

Authentication: Admin only

Query parameters

Field	Type	Required	Description
page	integer	—	Page number, starting from 1 Default `1`
page_size	integer	—	Items per page Default `20`
sort	string	—	Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`
region_id	integer	—	Filter by region.

Create IP pool

POST/api/v2/ip-pools

Authentication: Admin only

Request body application/json

Field	Type	Required	Description
des	string	—	Description
name	string	Required	Name
region_id	integer	Required	Region ID

IP pool candidate node IPs

GET/api/v2/ip-pools/candidates

Authentication: Admin only

Query parameters

Field	Type	Required	Description
region_id	integer	Required	Region ID.

Get IP pool

GET/api/v2/ip-pools/{id}

Authentication: Admin only

Update IP pool

PUT/api/v2/ip-pools/{id}

Authentication: Admin only

Request body application/json

Field	Type	Required	Description
des	string	—	Description
name	string	Required	Name
region_id	integer	Required	Region ID

Delete IP pool

DELETE/api/v2/ip-pools/{id}

Authentication: Admin only

IP pool referencing sites

GET/api/v2/ip-pools/{id}/refs

Authentication: Admin only

Query parameters

Field	Type	Required	Description
ip_id	integer	—	Show only this pool IP.
limit	integer	—	Maximum number of sites listed per IP. Default `20`

List IPs in pool

GET/api/v2/ip-pools/{pool_id}/ips

Authentication: Admin only

Query parameters

Field	Type	Required	Description
page	integer	—	Page number, starting from 1 Default `1`
page_size	integer	—	Items per page Default `20`
sort	string	—	Sort fields, comma-separated; prefix `-` for descending, e.g. `-created_at,id`

Add IP to pool

POST/api/v2/ip-pools/{pool_id}/ips

Authentication: Admin only

Request body application/json

Field	Type	Required	Description
bind_addr	string	—	The local address the node actually listens on (NAT setups); null means use ip.
node_id	integer	Required	Node ID

Update pool IP

PUT/api/v2/ip-pools/{pool_id}/ips/{id}

Authentication: Admin only

Request body application/json

Field	Type	Required	Description
bind_addr	string	—	The local address the node actually listens on (NAT setups); null means use ip.
enabled	boolean	—	Whether enabled

Remove IP from pool

DELETE/api/v2/ip-pools/{pool_id}/ips/{id}

Authentication: Admin only

Issue platform certificate for pool IP

POST/api/v2/ip-pools/{pool_id}/ips/{id}/issue-cert

Authentication: Admin only

Request body application/json

Field	Type	Required	Description
confirm	boolean	—	Confirm re-issuing when a valid certificate already exists.

IP pools object

Field	Type	Required	Description
bind_addr	string	—	The local address the node actually listens on (NAT setups); null means use ip.
cert	IpCertState	—	Platform IP certificate status.
confirm	boolean	—	Confirm re-issuing when a valid certificate already exists.
created_at	string	—	Created at read-only
des	string	—	Description
enabled	boolean	—	Whether enabled
hints	string[]	—	Hints (e.g. the node reported no NIC addresses, so the pool entry was not verified). read-only
id	integer	—	Record ID read-only
ip	string	—	IP address. read-only
ip_count	integer	—	Number of IPs in the pool. read-only
ips	object[]	—	Pool IPs that have references, with their referencing sites.
items	IpCandidate[]	—	Items on this page
name	string	—	Name
node_id	integer	—	Node ID
node_name	string	—	Name of the node that owns the IP. read-only
node_state	IpNodeState	—	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_id	integer	—	ID of the IP pool it belongs to. read-only
region_id	integer	—	Region ID
region_name	string	—	Region name. read-only
site_count	integer	—	Number of IP sites referencing IPs in the pool (deduplicated by site). read-only
updated_at	string	—	Updated at read-only

curl

# List IP pools
curl "https://panel.example.com/api/v2/ip-pools" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Create IP pool
curl -X POST "https://panel.example.com/api/v2/ip-pools" \
  -H "X-API-Key: $GOCDN_API_KEY"

# IP pool candidate node IPs
curl "https://panel.example.com/api/v2/ip-pools/candidates" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Get IP pool
curl "https://panel.example.com/api/v2/ip-pools/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Update IP pool
curl -X PUT "https://panel.example.com/api/v2/ip-pools/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Delete IP pool
curl -X DELETE "https://panel.example.com/api/v2/ip-pools/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"

# IP pool referencing sites
curl "https://panel.example.com/api/v2/ip-pools/{id}/refs" \
  -H "X-API-Key: $GOCDN_API_KEY"

# List IPs in pool
curl "https://panel.example.com/api/v2/ip-pools/{pool_id}/ips" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Add IP to pool
curl -X POST "https://panel.example.com/api/v2/ip-pools/{pool_id}/ips" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Update pool IP
curl -X PUT "https://panel.example.com/api/v2/ip-pools/{pool_id}/ips/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Remove IP from pool
curl -X DELETE "https://panel.example.com/api/v2/ip-pools/{pool_id}/ips/{id}" \
  -H "X-API-Key: $GOCDN_API_KEY"

# Issue platform certificate for pool IP
curl -X POST "https://panel.example.com/api/v2/ip-pools/{pool_id}/ips/{id}/issue-cert" \
  -H "X-API-Key: $GOCDN_API_KEY"