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 returns whether a cPanel account has a specific Account Enhancement.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/AccountEnhancements/has_enhancement
- A server running cPanel.
https://cpanel-server.tld:2083/execute/AccountEnhancements/has_enhancement
- 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/AccountEnhancements/has_enhancement?id=sample-enhancement-id'Response
application/json
{ "apiversion": 3, "func": "list", "module": "AccountEnhancements", "result": { "data": 1, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/AccountEnhancements/list
- A server running cPanel.
https://cpanel-server.tld:2083/execute/AccountEnhancements/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/AccountEnhancements/listResponse
application/json
{ "apiversion": 3, "func": "list", "module": "AccountEnhancements", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }