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 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 } }
Request
This function retrieves a domain's default address.
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/list_default_address
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/list_default_address
- 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_default_address?user=user&domain=example.com'Response
application/json
{ "apiversion": 3, "func": "list_default_address", "module": "Email", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function lists the account's mail domains.
Important:
When you disable the Receive Mail role, the system disables this function.
Note:
This function always returns the account's main domain first.
Additional Note:
By default, temporary domains (*.cpanel.site) are excluded. Use the return_temporary_domain parameter to include them.
Security
BasicAuth
Query
Whether to list www. addresses.
1— Listwww.addresses.0— Do not listwww.addresses. For example, if you specify1, the function's output would include bothexample.comandwww.example.com. If you specify0, the output would include onlyexample.com.
Default 0
Enum01
Example: add_www=1
Whether to list wildcard addresses.
1— List wildcard addresses.0— Do not list wildcard addresses. For example, if you specify1, the function's output would include bothexample.comand*.example.com. If you specify0, the output would include onlyexample.com.
Default 0
Enum01
Example: include_wildcard=1
Whether to include temporary domains (*.cpanel.site) in the output. By default, temporary domains are excluded.
Default false
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/list_mail_domains
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/list_mail_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/Email/list_mail_domains?add_www=1&include_wildcard=1&return_temporary_domain=false&select=example.com'Response
application/json
{ "apiversion": 3, "func": "list_mail_domains", "module": "Email", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }