Puts content to a Box folder.

Additional Details...


box, storage, put


In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Box Client Servicebox-client-serviceController Service API:
Implementation: JsonConfigBasedBoxClientService
Controller Service used to obtain a Box API connection.
Folder IDbox-folder-idThe ID of the folder where the file is uploaded. Please see Additional Details to obtain Folder ID.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Subfolder Namesubfolder-nameThe name (path) of the subfolder where files are uploaded. The subfolder name is relative to the folder specified by 'Folder ID'. Example: subFolder, subFolder1/subfolder2
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Create Subfoldercreate-folderfalse
  • true
  • false
Specifies whether to check if the subfolder exists and to automatically create it if it does not. Permission to list folders is required.

This Property is only considered if the [Subfolder Name] Property has a value specified.
Filenamefile-name${filename}The name of the file to upload to the specified Box folder.
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
Conflict Resolution Strategyconflict-resolution-strategyfail
  • fail Handle file conflict as failure.
  • ignore Ignore conflict, do not change the original file.
  • replace Replace existing file in case of conflict.
Indicates what should happen when a file with the same name already exists in the specified Box folder.
Chunked Upload Thresholdchunked-upload-threshold20 MBThe maximum size of the content which is uploaded at once. FlowFiles larger than this threshold are uploaded in chunks. Chunked upload is allowed for files larger than 20 MB. It is recommended to use chunked upload for files exceeding 50 MB.


successFiles that have been successfully written to Box are transferred to this relationship.
failureFiles that could not be written to Box for some reason are transferred to this relationship.

Reads Attributes:

filenameUses the FlowFile's filename as the filename for the Box object.

Writes Attributes:

box.idThe id of the file
filenameThe name of the file
pathThe folder path where the file is located
box.sizeThe size of the file
box.timestampThe last modified time of the file
error.codeThe error code returned by Box
error.messageThe error message returned by Box

State management:

This component does not store state.


This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

See Also:

ListBoxFile, FetchBoxFile