List Accounts — listaccts

To use the XML API to perform the listaccts function from within your custom script:

• Append the /xml-api/listaccts function call name, plus the required variables (see below), to a URL which includes the address of your server.

• For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/xml-api/listaccts

• You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

• You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

To use the JSON API to perform the listaccts function from within your custom script:

• Append the /json-api/listaccts function call name, plus the required variables (see below), to a URL which includes the address of your server.

• For example, on a server whose hostname is example.com, you would include the following string in your script: https://example.com:2087/json-api/listaccts

• You need to be logged in with the proper permissions in order to call a function. See our document about Authenticating API Function Calls for more information about authenticating APIs from within a script.

• You can also perform the function by entering the string in your web browser's address bar. This may be useful for testing the function call and viewing its output.

Calling this function from WebHost Manager:

https://example.com:2087/xml-api/listaccts?searchtype=user&search=luv

will produce output similar to the following:

<listaccts>
    <acct>
        <disklimit>unlimited</disklimit>
        <diskused>19M</diskused>
        <domain>example.com</domain>
        <email>user@example.net</email>
        <ip>127.0.0.1</ip>
        <owner>luvexample</owner>
        <partition>home</partition>
        <plan>Plan One</plan>
        <startdate>09 Apr 11 15:49</startdate>
        <suspended>0</suspended>
        <suspendreason>not suspended</suspendreason>
        <suspendtime/>
        <theme>x3</theme>
        <unix_startdate>1239482997</unix_startdate>
        <user>luvexample</user>
    </acct>
    <status>1</status>
    <statusmsg>Ok</statusmsg>
</listaccts>

Note: Typing ?searchtype=user&search=luv limits the results to accounts with a username containing luv.

Calling this function from WebHost Manager:

https://example.com:2087/json-api/listaccts?searchtype=user&search=luv

will produce output similar to the following:

{
   "status":1,
   "statusmsg":"Ok",
   "acct":[
      {
         "partition":"home",
         "startdate":"09 May 19 07:49",
         "plan":"level3 ",
         "suspended":0,
         "theme":"x3",
         "user":"gus",
         "unix_startdate":1242737345,
         "suspendreason":"not suspended",
         "suspendtime":null,
         "ip":"127.0.0.1",
         "domain":"example.com",
         "diskused":"0M",
         "owner":"gus",
         "email":"*unknown*",
         "disklimit":"unlimited"
      }
   ]
}