Child pages
  • WHM API 1 Functions - ea4_tomcat85_add

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function adds a user to the Tomcat 8.5 configuration.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/ea4_tomcat85_add?api.version=1&user=user123&user=user456



Expand
titleCommand Line


Code Block
languagebash
whmapi1 ea4_tomcat85_add user=user123 user=user456

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
   "metadata":{
      "version":1,
      "reason":"OK",
      "command":"ea4_tomcat85_add",
      "result":1
   },
   "data":{
      "user123":"The user already has a tomcat 8.5 instance.",
      "user456":""
   }
}


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample

user


string

Required

The user that you wish to add.

Note
titleNote:

You can pass this parameter multiple times.


A valid user name.


user123

Returns

ReturnTypeDescriptionPossible valuesExample
user namestring

A status message.

Note
titleNote:

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


  • A blank string.
  • Any error message.
Note
titleNote:

A blank string represents success.


""