Return cPanel account summary

This function retrieves a summary of a user's account.

Note:

You must use either the user or domain parameters.

SecurityBasicAuth

Request

query Parameters

domain	string The account's main domain. Example: domain=example.com
user	string The account's username. Example: user=username

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/accountsummary

Request samples

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

Response samples

application/json

{"data": {"acct": [{"backup": 0,
"child_nodes": [{"alias": "nodealias",
"workload": "Mail"
}
],
"disklimit": "unlimited",
"diskused": "14M",
"domain": "example.com",
"email": "username@example.com",
"inodeslimit": "unlimited",
"inodesused": 1,
"ip": "192.168.0.128",
"ipv6": ["0101:ca75:0101:ca75:0101:ca75:0101:ca77"
],
"is_locked": 0,
"legacy_backup": 0,
"mailbox_format": "maildir",
"max_defer_fail_percentage": "unlimited",
"max_email_per_hour": "unlimited",
"max_emailacct_quota": "unlimited",
"maxaddons": "unlimited",
"maxftp": "unlimited",
"maxlst": "unlimited",
"maxparked": "unlimited",
"maxpop": "unlimited",
"maxsql": "unlimited",
"maxsub": "unlimited",
"min_defer_fail_to_trigger_protection": "5",
"outgoing_mail_hold": 0,
"outgoing_mail_suspended": 0,
"owner": "root",
"partition": "home",
"plan": "packagename",
"shell": "/bin/bash",
"startdate": "13 May 22 16:03",
"suspended": 0,
"suspendreason": "not suspended",
"suspendtime": null,
"temporary": 0,
"theme": "jupiter",
"uid": 0,
"unix_startdate": 1369256589,
"user": "username"
}
]
},
"metadata": {"command": "accountsummary",
"reason": "OK",
"result": 1,
"version": 1
}
}