Child pages
  • WHM API 1 Functions - setresellernameservers
Skip to end of metadata
Go to start of metadata

 

Description

This function assigns nameservers to a reseller's account.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/setresellernameservers?api.version=1&user=username&nameservers=192.168.0.20%2C192.168.0.21
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/setresellernameservers?api.version=1&user=username&nameservers=192.168.0.20%2C192.168.0.21
 Command Line
whmapi1 setresellernameservers user=username nameservers=192.168.0.20%2C192.168.0.21


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


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The reseller's username.

A valid reseller's username on the server.username
nameserversstring

The nameserver IP addresses to allocate to the reseller's account.

If you do not use this parameter, the function resets the reseller's nameservers to use the server default.

A comma-separated list of one or more nameserver IP addresses.
192.168.0.20,192.168.0.21

Returns

This function only returns metadata.