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 sets the value of a PHP version's directives.
Note:
This document only applies to systems that run EasyApache 4.
Important:
When you disable the Web Server role , the system disables this function.
Security
BasicAuth
Query Examples:
The name of a PHP directive and its value.
Note:
To change the directive's value for multiple PHP directives, duplicate or increment the parameter name. For example, to change three directives, use the directive parameter multiple times or use the directive-1, directive-2 , and directive-3 parameters.
directive=directive-1=allow_url_fopen:0&directive-2=max_input_vars=1000
directive=allow_url_fopen:0
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/php_ini_set_directives
- A server running WHM.
https://whm-server.tld:2087/json-api/php_ini_set_directives
- 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/php_ini_set_directives?directive=string&version=ea-php72'Response
application/json
{ "data": {}, "metadata": { "command": "php_ini_set_directives", "reason": "Ok", "result": 1, "version": 1 } }
Request
This function sets a PHP version's handler.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/php_set_handler
- A server running WHM.
https://whm-server.tld:2087/json-api/php_set_handler
- 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/php_set_handler?handler=suphp&version=ea-php70'Response
application/json
{ "metadata": { "command": "php_set_handler", "reason": "OK", "result": 1, "version": 1 } }
Request
This function sets the location of PHP's default session save path.
Important:
When you disable the Web Server role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/whm.openapi/php_set_session_save_path
- A server running WHM.
https://whm-server.tld:2087/json-api/php_set_session_save_path
- 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/php_set_session_save_path?overwrite=0&path=%2Fvar%2Fcpanel%2Fphp%2Fsessions'Response
application/json
{ "metadata": { "command": "php_set_session_save_path", "reason": "OK", "result": 1, "version": 1 } }