Sign in

v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
IP Management API

Get Pool Details

This allows aparent account to fetch detailed information about an IP pool.

get/ip/pool-details

Query parameters

pool_namestring required

Name of the IP pool to retrieve details for. Must refer to an exisiting pool owned by the parent account.

region'US' | 'EU' | 'IND'

The region of the pool. Supported values are US, EU, and IND.If not provided, the system uses the pool's defined region.

Response

Pool details retrieved successfully

pool_namestring
regionstring
assigned_sub_accountsstring[]

Example response

{
  "pool_name": "marketing-pool",
  "region": "US",
  "ips_in_pool": [
    {
      "ip_address": "192.168.1.100",
      "region": "US",
      "rdns_status": "configured"
    }
  ],
  "assigned_sub_accounts": [
    "subaccount1",
    "subaccount2"
  ]
}