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 creates a new API token with full access to all of a cPanel account's features.
Note:
The token only grants access to the features that the account has access to. For example, if you disable the File Manager feature, the token can't access it.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Tokens/create_full_access
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Tokens/create_full_access
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Tokens \
create_full_access \
name='example'Response
application/json
{ "apiversion": 3, "func": "create_full_access", "module": "Tokens", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Tokens/list
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Tokens/list
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Tokens \
listResponse
application/json
{ "apiversion": 3, "func": "list", "module": "Tokens", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Tokens/rename
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Tokens/rename
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Tokens \
rename \
name='example' \
new_name='newexample'Response
application/json
{ "apiversion": 3, "func": "rename", "module": "Tokens", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }