Child pages
  • WHM API 1 Functions - ea4_tomcat85_list
Skip to end of metadata
Go to start of metadata

Description

This function returns a list of the users that run Tomcat.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/ea4_tomcat85_list?api.version=1
 Command Line
whmapi1 ea4_tomcat85_list


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
   "data":{
      "tomcat85_users":[
         "user123",
         "user456",
         "user789"
       ]
   },
   "metadata":{
      "result":1,
      "command":"ea4_tomcat85_list",
      "version":1,
      "reason":"OK"
   }
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionarrayPossible valuesExample
tomcat85_users
arrayAn array of user names.

An array of users that run Tomcat.


["user123","user456","user789"]