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

 

Description

This function limits the packages that a reseller assigns to cPanel accounts.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/setresellerpackagelimit?api.version=1&user=username&no_limit=0&package=package1&allowed=1&number=5
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/setresellerpackagelimit?api.version=1&user=username&no_limit=0&package=package1&allowed=1&number=5
 Command Line
whmapi1 setresellerpackagelimit user=username no_limit=0 package=package1 allowed=1 number=5


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)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "setresellerpackagelimit"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>setresellerpackagelimit</command>
    </metadata>
</result>


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
userstring

Required

The reseller's username.

A valid reseller username on the server.username
no_limitBoolean

Whether to grant the reseller unlimited package use.

This parameter defaults to 0.

  • 1 — Grant the reseller unlimited package use.
  • 0 — Use package limits.
0
packagestring

A hosting plan (package), to modify the reseller's access settings for it.

Note:

Use this parameter with the number or allowed parameters. 

A valid hosting plan (package) on the server.package1
allowedBoolean

Whether the reseller can access the package hosting plan.

Note:

If you use this parameter, you must also include the package parameter.

  • 1 — Enable access.
  • 0 — Disable access.
1
numberinteger

The maximum number of accounts to which the reseller can assign the package hosting plan.

Notes:

  • If you use this parameter, you must also include the package parameter.
  • If you set a value for this parameter and set the allowed parameter to 0, the reseller cannot use the hosting plan.
A positive integer.5

Returns

This function only returns metadata.