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/
Query Examples:
The domain from which to remove the DMARC record.
Note:
If you do not include this argument, the system will remove all DMARC records from all domains owned by the user.
To remove multiple domain DMARC records, duplicate the parameter name. For example, use the domain=example.com, domain=example2.com, and domain=example3.com parameters.
You cannot remove DMARC records on temporary domains.
domain=domain=example.com&domain=example2.com&domain=example.com
domain=example.com
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/EmailAuth/remove_dmarc
- A server running cPanel.
https://cpanel-server.tld:2083/execute/EmailAuth/remove_dmarc
- 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/EmailAuth/remove_dmarc?domain=string'Response
application/json
{ "apiversion": 3, "func": "remove_dmarc", "module": "EmailAuth", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/EmailAuth/validate_current_dkims
- A server running cPanel.
https://cpanel-server.tld:2083/execute/EmailAuth/validate_current_dkims
- 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/EmailAuth/validate_current_dkims?domain=string'Response
application/json
{ "apiversion": 3, "func": "validate_current_dkims", "module": "EmailAuth", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/EmailAuth/validate_current_dmarcs
- A server running cPanel.
https://cpanel-server.tld:2083/execute/EmailAuth/validate_current_dmarcs
- 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/EmailAuth/validate_current_dmarcs?domain=string'Response
application/json
{ "apiversion": 3, "func": "validate_current_dmarcs", "module": "EmailAuth", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }