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 kills FTP sessions.
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/kill_session
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Ftp/kill_session
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Ftp \
kill_sessionResponse
application/json
{ "apiversion": 3, "func": "kill_session", "module": "Ftp", "result": { "data": null, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function lists the FTP server's active sessions.
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_sessions
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Ftp/list_sessions
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Ftp \
list_sessionsResponse
application/json
{ "apiversion": 3, "func": "list_sessions", "module": "Ftp", "result": { "data": [ … ], "errors": null, "messages": null, "metadata": { … }, "status": 1, "warnings": null } }
Request
This function checks whether the server uses ProFTPD or Pure-FTPd.
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/server_name
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Ftp/server_name
- CLI
- URL
- curl
- JavaScript
- Node.js
- Python
- Java
- Java8+Apache
- C#
- C#+Newtonsoft
- PHP
- Go
- Ruby
- R
uapi --output=jsonpretty \
--user=username \
Ftp \
server_nameResponse
application/json
{ "apiversion": 3, "func": "server_name", "module": "Ftp", "result": { "data": "pure-ftpd", "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }