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/
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Resellers/list_accounts
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Resellers/list_accounts
- 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/Resellers/list_accountsResponse
application/json
{ "apiversion": 3, "func": "list_accounts", "module": "Resellers", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Query Examples:
The user configuration variables to retrieve. If you don't use this parameter, this function returns all of the user's configuration data.
Note:
To retrieve multiple account configuration settings for a user, increment the parameter name. For example: name-0, name-1, and name-2.
name=name-1=mailbox_format&name-2=home&name-3=shell
name=mailbox_format
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Variables/get_user_information
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Variables/get_user_information
- 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/Variables/get_user_information?name=domain'Response
application/json
{ "apiversion": 3, "func": "get_user_information", "module": "Variables", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }