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 retrieves autoresponder information.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/get_auto_responder
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/get_auto_responder
- 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/Email/get_auto_responder?email=user&temp_charset=utf-8'Response
application/json
{ "apiversion": 3, "func": "get_auto_responder", "module": "Email", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function retrieves an email account's client settings.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
Query
The email address for which to send client settings.
Note:
This parameter defaults to the system default email account.
Example: account=username@example.com
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/get_client_settings
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/get_client_settings
- 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/Email/get_client_settings?account=username%40example.com'Response
application/json
{ "apiversion": 3, "func": "get_client_settings", "module": "Email", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function retrieves the account's default email quota size, in bytes format.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/get_default_email_quota
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/get_default_email_quota
- 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/Email/get_default_email_quotaResponse
application/json
{ "apiversion": 3, "func": "get_default_email_quota", "module": "Email", "result": { "data": 34359738368, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }