Knowledgebase

 Command

 This value is always cpapi1 for calls to cPanel API 1.

 Output Type

 The API output type that you wish to receive.

• Use --output=json to return JSON-formatted output.
• Use --output=jsonpretty to return indented JSON-formatted output.
• Use --output=xml to return XML-formatted output.
• Use --output=yaml to return YAML-formatted output.

 Note:

This parameter defaults to --output=yaml.

 Module

 The cPanel API 1 module name.

 Function

 The cPanel API 1 function.

 User

 The cPanel account-level username.

 Input parameters and values

 The function's input parameters and their values.

• You must URI-encode values.
• Separate multiple parameter=value pairs with a space character.
• Special characters within a key's value may cause an error. You must either escape any special characters within values or surround the value with appropriate quotes. For more information, read Wikipedia's Escape Characters article.
  For example, a bash shell command with a JSON-encoded value may appear similar to one of the following:
  • cpapi1 --user username Module function key=[\"sslinstall\",\"videotut\"]"
  • cpapi1 --user username Module function key='{"videotut","sslinstall"}'

 Note:

 The term "Boolean" in our documentation refers to parameters that accept values of 1 or 0. cPanel & WHM APIs do not support the literal values of true and false.