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/Ftp/ftp_exists
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Ftp/ftp_exists
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Ftp \
ftp_exists \
user='us_chickens'Response
application/json
{ "apiversion": 3, "func": "ftp_exists", "module": "Ftp", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function checks an FTP account's quota.
Important:
When you disable the FTP role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Ftp/get_quota
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Ftp/get_quota
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Ftp \
get_quota \
account='user1'Response
application/json
{ "apiversion": 3, "func": "get_quota", "module": "Ftp", "result": { "data": "unlimited", "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function retrieves the cPanel account's FTP welcome message.
Important:
When you disable the FTP role, the system disables this function.
Security
BasicAuth
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Ftp/get_welcome_message
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Ftp/get_welcome_message
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Ftp \
get_welcome_messageResponse
application/json
{ "apiversion": 3, "func": "get_welcome_message", "module": "Ftp", "result": { "data": "Greetings, Professor Falken.", "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }