Box Delete

Box Delete

Certified

Delete a file from Box

Deletes a file from Box.

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

Delete a file from Box.

yaml
id: box_delete_file
namespace: company.team

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

  - id: log_result
    type: io.kestra.plugin.core.log.Log
    message: "Deleted file {{ outputs.delete.fileId }}"
Properties

File ID

ID of the Box file to delete.

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.

Deleted file ID