Return reseller's information

This function lists data about a reseller's accounts.

Authorizations:
query Parameters
user
required
string <username>

The reseller's username.

Example: user=username
filter_deleted
integer
Default: 0

Do not display the reseller's deleted cPanel accounts in the function's acct return. This parameter modifies the data output in the acct return.

  • 1 — Do not display.
  • 0 — Display.
Enum: 0 1
Example: filter_deleted=0
filter_suspended
integer
Default: 0

Do not display the reseller's suspended cPanel accounts in the function's acct return. This parameter modifies the data output in the acct return.

  • 1 — Do not display.
  • 0 — Display.
Enum: 0 1
Example: filter_suspended=0
month
integer [ 1 .. 12 ]

The month to query, in numeric format.

This parameter defaults to the current month.

Example: month=2
year
integer

The year to query, in numeric format.

This parameter defaults to the current year.

Example: year=2019

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  resellerstats \
  user='username'

Response samples

Content type
application/json
{
  • "data": {
    • "reseller": {
      • "acct": [
        • {
          • "bandwidthlimit": "500",
          • "bandwidthused": 0,
          • "deleted": 0,
          • "diskquota": "1100.00",
          • "diskused": "1.57",
          • "domain": "example1.com",
          • "package": "default",
          • "suspended": 0,
          • "user": "example1"
          }
        ],
      • "bandwidthlimit": 0,
      • "bwoverselling": 0,
      • "diskoverselling": 0,
      • "diskquota": 0,
      • "diskused": 5.69,
      • "month": 2,
      • "totalbwalloc": "500",
      • "totalbwused": 0,
      • "totaldiskalloc": "1100",
      • "user": "username",
      • "year": 2019
      }
    },
  • "metadata": {
    • "command": "resellerstats",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}