# cPanel Ftp API

**Canonical:** https://apis.io/apis/cpanel/cpanel-ftp-api/  
**Provider:** cPanel — https://apis.io/providers/cpanel/  
**Base URL:** https://{host}:2083/execute  
**Documentation:** https://api.docs.cpanel.net/cpanel/introduction/

cPanel Ftp API is one of 144 APIs that [cPanel](https://apis.io/providers/cpanel/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include FTP. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

The FTP module for UAPI.

## Operations (20)

| Method | Path | Summary |
|---|---|---|
| GET | `/Ftp/add_ftp` | Create FTP account |
| GET | `/Ftp/allows_anonymous_ftp` | Return if anonymous FTP connections allowed |
| GET | `/Ftp/allows_anonymous_ftp_incoming` | Return if anonymous FTP transfers allowed |
| GET | `/Ftp/delete_ftp` | Delete FTP account |
| GET | `/Ftp/ftp_exists` | Return whether an FTP account exists |
| GET | `/Ftp/get_ftp_daemon_info` | Return FTP server's information |
| GET | `/Ftp/get_port` | Return FTP server's port |
| GET | `/Ftp/get_quota` | Return FTP account's quota |
| GET | `/Ftp/get_welcome_message` | Return FTP account's welcome message |
| GET | `/Ftp/kill_session` | Stop FTP session |
| GET | `/Ftp/list_ftp` | Return FTP accounts |
| GET | `/Ftp/list_ftp_with_disk` | Return FTP accounts and disk usage |
| GET | `/Ftp/list_sessions` | Return FTP server's active sessions |
| GET | `/Ftp/passwd` | Update FTP account's password |
| GET | `/Ftp/server_name` | Return whether server uses ProFTPD or Pure-FTPd |
| GET | `/Ftp/set_anonymous_ftp` | Enable or disable anonymous FTP logins |
| GET | `/Ftp/set_anonymous_ftp_incoming` | Enable or disable anonymous incoming FTP transfers |
| GET | `/Ftp/set_homedir` | Update FTP account's home directory |
| GET | `/Ftp/set_quota` | Update FTP account's quota |
| GET | `/Ftp/set_welcome_message` | Update FTP welcome message |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cpanel/refs/heads/main/openapi/cpanel-ftp-api-openapi.yml
- **Documentation** — https://api.docs.cpanel.net/cpanel/introduction/
- **APIReference** — https://api.docs.cpanel.net/specifications/cpanel.openapi
- **Authentication** — https://api.docs.cpanel.net/cpanel/tokens/
- **Documentation** — https://api.docs.cpanel.net/whm/introduction/
- **APIReference** — https://api.docs.cpanel.net/specifications/whm.openapi
- **Authentication** — https://api.docs.cpanel.net/whm/tokens/

## Other cPanel APIs (12)

- [cPanel API 2 (Legacy)](https://apis.io/apis/cpanel/cpanel-api-2/)
- [Manage2 API](https://apis.io/apis/cpanel/manage2/)
- [cPanel 360 Monitoring API](https://apis.io/apis/cpanel/cpanel-360-monitoring-api/)
- [cPanel Account Creation API](https://apis.io/apis/cpanel/cpanel-account-creation-api/)
- [cPanel Account Enhancements API](https://apis.io/apis/cpanel/cpanel-account-enhancements-api/)
- [cPanel Account Management API](https://apis.io/apis/cpanel/cpanel-account-management-api/)
- [cPanel Account Restoration API](https://apis.io/apis/cpanel/cpanel-account-restoration-api/)
- [cPanel Accounts API](https://apis.io/apis/cpanel/cpanel-accounts-api/)
- [cPanel Addon Domain API](https://apis.io/apis/cpanel/cpanel-addondomain-api/)
- [cPanel API Execution API](https://apis.io/apis/cpanel/cpanel-api-execution-api/)
- [cPanel Applications API](https://apis.io/apis/cpanel/cpanel-applications-api/)
- [cPanel Authentication API](https://apis.io/apis/cpanel/cpanel-authentication-api/)

## Tags

FTP

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/cpanel/cpanel-ftp-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/cpanel/.