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/
Request
This function provides information that will help you to determine whether your server can handle the workload if you enable PHP-FPM for all domains.
Important:
When you disable the Web Server role, the system disables this function.
Warning:
We strongly recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/get_fpm_count_and_utilization
- A server running WHM.
https://whm-server.tld:2087/json-api/get_fpm_count_and_utilization
- 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/get_fpm_count_and_utilizationResponse
application/json
{ "data": { "domains_to_be_enabled": 2, "domains_using_fpm": 20, "memory_needed": 90000, "number_of_new_fpm_accounts_we_can_handle": 8, "show_warning": 0, "total_domains": 22 }, "metadata": { "command": "get_fpm_count_and_utilization", "reason": "OK", "result": 1, "version": 1 } }
Request
This function indicates whether the system's process to convert all of WHM's accounts to use PHP-FPM is in progress.
Important:
When you disable the Web Server role, the system disables this function.
Warning:
We strongly recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/is_conversion_in_progress
- A server running WHM.
https://whm-server.tld:2087/json-api/is_conversion_in_progress
- 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/is_conversion_in_progressResponse
application/json
{ "data": { "inProgress": 1 }, "metadata": { "command": "is_conversion_in_progress", "reason": "OK", "result": 1, "version": 1 } }
Request
This function retrieves the PHP INI directives and pool options for a system's or domain's PHP-FPM configuration.
Important:
When you disable the WebServer role, the system disables this function.
Warning:
We strongly recommend that you only activate Apache PHP-FPM if your server has at least 2 GB of RAM available, or at least 30 MB of RAM per domain. If you enable PHP-FPM on a server with less than the required RAM, your server may experience severe performance issues.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/php_fpm_config_get
- A server running WHM.
https://whm-server.tld:2087/json-api/php_fpm_config_get
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/php_fpm_config_get \
-H 'Content-Type: application/json' \
-d '{
"domain": "example.com"
}'Response
application/json
{ "data": { "config": [ … ] }, "metadata": { "command": "php_fpm_config_get", "reason": "OK", "result": 1, "version": 1 } }