List

List files and folders in a Dropbox directory.

yaml
type: "io.kestra.plugin.dropbox.files.List"

Examples

List all files and folders in a specific Dropbox directory.

yaml
id: dropbox_list_files
namespace: company.team
tasks:
  - id: list_files_from_dropbox
    type: io.kestra.plugin.dropbox.files.List
    accessToken: "{{ secret('DROPBOX_ACCESS_TOKEN') }}"
    from: "/My Kestra Files/Inputs"
    recursive: true
    fetchType: FETCH

Properties

accessToken *string

Dropbox access token.

fetchType string

Default FETCH

Possible Values

STOREFETCHFETCH_ONENONE

How to fetch the data.

FETCH_ONE: Returns a single row. FETCH: Returns all rows in memory. STORE: Returns all rows in a file stored in Kestra's internal storage.

from object

The path to the directory to list.

Can be a direct path as a string, or a Kestra internal storage URI of a file containing the path.

limit integerstring

Default 2000

The maximum number of files to return.

recursive booleanstring

Default false

Whether to list files recursively in all sub-folders.

Outputs

row DropboxFile

The first file or folder found.

Only populated if fetchType is FETCH_ONE.

rows array

SubType

The list of files and folders.

Only populated if fetchType is FETCH.

size integer

Default 0

uri string

Format uri

The URI of the file in Kestra's internal storage.

Only populated if fetchType is STORE.

Metrics

files.count counter

The number of files and folders found.

Definitions

io.kestra.plugin.dropbox.models.DropboxFile

clientModified string

Format date-time

The last time the file was modified on Dropbox.

id string

The unique ID of the file or folder.

name string

The file or folder name.

path string

The lower-case version of the path for display.

size integer

The file size in bytes.

Null for folders.

type string

The type of the entry.

Can be 'file' or 'folder'.

​List

List