We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function sets the nameserver software that the remote servers in a DNS cluster run. The system queues the nameserver software that you select until the HTTP request finishes. Then, it sets the remote servers' nameserver software.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/set_nameserver?api.version=1&nameserver=BIND
 Command Line
whmapi1 set_nameserver nameserver=BIND


Notes:

  • Unless otherwise noted, 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,
      "result":1,
      "reason":"OK",
      "command":"set_nameserver"
   },
   "data":{
      "nameserver":"bind",
      "message":"Queued task to set nameserver to bind successfully."
   }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample
nameserverstring

Required

The nameserver software.

  • BIND
  • PowerDNS
  • Disabled
BIND 

Returns

ParameterTypeDescriptionPossible valuesExample
nameserverstring

The nameserver software.

  • bind
  • powerdns
  • disabled
bind
messagestringA confirmation message from the system.A valid string.Queued task to set nameserver to bind successfully.