FTP servers (/ftpservers/)
URL: https://[server_name]/api/[api_version]/ftpservers/
This endpoint is used to create, update, edit, and delete FTP servers.
Supported fields
| Field | Display name | Type | Required | Other restrictions |
|---|---|---|---|---|
| name | Name of the FTP server | string | Yes | |
| address | Domain name or IP address of the FTP server | string | Yes | |
| port | Port of the syslog server | integer | Yes | Default is set to "21" |
| username | The username used to login to the FTP server | string | No | |
| password | The password required to login to the FTP server | string | No | |
| conn_type | The type of connection | string | Yes | Either "ftp" or "sftp". The default is "ftp" |
| anonymous | Whether the connection is anonymous or not | boolean | No | Read-only field. |
Allowed methods
| HTTP method | Resource URI | Action |
|---|---|---|
| GET | /api/v1/ftpservers/ | Get all FTP servers |
| GET | /api/v1/ftpservers/[id]/ | Get a specific FTP server with id |
| POST | /api/v1/ftpservers/ | Create a new FTP server |
| PATCH | /api/v1/ftpservers/[id]/ | Update specified fields of an existing FTP server with id |
| DELETE | /api/v1/ftpservers/[id]/ | Delete an FTP server |