You can find our user documentation at

Check out our new API beta site!

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

This function unlinks a remote server node from your server.


This function does not unlink mail servers that are currently in use. You must first delete any accounts that use the linked mail server.

 Command Line
whmapi1 unlink_server_node alias=example


  • 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:


 Output (JSON)
   "data" : {
      "worker_capabilities" : {
         "Mail" : {}
      "tls_verified" : 1,
      "version" : "",
      "user" : "root",
      "hostname" : "",
      "last_check" : 1556576165,
      "enabled_services" : [
   "metadata" : {
      "command" : "unlink_server_node",
      "result" : 1,
      "version" : 1,
      "reason" : "OK"


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

ParameterTypeDescriptionPossible valuesExample


The name of a linked remote server node.

A valid name.

ReturnTypeDescriptionPossible valuesExample
enabled_servicesarrayThe services enabled on the linked remote server node.

A comma-separated list of services.

hostnamestringThe remote server node's hostname.A valid
last_checkedintergerThe last time that the server queried the current status of the remote server.A timestamp, in Unix time format.1556576165
tls_verifiedBooleanWhether the remote server node has a valid SSL certificate.
  • 1 — The remote server node has a valid SSL certificate.
  • 0 — The remote server node does not have a valid SSL certificate.
usernamestringThe username required to make API calls to the linked remote server node.A valid username.root
versionstringThe version of cPanel & WHM installed on the remote server node.

A cPanel & WHM version number.
worker_capabilitieshashA group of services required for a remote server node to perform a specific task.

Each hash contains the role_name return.


The return's name is the remote server node's current role.



The current role of the linked remote server node. This will return the required options for the role, if any exist.


The return's name is the remote server node's current role.

This function returns this value in the worker_capabilities hash.

A server role.


If no options exist, this function returns an empty hash.