Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 26. FTPS Sink

Send data to an FTPS server.

In the header, you can set the file / ce-file property to specify the filename to upload.

If you do not set the property in the header, the Kamelet uses the exchange ID for the filename.

26.1. Configuration Options
Copy link

The following table summarizes the configuration options available for the ftps-sink Kamelet:

Expand
PropertyNameDescriptionTypeDefaultExample

connectionHost *

Connection Host

The hostname of the FTP server.

string

  

connectionPort *

Connection Port

The port of the FTP server.

string

21

 

directoryName *

Directory Name

The starting directory.

string

  

password *

Password

The password to access the FTP server.

string

  

username *

Username

The username to access the FTP server.

string

  

autoCreate

Autocreate Missing Directories

Automatically create the directory the files should be written to.

boolean

True

 

binary

Binary

Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).

boolean

False

 

fileExist

File Existence

Specifies how the Kamelet behaves if the file already exists.

string

Override

 

passiveMode

Passive Mode

Set the passive mode connection.

boolean

False

 

* = Fields marked with an asterisk are mandatory.

26.2. Dependencies
Copy link

26.2.1. Quarkus dependencies
Copy link

<dependencies>
  <dependency>
    <groupId>org.apache.camel.kamelets</groupId>
    <artifactId>camel-kamelets-utils</artifactId>
    <version>4.8.5</version>
  </dependency>
  <dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-core</artifactId>
  </dependency>
  <dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-ftp</artifactId>
  </dependency>
  <dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-kamelet</artifactId>
  </dependency>
</dependencies>

26.3. Usage
Copy link

26.3.1. Camel JBang usage
Copy link

26.3.1.1. Prerequisites for JBang
Copy link

  • Install JBang.

  • You have executed the following command: 

    jbang app install camel@apache/camel

26.3.1.2. Running a route with JBang
Copy link

Suppose you have a file named route.yaml with this content: 

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command. 

camel run route.yaml

26.3.2. Knative Sink
Copy link

You can use the ftps-sink Kamelet as a Knative sink by binding it to a Knative object.

ftps-sink-binding.yaml

apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: ftps-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: ftps-sink
    properties:
      connectionHost: "The Connection Host"
      directoryName: "The Directory Name"
      password: "The Password"
      username: "The Username"

26.3.3. Kafka Sink
Copy link

You can use the ftps-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

ftps-sink-binding.yaml

apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: ftps-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: ftps-sink
    properties:
      connectionHost: "The Connection Host"
      directoryName: "The Directory Name"
      password: "The Password"
      username: "The Username"

26.4. Kamelets source file
Copy link

https://github.com/jboss-fuse/camel-kamelets/blob/camel-kamelets-4.10.3-branch/kamelets/ftps-sink.kamelet.yaml

Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Legal Notice

Theme

© 2026 Red HatBack to top