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

Description

This function returns the maximum number of cPanel accounts allowed for the server's license.

Examples 


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


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)
{
  "data": {
    "users": "100"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "get_maximum_users"
  }
}


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
usersintegerThe maximum number of cPanel accounts that the server's license allows.
  • A positive integer.
  • 0 — unlimited.
100