Return available IPv6 address ranges

This function lists available IPv6 address ranges.

Note:

For all of cPanel & WHM's features to function properly on IPv6, the cpsrvd daemon must listen on IPv6 addresses. To enable this functionality, select On for the Listen on IPv6 Addresses setting in the System section of WHM's Tweak Settings interface (WHM >> Home >> Server Configuration >> Tweak Settings).

Important:

When you disable the Web Server role, the system disables this function.

SecurityBasicAuth
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/ipv6_range_list
Request samples
whmapi1 --output=jsonpretty \
  ipv6_range_list
Response samples
application/json
{
  • "data": {
    • "range": [
      • {
        • "CIDR": "2001:db8:100:6::/64",
        • "enabled": 1,
        • "first": "2001:db8:0100:0006:0000:0000:0000:0000",
        • "last": "2001:db8:0100:0006:ffff:ffff:ffff:ffff",
        • "mostrecent": "2001:db8:0100:0006:0000:0000:0002:00ce",
        • "name": "test_range",
        • "note": "This is used for development.",
        • "owner": "root",
        • "range_users": [
          • "user1"
          ],
        • "reclaimed": [
          • "2001:db8:0100:0006:0000:0000:0000:0002"
          ]
        }
      ]
    },
  • "metadata": {
    • "command": "ipv6_range_list",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}