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 removes a ModSecurity™ vendor. When you call this function, the system removes the vendor's includes, disablement directives, configuration files, and metadata file.
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_remove_vendor
- A server running WHM.
https://whm-server.tld:2087/json-api/modsec_remove_vendor
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
modsec_remove_vendor \
vendor_id='SomeVendor'Response
application/json
{ "metadata": { "command": "modsec_remove_vendor", "reason": "OK", "result": 1, "version": 1 } }
Request
This function updates a vendor with the current version of the rule set.
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_update_vendor
- A server running WHM.
https://whm-server.tld:2087/json-api/modsec_update_vendor
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
whmapi1 --output=jsonpretty \
modsec_update_vendor \
url='http://example.com/update/meta_MyVendor.yaml'Response
application/json
{ "data": { "diagnostics": { … }, "vendor": { … } }, "metadata": { "command": "modsec_update_vendor", "reason": "OK", "result": 1, "version": 1 } }