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 enables a ModSecurity™ vendor rule set.
Note:
This function will not enable vendor configuration files that you individually disable.
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/modsec_enable_vendor
- A server running WHM.
https://whm-server.tld:2087/json-api/modsec_enable_vendor
- 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/modsec_enable_vendor?vendor_id=SomeVendor'Response
application/json
{ "data": {}, "metadata": { "command": "modsec_enable_vendor", "reason": "OK", "result": 1, "version": 1 } }
Request
This function enables a ModSecurity™ vendor's configuration files.
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/modsec_enable_vendor_configs
- A server running WHM.
https://whm-server.tld:2087/json-api/modsec_enable_vendor_configs
- 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/modsec_enable_vendor_configs?vendor_id=SomeVendor'Response
application/json
{ "data": { "outcomes": [ … ] }, "metadata": { "command": "modsec_enable_vendor_configs", "reason": "OK", "result": 1, "version": 1 } }
Request
This function enables automatic updates for a ModSecurity™ vendor.
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/modsec_enable_vendor_updates
- A server running WHM.
https://whm-server.tld:2087/json-api/modsec_enable_vendor_updates
- 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/modsec_enable_vendor_updates?vendor_id=example'Response
application/json
{ "data": {}, "metadata": { "command": "modsec_enable_vendor_updates", "reason": "OK", "result": 1, "version": 1 } }