Run remote WHM API 1 function

This function executes WHM API 1 functions on a remote server.

Authorizations:
query Parameters
function
required
string

The name of the function to call on the remote server.

Example: function=passwd
host
required
string

The remote server's hostname or IP address.

Example: host=host.example.com
parameter_name
required
string

The name of the parameter for the function.

Note:

You must enter the same number of parameter_name and parameter_value parameters.

Example: parameter_name=user
parameter_value
required
string

The value of the parameter for the function.

Note:

You must enter the same number of parameter_name and parameter_value parameters.

Example: parameter_value=username2
password
required
string

The password to log in to the remote server.

Example: password=luggage12345
username
required
string

The username to log in to the remote server.

Example: username=username
tls_verification
string

Whether to use TLS verification. This parameter defaults to On.

Important:

We strongly recommend that you use TLS verification. Only connect to a server if you can verify its identity.

Example: tls_verification=on

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  execute_remote_whmapi1_with_password \
  host='host.example.com' \
  username='username' \
  password='luggage12345' \
  function='passwd' \
  parameter_name='user' \
  parameter_value='username2'

Response samples

Content type
application/json
{
  • "data": {
    • "app": [
      • "string"
      ],
    • "key-name*": "system"
    },
  • "metadata": {
    • "command": "execute_remote_whmapi1_with_password",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}