Accounts
Account Management
Return cPanel accounts
This function lists the accounts on the server.
get/listaccts
Query parameters
searchstring
Example:username
A Perl Compatible Regular Expression (PCRE) that filters the results.
Note:
- The system matches the PCRE against the searchtype parameter's specified type.
- If you do not specify a value for both the searchtype and search parameters, the function returns all of the server's accounts.
searchmethod'exact' | 'regex'
Example:exact
The function's search method.
- exact - The matched value and the search value must be identical.
- regex - The matched value must contain the search value.
searchtype'domain' | 'owner' | 'user' | 'ip' | 'package'
Example:domain
The account information to query. If you do not specify a value for both the searchtype and search parameters, the function returns all of the server's accounts.
- domain - Match domains against the search regular expression.
- owner - Match the WHM user who owns the account against the search regular expression.
- user - Match usernames against the search regular expression.
- ip - Match IP addresses against the search regular expression.
- package - Match hosting plans (packages) against the search regular expression.
wantstring
Example:domain,diskused
The returns to include in the output for each account.
If you do not specify a value, the function's output includes all of its returns.
Response
HTTP Request was successful.
Example response
{
"data": {
"acct": [
{
"child_nodes": [
{
"alias": "nodealias",
"workload": "Mail"
}
],
"diskused": "14M",
"domain": "example.com",
"email": "username@example.com",
"has_backup": 1,
"inodesused": 1,
"ip": "192.168.0.128",
"ipv6": [
"0101:ca75:0101:ca75:0101:ca75:0101:ca77"
],
"mailbox_format": "mdbox",
"outgoing_mail_hold": 1,
"owner": "root",
"partition": "home",
"plan": "packagename",
"shell": "/bin/bash",
"startdate": "13 May 22 16:03",
"suspendreason": "suspended for non-payment",
"suspendtime": 1594040856,
"theme": "jupiter",
"uid": 1001,
"unix_startdate": 1369256589,
"user": "username",
"standalone_feature": "standalone-nova",
"standalone_feature_name": "AI App Builder"
}
]
},
"metadata": {
"command": "listaccts",
"reason": "OK",
"result": 1,
"version": 1
}
}