You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

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

Description

This function updates the /etc/userdomains file based on the entries in /var/cpanel/users directory.

Examples


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


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,
    "reason": "OK",
    "result": "1",
    "command": "updateuserdomains"
  }
}


Note:

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

Parameters

This function does not accept any parameters.

Returns

This function only returns metadata.