WHM API 1 Functions - ipv6_range_usage

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).

Examples

JSON API

https://hostname.example.com:2087/cpsess##########/json-api/ipv6_range_usage?api.version=1&name=WhereTheSkiesAreNotCloudyAllDay

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/ipv6_range_usage?api.version=1&name=WhereTheSkiesAreNotCloudyAllDay

Command Line

whmapi1 ipv6_range_usage name=WhereTheSkiesAreNotCloudyAllDay

Notes:

Unless otherwise noted, you must URI-encode values.
For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
If you run CloudLinux™, you must use the full path of the whmapi1 command:
```
/usr/local/cpanel/bin/whmapi1
```

Output (JSON)

{
   "data": {
        "usage": {
            "forbidden": "65536",
            "free": "used",
            "used": "20"
   },
   "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "ipv6_range_usage"
        }
    }
}

Output (XML)

<result>
   <data>
      <usage>
         <forbidden>65536</forbidden>
         <free>1000000</free>
         <used>20</used>
      </usage>
   </data>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>ipv6_range_usage</command>
   </metadata>
</result>

Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

Parameter Type Description Possible values Example

name

string

Required

The IPv6 address range's name.

The name of an IPv6 address range on the server.
SHARED — The server's shared IPv6 address. cPanel & WHM version 54+ only.

WhereTheSkiesAreNotCloudyAllDay

Returns

Return	Type	Description	Possible values	Example
`usage`	hash	A hash of the IPv6 address range's information.	This hash includes the `forbidden`, `free`, and `used` returns.
`forbidden`	integer	The number of reserved IPv6 addresses. The function returns this value in the `usage` hash.	A positive integer.	65536
`free`	integer	The number of available IPv6 addresses. The function returns this value in the `usage` hash.	A positive integer.	1000000
`used`	integer	The number of assigned IPv6 addresses. The function returns this value in the `usage` hash.	A positive integer.	20

Function information

API Version:

WHM API 1

Available in:

WHM 11.40+

Methods:

GET, POST

Required Parameters:

name

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Functions - ipv6_disable_account — This function removes the IPv6 address from an account.
Page:

WHM API 1 Functions - ipv6_enable_account — This function assigns an IPv6 address to one or more accounts.
Page:

WHM API 1 Functions - ipv6_range_add — This function adds a range of IPv6 addresses to the server.
Page:

WHM API 1 Functions - ipv6_range_list — This function lists available IPv6 address ranges.
Page:

WHM API 1 Functions - ipv6_range_usage — This function retrieves usage information for IPv6 addresses in an IPv6 range.

Child pages