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 changes a mailing list's password.
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/passwd_list
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/passwd_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/Email/passwd_list?list=mylist%40example.com&password=12345luggage'Response
application/json
{ "apiversion": 3, "func": "passwd_list", "module": "Email", "result": { "data": null, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/remove_mailman_delegates
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/remove_mailman_delegates
- 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/remove_mailman_delegates?delegates=user%40example.com%2Cadmin%40example.com&list=mylist'Response
application/json
{ "apiversion": 3, "func": "remove_mailman_delegates", "module": "Email", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function modifies a Mailman mailing list's privacy options.
Important:
When you disable the Receive Mail role, the system disables this function.
Security
BasicAuth
Query
Whether the Mailman directory page displays the list.
1- Display.0- Does not display.
Enum01
Example: advertised=1
Whether the mailing list archive is private.
1- Private.0- Public.
Enum01
Example: archive_private=1
The level of control that the mailing list administrator has over new subscribers.
1- Anyone can subscribe. The system sends a confirmation email.2- The administrator must approve subscriptions. The system does not send a confirmation email.3- The administrator must approve subscriptions. The system sends a confirmation email.
Enum123
Example: subscribe_policy=1
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Email/set_list_privacy_options
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Email/set_list_privacy_options
- 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/set_list_privacy_options?advertised=1&archive_private=1&list=mylist&subscribe_policy=1'Response
application/json
{ "apiversion": 3, "func": "set_list_privacy_options", "module": "Email", "result": { "data": null, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }