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 checks whether the account allows anonymous FTP connections.
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/allows_anonymous_ftp
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Ftp/allows_anonymous_ftp
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Ftp/allows_anonymous_ftpResponse
application/json
{ "apiversion": 3, "func": "allows_anonymous_ftp", "module": "Ftp", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
Request
This function checks whether the account allows inbound anonymous FTP transfers.
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/allows_anonymous_ftp_incoming
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Ftp/allows_anonymous_ftp_incoming
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Ftp/allows_anonymous_ftp_incomingResponse
application/json
{ "apiversion": 3, "func": "allows_anonymous_ftp_incoming", "module": "Ftp", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }
- Mock server
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Ftp/get_ftp_daemon_info
- A server running cPanel.
https://cpanel-server.tld:2083/execute/Ftp/get_ftp_daemon_info
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.docs.cpanel.net/_mock/specifications/cpanel.openapi/Ftp/get_ftp_daemon_infoResponse
application/json
{ "apiversion": 3, "func": "get_ftp_daemon_info", "module": "Ftp", "result": { "data": { … }, "errors": null, "messages": null, "metadata": {}, "status": 1, "warnings": null } }