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 all calendar delegates on the cPanel account.
Note:
You must install the Calendar and Contacts Server cPanel plugin to access this API function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/CCS/list_delegates
- A server running cPanel.
https://cpanel-server.tld:2083/execute/CCS/list_delegates
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
CCS \
list_delegatesResponse
application/json
{ "apiversion": 3, "func": "list_delegates", "module": "CCS", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function lists all calendar users on the cPanel account.
Note:
You must install the Calendar and Contacts Server cPanel plugin to access this API function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/CCS/list_users
- A server running cPanel.
https://cpanel-server.tld:2083/execute/CCS/list_users
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
CCS \
list_usersResponse
application/json
{ "apiversion": 3, "func": "list_users", "module": "CCS", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function removes a delegate from another user's calendar.
Note:
You must install the Calendar and Contacts Server cPanel plugin to access this API function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/CCS/remove_delegate
- A server running cPanel.
https://cpanel-server.tld:2083/execute/CCS/remove_delegate
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
CCS \
remove_delegate \
delegator='user1@example.com' \
delegatee='user2@example.com'Response
application/json
{ "apiversion": 3, "func": "remove_delegate", "module": "CCS", "result": { "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }