We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

Description

This function removes a user from the Tomcat 8.5 configuration.

Important:

In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/ea4_tomcat85_rem?api.version=1&user=user123&user=user456
 Command Line
whmapi1 ea4_tomcat85_rem user=user123 user=user456


Notes:

  • Unless otherwise noted, 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)
{
   "metadata":{
      "command":"ea4_tomcat85_rem",
      "version":1,
      "result":1,
      "reason":"OK"
   },
   "data":{
      "user123":"The user does not have a tomcat 8.5 instance.\n",
      "user456":""
   }
}


Note:

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

Parameters

ParameterTypeDescriptionPossible valuesExample

user

string

Required

The user that you wish to remove.

Note:

You can pass this parameter multiple times.

A valid user name.

user123

Returns

ReturnTypeDescriptionPossible valuesExample

user name

string

A status message.

Note:

This return's name is the user's name.

  • A blank string.
  • Any error message.

Note:

A blank string represents success.



""