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
The email account's name.
account=_mainaccount@example.com
account=example
account=user@example.com
Any of:
string(email)
The mailbox to operate on.
Note:
- Use the
Mailboxes::get_mailbox_status_listfunction to list possible values for the mailbox parameter. - Because you cannot escape wildcard characters such as (
*), we recommend that you use functions that use themailbox_guidparameter instead. For example, theMailboxes::expunge_messages_for_mailbox_guidfunction.
Example: mailbox=INBOX.user@example_com
The Dovecot query to execute.
Note:
The query parameter prevents accidental removal of all messages in the mailbox. For more information, read Dovecot's Search Query documentation.
Example: query=savedbefore 52w
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Mailboxes/expunge_mailbox_messages
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Mailboxes/expunge_mailbox_messages
- 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/Mailboxes/expunge_mailbox_messages?account=user%40example.com&mailbox=INBOX.user%40example_com&query=savedbefore+52w'Response
application/json
{ "apiversion": 3, "func": "expunge_mailbox_messages", "module": "Mailboxes", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Query
The email account's name.
account=_mainaccount@example.com
account=example
account=user@example.com
Any of:
string(email)
The mailbox's globally unique identifier (GUID).
Use the Mailboxes::get_mailbox_status_list function to list possible values for the mailbox_guid parameter.
Example: mailbox_guid=2550860f0c58d158c92a000044f0d230
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Mailboxes/expunge_messages_for_mailbox_guid
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Mailboxes/expunge_messages_for_mailbox_guid
- 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/Mailboxes/expunge_messages_for_mailbox_guid?account=user%40example.com&mailbox_guid=2550860f0c58d158c92a000044f0d230&query=savedbefore+52w'Response
application/json
{ "apiversion": 3, "func": "expunge_messages_for_mailbox_guid", "module": "Mailboxes", "result": { "data": {}, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Mailboxes/get_mailbox_status_list
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Mailboxes/get_mailbox_status_list
- 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/Mailboxes/get_mailbox_status_list?account=user%40example.com'Response
application/json
{ "apiversion": 3, "func": "get_mailbox_status_list", "module": "Mailboxes", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }