This function lists all accounts on the server or allows you to search for a specific account or set of accounts.
- searchtype
-
Type of account search. (domain | owner | user | ip | package )
- search
-
Search criteria. (Perl Regular Expression)
- listaccts
-
List of accounts container.
- acct
-
Account container.
- disklimit (string)
-
Disk space usage limit for the account. Format: XXXM
- diskused (string)
-
Current disk space usage for the account. Format: XXXM
- domain (string)
-
Name of the root domain for the account. Format: domain.com
- email (string)
-
Contact email for the account. Format: user@domain.com
- ip (string)
-
IP address of root domain on the account. Format: xxx.xxx.xxx.xxx
- owner (string)
-
Root owner of the account. Reseller or root. Format: username
- partition (string)
-
The disk/partition the user's home directory is located on.
- plan (string)
-
Hosting package associated with the account.
- startdate (date)
-
Date and time of plan creation. Format: YY Mon (D)D HH:MM
- theme (string)
-
cPanel interface theme associated with the account.
- user (string)
-
Username associated with the account. Format: username
Calling this URL in WebHost Manager:
/xml-api/listaccts?searchtype=user&search=luv
will produce:
<listaccts>
<acct disklimit="1000M" diskused="172M" domain="luvcpanel.com" email="luvcpanel@cpanel.net" ip="222.222.222.255" owner="root" partition="home" plan="gold_1000MB" startdate="04 May 8 21:12" theme="x3" user="luvcpanel"/>
</listaccts>
Note that ``?searchtype=user&search=luv'' will limit this to displaying only accounts with a username containing the regular expression ``luv''.
Copyright 2007 cPanel Inc.