---
title: "Return available IPv6 address ranges"
method: GET
path: "/ipv6_range_list"
tags: ["IP Addresses", "IPv6 Address Settings"]
---

# Return available IPv6 address ranges

`GET /ipv6_range_list`

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*](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.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `range` object[] — An array of the IPv6 address ranges.
      - `CIDR` string — The IPv6 address range, in CIDR format.
      - `enabled` 0 | 1 — Whether the IPv6 address range is available. * `1` Available. * `0` Reserved.
      - `first` string, ipv6 — The first IPv6 address in the range.
      - `last` string, ipv6 — The last IPv6 address in the range.
      - `mostrecent` string, ipv6 — The most recently assigned address from the IPv6 address range.
      - `name` string — The IPv6 address range's name. **Note:** `SHARED` represents the server's main IPv6 address.
      - `note` string — The IPv6 address range's note.
      - `owner` string, username — The user who owns the IPv6 address range.
      - `range_users` string[] — The user or users who use addresses in the IPv6 address range.
      - `reclaimed` string[] — IPv6 addresses within the range which have become available.
  - `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)