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/Market/get_all_products
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Market/get_all_products
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Market \
get_all_productsResponse
application/json
product_group=ssl_certificate
{ "apiversion": 3, "func": "get_all_products", "module": "Market", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Market/get_login_url
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Market/get_login_url
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Market \
get_login_url \
provider='cPStore' \
url_after_login='http://hostname.example.com/redirectionlocation.cgi?state'Response
application/json
{ "apiversion": 3, "func": "get_login_url", "module": "Market", "result": { "data": "https://example.com/api/?client_id=MyHearseIsAmazing&function=login&module=bogoSSL&redirect_uri=https%3A%2F%2Fqaportal.cpanel.net%2Fbogus.cgi&response_type=token", "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Market/get_providers_list
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Market/get_providers_list
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Market \
get_providers_listResponse
application/json
{ "apiversion": 3, "func": "get_providers_list", "module": "Market", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }