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 an email account's Webmail settings.
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_webmail_settings
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/get_webmail_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_webmail_settings?account=user%40example.com'Response
application/json
{ "apiversion": 3, "func": "get_webmail_settings", "module": "Email", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function sets Exim's queue to not send outgoing mail from an email account.
Notes:
- To send all mail from the queue, use the UAPI
Email::release_outgoingfunction. - To reject outgoing mail and not place mail in a queue, use the UAPI
Email::suspend_outgoingfunction. - This function does not hold local outgoing mail.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/hold_outgoing
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/hold_outgoing
- 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/hold_outgoing?email=username%40example.com'Response
application/json
{ "apiversion": 3, "func": "hold_outgoing", "module": "Email", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function lists a domain's autoresponders.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
Query
A Perl Compatible Regular Expression (PCRE) that filters the results.
Example: regex=user
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/list_auto_responders
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/list_auto_responders
- 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/list_auto_responders?domain=example.com®ex=user'Response
application/json
{ "apiversion": 3, "func": "list_auto_responders", "module": "Email", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }