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

Description

This function lists the cPanel user accounts and the root user on the server.

Examples 


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


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)
{
  "data": {
    "users": [
        "example",
        "root"
    ]
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "list_users"
  }
}
 Output (XML)
<result>
    <data>
        <users>example</users>
        <users>root</users>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>list_users</command>
    </metadata>
</result>


Note:

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

   

Parameters

This function does not accept parameters. 

Returns

ReturnTypeDescriptionPossible valuesExample
usersarray An array of cPanel user accounts.

The list may consist of the following types of accounts:

  • A valid cPanel username.
  • root
example, root