Remove IPv6 address range from account

This function removes the IPv6 address from an account.

Notes:

  • When you disable IPv6 on an account, the system unbinds that IPv6 address from your server and the account loses the address. If you enable IPv6 on that account again, the system assigns it a different IPv6 address.
  • 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
Request
query Parameters
user
required
string

A comma delimited list of account names.

Example: user=user1,user2,user3
Responses
200

HTTP Request was successful.

Response Schema: application/json
object
object
get/ipv6_disable_account
Request samples
whmapi1 --output=jsonpretty \
  ipv6_disable_account \
  user='user1,user2,user3'
Response samples
application/json
{
  • "data": {
    • "fail_cnt": 0,
    • "failures": [
      • {
        • "name": "user1",
        • "reason": "The “user1” account does not exist."
        }
      ]
    },
  • "metadata": {
    • "command": "ipv6_disable_account",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}