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/Team/get_team_users_with_roles_count
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Team/get_team_users_with_roles_count
- 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/Team/get_team_users_with_roles_countResponse
application/json
{ "apiversion": 3, "func": "get_team_users_with_roles_count", "module": "Team", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Team/list_team
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Team/list_team
- 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/Team/list_team?format=array'Response
application/json
{ "apiversion": 3, "func": "list_team", "module": "Team", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Team/password_reset_request
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Team/password_reset_request
- 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/Team/password_reset_request?user=teamuser'Response
application/json
{ "apiversion": 3, "func": "password_reset_request", "module": "Team", "result": { "data": {}, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }