🚀 New! Kestra raises $3 million to grow Learn more

pluginsplugin-fstaskssftpio.kestra.plugin.fs.sftp.list

​List

List List

yaml
type: "io.kestra.plugin.fs.sftp.List"

List files from a SFTP server directory

Examples

yaml
id: "list"
type: "io.kestra.plugin.fs.sftp.List"
host: localhost
port: 22
username: foo
password: pass
from: "/upload/dir1/"
regExp: ".*\/dir1\/.*\.(yaml|yml)"

Properties

from

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The fully-qualified URIs that point to path

host

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

Hostname of the remote server

keyfile

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Private keyfile in the PEM file format to connect to a remote server using SSH

To generate a PEM format key from OpenSSH, use the following command: ssh-keygen -m PEM

passphrase

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Passphrase of the ssh key

password

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Password on the remote server

port

  • Type: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: 22

Port of the remote server

proxyHost

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

SFTP proxy host

proxyPassword

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

SFTP proxy password

proxyPort

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

SFTP proxy port

proxyType

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

SFTP proxy type

proxyUser

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

SFTP proxy user

recursive

  • Type: boolean
  • Dynamic: ❓
  • Required: ❌
  • Default: false

List file recursively

regExp

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

A regexp to filter on full path

rootDir

  • Type: boolean
  • Dynamic: ✔️
  • Required: ❌
  • Default: true

Is path is relative to root dir

username

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Username on the remote server

Outputs

files

  • Type: array
  • SubType: File

The list of files

Definitions

File

accessDate

  • Type: string
  • Dynamic: ❓
  • Required: ❌

fileType

  • Type: string
  • Dynamic: ❓
  • Required: ❌
  • Possible Values:
    • FOLDER
    • FILE
    • FILE_OR_FOLDER
    • IMAGINARY

flags

  • Type: integer
  • Dynamic: ❓
  • Required: ❌

groupId

  • Type: integer
  • Dynamic: ❓
  • Required: ❌

name

  • Type: string
  • Dynamic: ❓
  • Required: ❌

path

  • Type: string
  • Dynamic: ❓
  • Required: ❌

permissions

  • Type: integer
  • Dynamic: ❓
  • Required: ❌

size

  • Type: integer
  • Dynamic: ❓
  • Required: ❌
  • Type: boolean
  • Dynamic: ❓
  • Required: ❌
  • Default: false

updatedDate

  • Type: string
  • Dynamic: ❓
  • Required: ❌

userId

  • Type: integer
  • Dynamic: ❓
  • Required: ❌