Box List
CertifiedList Box folder items
Box List
List Box folder items
Lists the files, folders and web links directly inside a Box folder. fetchType controls memory vs storage output.
type: io.kestra.plugin.box.folders.ListExamples
List a folder and log the count.
id: box_list_folder
namespace: company.team
tasks:
- id: list_items
type: io.kestra.plugin.box.folders.List
clientId: "{{ secret('BOX_CLIENT_ID') }}"
clientSecret: "{{ secret('BOX_CLIENT_SECRET') }}"
enterpriseId: "{{ secret('BOX_ENTERPRISE_ID') }}"
folderId: "123456789"
fetchType: FETCH
- id: log_results
type: io.kestra.plugin.core.log.Log
message: "Found {{ outputs.list_items.size }} items"
Properties
assets
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.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset 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.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150clientId string
Box client ID
clientSecret string
Box client secret
developerToken string
Developer token
Short-lived token for quick tests. Takes priority over other auth.
enterpriseId string
Enterprise ID
Use with CCG to act as the app's service account.
fetchType string
FETCHSTOREFETCHFETCH_ONENONEFetch strategy
FETCH_ONE: first item only.
FETCH (default): all items in memory.
STORE: write items to Kestra storage and return the URI.
folderId string
0Folder ID
0 is the root folder.
jwtConfig string
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.
userId string
User ID
Use with CCG to act as a specific user instead of the enterprise.
Outputs
row
First item
Populated when fetchType is FETCH_ONE.
io.kestra.plugin.box.models.BoxItem
date-timeCreation time
Item ID
date-timeLast modification time
Item name
Parent folder ID
SHA-1 hash
Null for folders.
Size in bytes
Null for folders.
Item type
file, folder or web_link.
rows array
Items
Populated when fetchType is FETCH.
io.kestra.plugin.box.models.BoxItem
date-timeCreation time
Item ID
date-timeLast modification time
Item name
Parent folder ID
SHA-1 hash
Null for folders.
Size in bytes
Null for folders.
Item type
file, folder or web_link.
size integer
0Item count
uri string
uriStored items URI
Populated when fetchType is STORE.
