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/Sitejet/add_api_token
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Sitejet/add_api_token
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Sitejet \
add_api_token \
api_token='d35d8ea651007ccd25f96486cdcdXXXX'Response
application/json
{ "apiversion": 3, "func": "add_api_token", "module": "Sitejet", "result": { "data": {}, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function returns whether a cPanel account can create new subdomains or addon domains.
Note:
Creating a new addon domain is dependent on the creation of subdomains. If the cPanel account has reached its limit for subdomains, you cannot create a new addon domain, even if the limit for addon domains has not been reached.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Sitejet/can_create_domains
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Sitejet/can_create_domains
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Sitejet \
can_create_domainsResponse
application/json
{ "apiversion": 3, "func": "can_create_domains", "module": "Sitejet", "result": { "data": 1, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Sitejet/create_account
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Sitejet/create_account
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Sitejet \
create_accountResponse
application/json
{ "apiversion": 3, "func": "create_account", "module": "Sitejet", "result": { "data": { … }, "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }