Ftp

Ftp (ftp)

Upload events to FTP/SFTP/TFTP servers.

File Utility binary json raw

Minimal example

output:
  ftp:
    endpoint:
      host: ~
    path: ~

JSON

{
  "output": {
    "ftp": {
      "endpoint": {
        "host": null
      },
      "path": null
    }
  }
}

Contents

• Minimal example

• Fields

• Reliability

• Connection

• Transfer

• Schema

Fields

Field	Type	Required	Description
endpoint Connection	Endpoint	✅	Remote endpoint settings (host, port, TLS requirements).
path Transfer	string	✅	Remote path or prefix (may include variables) where files are written.
retry Reliability	Retry		Retry policy to apply when uploads fail or time out.
batch Reliability	Batch		Batch multiple events into a single transfer when supported by the target.
protocol Connection	Protocol		Transfer protocol to use (ftp, sftp, ftps, or tftp). Allowed values: ftp, ftps-explicit, ftps-implicit, sftp, tftp
credentials Connection	Credentials		Credentials or key material needed to authenticate with the server.
working-directory Connection	string		Optional working directory to CWD into before writing files.
metadata Transfer	Metadata		Extra metadata columns to include with each upload event.
concurrency Transfer	number (integer)		Maximum number of files to transfer concurrently. Examples: 42, 1.2e-10
tmp-suffix Transfer	string		Temporary suffix applied to files while uploading; removed after completion.
passive Connection	boolean (bool)		Enable passive FTP data connections when required by firewalls.
ftps Connection	Ftps		FTPS-specific options (TLS certificates, modes) when protocol is FTPS.
sftp Connection	Sftp		SFTP-specific options (key paths, algorithms) when using SSH-based transfer.
tftp Connection	Tftp		TFTP-specific options such as blksize tuning.
preprocessors Transfer	Preprocessors[]		Output preprocessors to run before writing data (for example compression). Allowed values: gzip, parquet, base64
payload-mode Transfer	Payload Mode		Payload mode describing how bytes are emitted (auto/json/raw/binary). Allowed values: auto, json, raw, binary
resume-checkpoint-variable Reliability	string		Name of the variable used to persist resume checkpoints between runs.
append Transfer	boolean (bool)		Append to existing remote files instead of overwriting them.
checksum Transfer	Checksum		Checksum verification strategy applied after a transfer completes.
stream-buffer-size Transfer	number (integer)		Size of the in-memory buffer used during streaming uploads. Examples: 42, 1.2e-10

Reliability

Show fields

Field	Type	Required	Description
retry	Retry		Retry policy to apply when uploads fail or time out.
batch	Batch		Batch multiple events into a single transfer when supported by the target.
resume-checkpoint-variable	string		Name of the variable used to persist resume checkpoints between runs.

Connection

Show fields

Field	Type	Required	Description
endpoint	Endpoint	✅	Remote endpoint settings (host, port, TLS requirements).
protocol	Protocol		Transfer protocol to use (ftp, sftp, ftps, or tftp). Allowed values: ftp, ftps-explicit, ftps-implicit, sftp, tftp
credentials	Credentials		Credentials or key material needed to authenticate with the server.
working-directory	string		Optional working directory to CWD into before writing files.
passive	boolean (bool)		Enable passive FTP data connections when required by firewalls.
ftps	Ftps		FTPS-specific options (TLS certificates, modes) when protocol is FTPS.
sftp	Sftp		SFTP-specific options (key paths, algorithms) when using SSH-based transfer.
tftp	Tftp		TFTP-specific options such as blksize tuning.

Transfer

Show fields

Field	Type	Required	Description
path	string	✅	Remote path or prefix (may include variables) where files are written.
metadata	Metadata		Extra metadata columns to include with each upload event.
concurrency	number (integer)		Maximum number of files to transfer concurrently. Examples: 42, 1.2e-10
tmp-suffix	string		Temporary suffix applied to files while uploading; removed after completion.
preprocessors	Preprocessors[]		Output preprocessors to run before writing data (for example compression). Allowed values: gzip, parquet, base64
payload-mode	Payload Mode		Payload mode describing how bytes are emitted (auto/json/raw/binary). Allowed values: auto, json, raw, binary
append	boolean (bool)		Append to existing remote files instead of overwriting them.
checksum	Checksum		Checksum verification strategy applied after a transfer completes.
stream-buffer-size	number (integer)		Size of the in-memory buffer used during streaming uploads. Examples: 42, 1.2e-10

Schema

• Credentials Options
• Sftp - Host Key Verification Options
• Retry Fields
• Batch Fields
• Endpoint Fields
• Credentials - Username Password Fields
• Credentials - Tls Client Cert Fields
• Credentials - Ssh Key Fields
• Metadata Fields
• Ftps Fields
• Sftp - Host Key Verification - Known Hosts File Fields
• Sftp - Host Key Verification - Fingerprint Fields
• Sftp Fields
• Tftp Fields
• Checksum Fields
• Batch - Mode Options
• Protocol Options
• Preprocessors Options
• Payload Mode Options
• Checksum - Algorithm Options

Credentials Options

Option	Name	Type	Description
username-password	Username Password	object
tls-client-cert	Tls Client Cert	object
ssh-key	Ssh Key	object
anonymous	Anonymous	map
none	None	map

Sftp - Host Key Verification Options

Option	Name	Type	Description
known-hosts-file	Known Hosts File	object
fingerprint	Fingerprint	object
accept-new	Accept New	map

Retry Fields

Field	Type	Required	Description
timeout	time-interval (string)	✅	timeout (e.g. 500ms, 2s etc. - default is 30). Examples: 500ms, 2h
retries	number (integer)		number of retries. Examples: 42, 1.2e-10

Batch Fields

Field	Type	Required	Description
fixed-size	number (integer)		maximum number of events in an output batch. Examples: 42, 1.2e-10
mode	Mode	✅	If ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size. Allowed values: fixed, document
timeout	time-interval (string)	✅	interval after which the batch is sent, to keep throughput going (default 100ms). Examples: 500ms, 2h
header	multiline-text (string)		put a header line before the batch.
footer	multiline-text (string)		put a header line after the last line of the batch.
use-document-marker	boolean (bool)		Enrich the job metadata with a document marker (for document handling in batch mode).
wrap-as-json	boolean (bool)		Format the output batch as a JSON array.

Endpoint Fields

Field	Type	Required	Description
host	string	✅
port	number (integer)		Examples: 42, 1.2e-10
proxy	string
bastion-host	string

Credentials - Username Password Fields

Field	Type	Required	Description
username-variable	string	✅
password-variable	string	✅

Credentials - Tls Client Cert Fields

Field	Type	Required	Description
username-variable	string	✅
password-variable	string	✅
client-certificate-variable	string	✅
client-key-variable	string	✅

Credentials - Ssh Key Fields

Field	Type	Required	Description
username-variable	string	✅
private-key-variable	string	✅
passphrase-variable	string

Metadata Fields

Field	Type	Required	Description
object-name-field	field (string)		Examples: data_field
content-length-field	field (string)		Examples: data_field
last-modified-field	field (string)		Examples: data_field
checksum-field	field (string)		Examples: data_field
content-type-field	field (string)		Examples: data_field
etag-field	field (string)		Examples: data_field

Ftps Fields

Field	Type	Required	Description
ca-certificate-variable	string
client-certificate-variable	string
client-key-variable	string
cipher-list	string
verify-peer	boolean (bool)
min-tls-version	string

Sftp - Host Key Verification - Known Hosts File Fields

Field	Type	Required	Description
path	path (string)	✅	Examples: /path/to/file, c:\users\joe\data\file.txt

Sftp - Host Key Verification - Fingerprint Fields

Field	Type	Required	Description
fingerprint	string	✅

Sftp Fields

Field	Type	Required	Description
agent-forwarding	boolean (bool)
known-hosts-path	string
host-key-verification	Host Key Verification
jump-host	string

Tftp Fields

Field	Type	Required	Description
block-size	number (integer)		Examples: 42, 1.2e-10
timeout-ms	number (integer)		Examples: 42, 1.2e-10
max-retries	number
file-name	string

Checksum Fields

Field	Type	Required	Description
verify-remote	boolean (bool)
algorithm	Algorithm	✅	Allowed values: md5, sha256

Batch - Mode Options

Value	Description
fixed	Fixed
document	Document

Protocol Options

Value	Description
ftp	Ftp
ftps-explicit	Ftps Explicit
ftps-implicit	Ftps Implicit
sftp	Sftp
tftp	Tftp

Preprocessors Options

Value	Description
gzip	Gzip the output data
parquet	Extract the received data as JSON rows from a parquet file
base64	Decode base64 as binary

Payload Mode Options

Value	Description
auto	Auto
json	Json
raw	Raw
binary	Binary

Checksum - Algorithm Options

Value	Description
md5	Md5
sha256	Sha256