Box Get
CertifiedGet Box file metadata
Box Get
Get Box file metadata
Fetches the metadata of a Box file (name, size, SHA-1, parent folder, timestamps).
type: io.kestra.plugin.box.files.GetExamples
Get the metadata of a Box file.
id: box_get_file
namespace: company.team
tasks:
- id: get
type: io.kestra.plugin.box.files.Get
clientId: "{{ secret('BOX_CLIENT_ID') }}"
clientSecret: "{{ secret('BOX_CLIENT_SECRET') }}"
enterpriseId: "{{ secret('BOX_ENTERPRISE_ID') }}"
fileId: "123456789"
- id: log_name
type: io.kestra.plugin.core.log.Log
message: "File {{ outputs.get.file.name }} is {{ outputs.get.file.size }} bytes"
Properties
fileId *string
File ID
ID of the Box file.
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.
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
file
File metadata
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.
