These read-only functions return details about one hosting account: its domains, databases, limits and usage. All need key, action=list and user.
accountdetail
URL: /v1/accountdetail/ — the most complete view of an account.
curl -k -X POST https://203.0.113.10:2304/v1/accountdetail/ -d "key=YOUR_API_KEY&action=list&user=john"{"status":"OK","result":{
"domains":[{"domain":"example.com","path":"/home/john/public_html","email":"john@example.com"}],
"subdomins":[],
"databases":[],
"account_info":{"directory":"/home/john/","email":"john@example.com","package_id":"1","package_name":"default",
"space_available":19999.99,"space_usage":0.0009,"space_disk":"20000","db_max":"10","db_used":0,"state":"active",
"reseller":0,"bandwidth":"100000","bandwidth_used":0,"ftp_accounts":"10","ftp_accounts_used":1,
"email_accounts":"10","email_accounts_used":0,"addons_domains":20, ...}}}| Field | Meaning |
|---|---|
domains, subdomins | Domains and subdomains with their document root |
databases | MySQL databases of the account |
account_info.space_disk / space_usage / space_available | Disk quota, used and free space in MB |
db_max / db_used, ftp_accounts / ftp_accounts_used, email_accounts / email_accounts_used | Package limits and current usage |
bandwidth / bandwidth_used | Monthly bandwidth limit and usage in MB |
state | active or suspended |
account_metadata
URL: /v1/account_metadata/ — general data plus lists of the account’s domains, subdomains, email accounts, databases and FTP accounts.
curl -k -X POST https://203.0.113.10:2304/v1/account_metadata/ -d "key=YOUR_API_KEY&action=list&user=john"{"status":"OK","result":{"general":{"user":"john","package_name":"default","package_id":"1","ip":"203.0.113.10",
"domain":"example.com","email":"john@example.com","path":"/home/john/","email_max":"10","domian_max":"10",
"subdomian_max":"10","domian_used":0,"subdomain_used":0,"space_usage":0.0009,"space_disk":"unlimited", ...},
"domais":[],"subdomais":"","email":[],"database":[],"ftp_accounts":[]}}Note: This response also contains the account’s password hash (general.pass). Treat it as sensitive data: do not log or display it.
accountquota
URL: /v1/accountquota/ — package limits (pack) and usage (account) per resource. Unlike most functions, this response has no status field.
curl -k -X POST https://203.0.113.10:2304/v1/accountquota/ -d "key=YOUR_API_KEY&action=list&user=john"{"domains":{"pack":"10","account":0,"sw":10},
"subdomins":{"pack":"10","account":0,"sw":10},
"emailaccount":{"pack":"10","account":0,"sw":10,"disk_quota":"20000"},
"mail_autoreply":{"pack":"10","account":0,"sw":10,"disk_quota":"20000"},
"ftp":{"pack":{"ftp_accounts":"10", ...},"account":0,"sw":1}}quotalimit
URL: /v1/quotalimit/ — disk quota usage of the account as reported by the system.
curl -k -X POST https://203.0.113.10:2304/v1/quotalimit/ -d "key=YOUR_API_KEY&action=list&user=john"{"status":"OK","msj":{"used":0,"quota":"541"}}