Developer Documentation
Child pages
  • WHM API 1 Functions - ipv6_range_remove
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description


This function removes an IPv6 address range from the server.

Notes:

  • This function cannot modify the server's shared IPv6 address. To update that address, modify  the /etc/wwwacct.conf file, or use WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup).
  • 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_remove?api.version=1&name=WhereTheDeerAndTheAntelopePlay
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/ipv6_range_remove?api.version=1&name=WhereTheDeerAndTheAntelopePlay
 Command Line
whmapi1 ipv6_range_remove name=WhereTheDeerAndTheAntelopePlay


Notes:

  • 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)
{
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "ipv6_range_remove"
    }
}
 Output (XML)
<result>
   <metadata>
      <version>1</version>
      <reason>OK</reason>
      <result>1</result>
      <command>ipv6_range_remove</command>
   </metadata>
</result>


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
name
string

Required

The IPv6 address range's name.

The name of an IPv6 address range on the server.
WhereTheDeerAndTheAntelopePlay

Returns

This function only returns metadata.

 

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

 

 

cPanel, WebHost Manager, and WHM are registered trademarks of cPanel, Inc. for providing its computer software that facilitates the management and configuration of Internet web servers. ®2018 All rights reserved.