WHM API.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/
A server running WHM.
https://{host}:{port}/json-api/
Query
The configuration key's name.
- This parameter uses the key names listed in the
/var/cpanel/conf/{service}/mainfile, where {service} is the service's name from the service parameter. - This function does not support subkeys.
Example: key=mail_process_size
The service's name.
- A list of service names exists in the
/var/cpanel/confdirectory.
Example: service=dovecot
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_service_config_key
- A server running WHM.
https://whm-server.tld:2087/json-api/set_service_config_key
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_service_config_key?key=mail_process_size&service=dovecot&value=512'Response
application/json
{ "metadata": { "command": "set_service_config_key", "reason": "Succeeded", "result": 1, "version": 1 } }
Request
This function lets you configure a cPanel account's service proxying.
Note:
- If the cPanel account is a distributed account, and you call this function on the account’s parent node, the system will propagate the new service proxying to the child node.
- If the Web Server role is active on the server, this function rebuilds the user's web virtual hosts (vhosts) and restarts the web server.
- If the system cannot rebuild the user's vhosts, the API call will still succeed. However, the function returns a failure warning in the metadata.
- To remove an account's service proxying, use the WHM API 1
unset_all_service_proxy_backendsfunction.
Security
BasicAuth
Query
The hostname or IP address to assign as the server that handles the account's service proxy requests.
This parameter defaults to the existing service proxy configuration, if one exists.
Any of:
A valid hostname.
string(hostname)
A valid hostname.
The name of a service group for which to assign a proxy backend. The corresponding service_group_backend value will be the service group's new proxy backend.
Mail— The Mail service group.
This parameter defaults to the existing setting, if one exists.
Note:
- When you call this parameter, you must include a corresponding
service_group_backendvalue. - To add
multiple service_groupvalues, increment the parameter name. For example,service_group-1,service_group-2, andservice_group-3.
Value"Mail"
Examples: service_group=service-group-0=Mail&service-group-1=Mail&service-group-3=Mail
service_group=Mail
The hostname or IP address of the server to assign as the corresponding service_group value's proxy backend server.
This parameter defaults to the existing setting, if one exists.
Note:
- When you call this parameter, you must include a corresponding
service_groupvalue. - To add multiple
service_group_backendvalues, increment the parameter name. For example,service_group_backend-1,service_group_backend-2, andservice_group_backend-3.
service_group_backend=service_group_backend-1=mail.example1.com&service_group_backend-2=mail.example2.com&service_group_backend-3=mail.example3.com
service_group_backend=mail.example.com
Any of:
A valid hostname.
string(hostname)
A valid hostname.
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_service_proxy_backends
- A server running WHM.
https://whm-server.tld:2087/json-api/set_service_proxy_backends
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/set_service_proxy_backends?username=example&general=hostname.example.com&service_group=Mail&service_group_backend=hostname.example.com'Response
application/json
{ "metadata": { "command": "set_service_proxy_backends", "reason": "OK", "result": 1, "version": 1 } }
Request
This function removes a cPanel account's service proxying.
Note:
- If the cPanel account is a distributed account, this function will also unset all service proxying for the cPanel account on the child node.
- If the Web Server role is active on the server, this function rebuilds the cPanel user's web virtual hosts (vhosts) and restarts the web server.
- If the system cannot rebuild the cPanel user's vhosts, the API call will still succeed. However, the function returns a failure warning in the metadata.
- To set a service proxying for a cPanel account, use the WHM API 1
set_service_proxy_backendsfunction.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/unset_all_service_proxy_backends
- A server running WHM.
https://whm-server.tld:2087/json-api/unset_all_service_proxy_backends
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://api.docs.cpanel.net/_mock/specifications/whm.openapi/unset_all_service_proxy_backends?username=username'Response
application/json
{ "metadata": { "command": "unset_all_service_proxy_backends", "reason": "OK", "result": 1, "version": 1 } }