YAML for FTP Server

View as Markdown

FTP/FTPS target for file transfer deployments.

YAML parameters for FTP Server

PARAMETERS
hostrequiredstring
The host for the connection
targetrequiredstring
The human-readable ID of the target
secureboolean
Whether connection is secure (SFTP/FTPS)
namestring
The name of the target
portstring
The port for the connection
authFTPAuthYaml
Authentication details
pathstring
Path on the server defined in the target
disabledboolean
Indicates if this target is disabled (default: false)
tagsstring[]
The list of tags associated with the target
permissionsPermissionsYaml
The permissions for the target
use_asUseAsYaml
Defines how the target can be used (as deployment target, proxy, or both)
notestring
Note for this resource
agent_notestring
YAML note for AI agents operating on this resource
typestring

Value: FTP

Last modified on Sep 17, 2026

YAML examples for FTP Server

FTP target with authentication and tags

yaml
- target: myHost type: FTP name: name host: myHost port: "22" auth: username: buddy password: $password path: /path tags: - tag1

Minimal

yaml
- target: amyHost type: FTP name: name host: amyHost port: "22" auth: username: buddy password: $password

Secure

yaml
- target: ftpsHost type: FTP secure: true name: name host: ftpsHost port: "22" auth: username: buddy password: $password