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 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 } }
Request
This function lists FTP account information.
Important:
When you disable the FTP role, the system disables this function. For more information, read our How to Use Server Profiles documentation.
Security
BasicAuth
Query
A list of the FTP account types to include in the function's results.
anonymouslogaccessmainsub
If you do not specify this parameter, this function returns all FTP account types.
Note:
- Separate multiple types with the pipe character (
|). - In browser-based calls, use
%7C.
Example: include_acct_types=main|anonymous
A list of the FTP account types to exclude from the function's results.
anonymouslogaccessmainsub
If you do not specify this parameter, this function does not exclude any account types.
Note:
- Separate multiple types with the pipe character (
|). - In browser-based calls, use
%7C.
Example: skip_acct_types=main|anonymous
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Ftp/list_ftp
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Ftp/list_ftp
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Ftp \
list_ftpResponse
application/json
{ "apiversion": 3, "func": "list_ftp", "module": "Ftp", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function lists FTP account and disk usage information.
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/list_ftp_with_disk
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Ftp/list_ftp_with_disk
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Ftp \
list_ftp_with_diskResponse
application/json
{ "apiversion": 3, "func": "list_ftp_with_disk", "module": "Ftp", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }