FTP

FTP (ftp)

Upload events to FTP/SFTP/TFTP servers.

File Utility Enterprise edition binary json raw

Minimal example

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

JSON

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

Contents

• Minimal example

• Connection

• Reliability

• Transfer

• Schema

A ✓ marks a field that accepts a context variable such as {{ VARIABLE }}.

Connection

Connection

Field	Type	Required	Description
protocol	Protocol		Transfer protocol to use (ftp, sftp, ftps, or tftp). Allowed values: ftp, ftps-explicit, ftps-implicit, sftp, tftp
endpoint	Endpoint	✅	Remote endpoint settings (host, port, TLS requirements).
credentials	Credentials		Credentials or key material needed to authenticate with the server. Allowed values: username-password, tls-client-cert, ssh-key, anonymous, none
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.

Reliability

Reliability

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.

Transfer

Transfer

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. Default: false
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
• Endpoint Fields
• Credentials - Username Password Fields
• Credentials - Tls Client Cert Fields
• Credentials - Ssh Key Fields
• Ftps Fields
• Sftp - Host Key Verification - Known Hosts File Fields
• Sftp - Host Key Verification - Fingerprint Fields
• Sftp Fields
• Tftp Fields
• Retry - Backoff Fields
• Retry Fields
• Batch Fields
• Metadata Fields
• Checksum Fields
• Protocol Options
• Retry - Backoff - Strategy Options
• Batch - Mode 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

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

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)		Default: false
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)		Default: false
known-hosts-path	string
host-key-verification	Host Key Verification		Allowed values: known-hosts-file, fingerprint, accept-new
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

Retry - Backoff Fields

Field	Type	Required	Description
strategy	Strategy		Backoff strategy to use (default exponential). Allowed values: exponential, linear, fixed
base	string		Base delay before retrying (e.g. “200ms”).
max	string		Maximum delay between retries.
jitter ✓	boolean (bool)		Whether to add jitter to retry delays. Default: false

Retry Fields

Field	Type	Required	Description
max-attempts	number (integer)		Maximum attempts before giving up. Examples: 42, 1.2e-10
forever ✓	boolean (bool)		Retry indefinitely until cancelled. Default: false
backoff	Backoff		Backoff strategy configuration.

Batch Fields

Field	Type	Required	Description
fixed-size ✓	number (integer)		maximum number of events in an output batch. Examples: 42, 1.2e-10
max-bytes ✓	number (integer)		Close the batch before adding an event that would make the serialized request payload exceed this many bytes. 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). 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). Default: false
wrap-as-json ✓	boolean (bool)		Format the output batch as a JSON array. Default: false

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

Checksum Fields

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

Protocol Options

Value	Aliases	Name	Description
ftp		ftp
ftps-explicit		ftps-explicit
ftps-implicit		ftps-implicit
sftp		sftp
tftp		tftp

Retry - Backoff - Strategy Options

Value	Aliases	Name	Description
exponential		exponential
linear		linear
fixed		fixed

Batch - Mode Options

Value	Aliases	Name	Description
fixed		fixed
document		document

Preprocessors Options

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

Payload Mode Options

Value	Aliases	Name	Description
auto		auto
json		json
raw		raw
binary		binary

Checksum - Algorithm Options

Value	Aliases	Name	Description
md5		md5
sha256		sha256