Box Download

Box Download

Certified

Download a file from Box

Downloads a file from Box to Kestra internal storage and returns its uri.

yaml
type: io.kestra.plugin.box.files.Download

Download a file from Box to Kestra internal storage.

yaml
id: box_download_file
namespace: company.team

tasks:
  - id: download
    type: io.kestra.plugin.box.files.Download
    clientId: "{{ secret('BOX_CLIENT_ID') }}"
    clientSecret: "{{ secret('BOX_CLIENT_SECRET') }}"
    enterpriseId: "{{ secret('BOX_ENTERPRISE_ID') }}"
    fileId: "123456789"

  - id: log_uri
    type: io.kestra.plugin.core.log.Log
    message: "Downloaded {{ outputs.download.file.name }} to {{ outputs.download.uri }}"
Properties

File ID

ID of the Box file to download.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150

Box client ID

Box client secret

Developer token

Short-lived token for quick tests. Takes priority over other auth.

Enterprise ID

Use with CCG to act as the app's service account.

JWT config JSON

Contents of the JSON config file downloaded from the Box developer console. Used when no developer token is set and no client credentials are set.

User ID

Use with CCG to act as a specific user instead of the enterprise.

File metadata

Box metadata of the downloaded file.

Definitions
createdAtstring
Formatdate-time

Creation time

idstring

Item ID

modifiedAtstring
Formatdate-time

Last modification time

namestring

Item name

parentIdstring

Parent folder ID

sha1string

SHA-1 hash

Null for folders.

sizeinteger

Size in bytes

Null for folders.

typestring

Item type

file, folder or web_link.

Formaturi

Downloaded file URI

Location of the file in Kestra internal storage.

More Plugins in this Category

Odoo
Odoo

Tasks that call the Odoo XML-RPC API for ERP automation.

Business

1 tasks

5 blueprints

Twilio
Twilio

Tasks that integrate with the Twilio ecosystem.

BusinessData

9 tasks

4 blueprints