UAPI accesses the cPanel interface's features. Use this API to access and modify cPanel account data and settings.
Download OpenAPI description
Overview
URL
WebPros International, LLC
License
Languages
Servers
Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/
A server running cPanel.
https://{host}:{port}/execute/
Request
This function disables ModSecurity™ on a cPanel account's domains.
Important:
When you disable the WebServer role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ModSecurity/disable_all_domains
- A server running cPanel.
https://cpanel-server.tld:2083/execute/ModSecurity/disable_all_domains
- 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/cpanel.openapi/ModSecurity/disable_all_domainsResponse
application/json
{ "apiversion": 3, "func": "disable_all_domains", "module": "ModSecurity", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function disables ModSecurity™ on specified domains.
Important:
When you disable the WebServer role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ModSecurity/disable_domains
- A server running cPanel.
https://cpanel-server.tld:2083/execute/ModSecurity/disable_domains
- 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/cpanel.openapi/ModSecurity/disable_domains?domains=example.com%2Cdallas.example.com%2Cgalveston.example.com'Response
application/json
{ "apiversion": 3, "func": "disable_domains", "module": "ModSecurity", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function enables ModSecurity™ on a cPanel account's domains.
Important:
When you disable the WebServer role, the system disables this function
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/ModSecurity/enable_all_domains
- A server running cPanel.
https://cpanel-server.tld:2083/execute/ModSecurity/enable_all_domains
- 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/cpanel.openapi/ModSecurity/enable_all_domainsResponse
application/json
{ "apiversion": 3, "func": "enable_all_domains", "module": "ModSecurity", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }