---
title: "Return IPv6 address usage"
method: GET
path: "/ipv6_range_usage"
tags: ["IP Addresses", "IPv6 Address Settings"]
---

# Return IPv6 address usage

`GET /ipv6_range_usage`

This function retrieves usage information for IPv6 addresses in an IPv6 range.

**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*](https://go.cpanel.net/whmdocsTweakSettings#system) section of WHM's [*Tweak Settings*](https://go.cpanel.net/whmdocsTweakSettings) interface (*WHM >> Home >> Server Configuration >> Tweak Settings*).

**Important:**

When you disable the [Web Server role](https://go.cpanel.net/howtouseserverprofiles#roles), the system **disables** this function.

## Query parameters

- `name` string, required

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `usage` object — The IPv6 address range's information.
      - `forbidden` integer — The number of reserved IPv6 addresses.
      - `free` integer — The number of available IPv6 addresses.
      - `used` integer — The number of assigned IPv6 addresses.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success * `0` - Failed. Check the `reason` field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)