CPcpanel
API Execution

Run remote WHM API 1 function

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

get/execute_remote_whmapi1_with_password

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Query parameters

functionstring required
Example:passwd

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

hoststring required
Example:host.example.com

The remote server's hostname or IP address.

parameter_namestring required
Example:user

The name of the parameter for the function.

Note:

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

parameter_valuestring required
Example:username2

The value of the parameter for the function.

Note:

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

passwordstring required
Example:luggage12345

The password to log in to the remote server.

usernamestring required
Example:username

The username to log in to the remote server.

tls_verificationstring
Example:on

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.

Response

HTTP Request was successful.

Example response

{
  "data": {
    "key-name*": "system"
  },
  "metadata": {
    "command": "execute_remote_whmapi1_with_password",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.