Get Server Statistics
| Function | Get all server statistics and usages |
| Command | CMD_API_ADMIN_STATS |
| Method | GET |
| Success Returns | url encoded array |
| Failure Returns | error=1 |
Array returns values: Name Value
| RX | Number of megabytes currently received through the adaptor with units, as returned by 'ifconfig'. eg. 1045.4 Mb |
| TX | Number of megabytes currently sent through the adaptor with units, as returned by 'ifconfig'. eg. 5345.4 Mb |
| bandwidth | Number of megabytes sent and recorded by DirectAdmin |
| quota | Number of megabytes of disk space used by users as recorded by DirectAdmin |
| disk1 | Disk Usage as returned by 'df'. Stored in a colon separated list. eg: /dev/hda6:381139:276138:85323:77%:/ Where data is: Filesystem:1k-blocks:Used:Available:Use%:Mounted on |
| ( disk2 … ) | Repeat of disk1, with one disk# for each partition. |
| domainptr | Number of domain pointers on the server |
| ftp | Number of ftp accounts on the server |
| mysql | Number of databases on the server |
| nemailf | Number of email forwarders on the server |
| nemailml | Number of mailing lists on the server |
| nemailr | Number of autoresponders on the server |
| nemails | Number of pop accounts on the server |
| nresellers | Number of resellers on the server |
| nsubdomains | Number of subdomains on the server |
| nusers | Number of users on the server |
| vdomains | Number of virtual domains on the server |
Get User Usage
| Function | Retrieve the user's usages |
| Command | CMD_API_SHOW_USER_USAGE |
| Method | GET |
| Success Returns | url encoded array |
| Failure Returns | error=1 |
Form values:
Name Value
| user | Username of the user for which you wish to view the stats |
Array returns values:
Name Value
| bandwidth | Number of megabytes sent by the user |
| quota | Number of megabytes of disk space used by the user |
| domainptr | Number of domain pointers used |
| ftp | Number of ftp accounts used |
| mysql | Number of databases used |
| nemailf | Number of email forwarders used |
| nemailml | Number of mailing lists used |
| nemailr | Number of autoresponders used |
| nemails | Number of pop accounts used |
| nsubdomains | Number of subdomains used |
| vdomains | Number of virtual domains used |
Get User Limits and Configurations
| Function | Retrieve the user's upper limits and settings that defines their account |
| Command | CMD_API_SHOW_USER_CONFIG |
| Method | GET |
| Success Returns | url encoded array |
| Failure Returns | error=1 |
| Form values: | |
| Name Value | |
| user | Username of the user for which you wish to view the stats |
| Array returns values: | |
| Name Value | |
| account | One of ON or OFF. Used to determine the state of an account. Manually suspendig a user will set this to off. Automatic suspensions will not. |
| aftp | One of ON or OFF. Used to determine if the user can have an anonymous ftp account |
| cgi | One of ON or OFF. Used to determine if the user can have a cgi-bin |
| creator | name of the account used to create this user |
| dnscontrol | One of ON or OFF. Used to determine if the user is allowed to modify their dns records |
| docsroot | local path (relative to /usr/local/directadmin) to the user's current selected skin |
| domain | The main domain for the user. Will be the domain included when the account was created |
| The current email account, as set by the user. Note that this may differ from the email set in their messaging system | |
| ip | Current ip assigned to the user |
| ns1 and ns2 | Current nameservers assigned to the user |
| package | Package used to create the user. Will be custom if their settings were modified. |
| sentwarning | To determine if the usage warning email has already been sent out |
| skin | Name of the user's current skin |
| ssh | One of ON or OFF. Does the user have ssh |
| ssl | One of ON or OFF. Does the user have ssl |
| suspend_at_limit | One of ON or OFF. Will the user be suspended at his bandwidth limit |
| suspended | One of yes or no. Is the user currently suspended. |
| username | The username of the username. |
| usertype | One of user, reseller or admin. Type of user account |
| zoom | Depreciated setting where you can set the permanent ZOOM token. Will set the webpage to be zoomed at this level |
| bandwidth | Maximum number of megabytes allowed by the user |
| quota | Maximum megabytes of disk space allowed by the user |
| domainptr | Number of domain pointers allowed |
| ftp | Number of ftp accounts allowed |
| mysql | Number of databases allowed |
| nemailf | Number of email forwarders allowed |
| nemailml | Number of mailing lists allowed |
| nemailr | Number of autoresponders allowed |
| nemails | Number of pop accounts allowed |
| nsubdomains | Number of subdomains allowed |
| vdomains | Number of virtual domains allowed |
Get User Domains
| Function | Retrieve the list of domains owned by the user, and some basic stats |
| Command | CMD_API_SHOW_USER_DOMAINS |
| Method | GET |
| Success Returns | url encoded array |
| Failure Returns | error=1 |
| Form values: | |
| Name | Value |
| user | Username of the user for which you wish to view the stats |
| Array returns values: | |
| Name | Value |
| domain.com | Colon speparated list with domain information: eg. 6757.4:unlimited:0.000356674:93.5:2:no:unlimited:ON:ON:ON where the data is bandwidth used:bandwidth limit:disk usage for the domain:log usage for the domain:# of subdomains:suspended:quota:ssl:cgi:php |
| ( domain2.com … ) | Same as domain.com, one entry for each domain |