Compartilhar via


Box

Box™ is a service that keeps your files safe, synced, and easy to share. Connect to Box to manage your files. You can perform various actions such as upload, update, get, and delete files in Box.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Standard All Power Automate regions except the following:
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   China Cloud operated by 21Vianet
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Microsoft Power Apps Support
Connector Metadata
Publisher Microsoft
Website https://www.box.com/
Privacy policy https://www.box.com/legal/privacypolicy

Box API Status

Please use this resource in order to track Box API outages

Known issues and limitations

  1. The connector does not support Single Sign On (SSO) connections, please use standard connection instead.
  2. Do not confuse File Identifier parameter with the actual file name. Due to Box REST API restrictions invalid file identifiers with the following characters - [\ { } " < >] may lead to connector GetawayTimeout errors.
  3. Each folder in the specified path (Folder Path or File Path), including the root folder must not contain more than 10000 items.
  4. When choosing a file of a folder using file picker, the resulting path may start with '//All Files', for example '//All Files/My Folder/MyFile.txt'. To avoid creating new 'All Files' folder at the root, this path should be manually changed to '/My Folder/MyFile.txt'. For referencing root folder use a single slash, like '//All Files' -> '/'.
  5. Triggers fire on the corresponding event's occurrence almost immediately in most cases, but there could be rare circumstances when the trigger's delay to fire may take up to one day due to underlying API limitations. To learn more, go to (Box Events API). It's recommended to keep a file in a folder for that period. Otherwise, it will not be reported by the trigger logic.
  6. If a file already exists in a folder, then file re-upload with the same name will not be considered as create event but update event.
  7. This connector is no longer a tabular connector and therefore cannot be used as a tabular data source - including for the Excel connector.

General Limits

Name Value
Maximum file size (in MB) 75
Maximum folder items count 10000
Maximum number of megabytes being transferred to/from the connector within a bandwidth time interval (per connection) 1000
Bandwidth time interval (in miliseconds) 60000

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Copy file

Copy a file to a file path in Box.

Create file

Uploads a file to Box.

Delete file

Deletes an existing file from Box.

Extract archive to folder

Extracts an archive file into a folder in Box (example: .zip).

Get file content using id

Retrieves the file content from Box using id.

Get file content using path

Retrieves the file contents from Box using path.

Get file metadata using id

Retrieves the file metadata from Box using file id.

Get file metadata using path

Retrieves the file metadata from Box using path.

List files and folders in folder

Lists the files and folders in a Box folder.

List files and folders in root folder

Lists the files and folders in the Box root folder.

Update file

Updates an existing file in Box.

Copy file

Copy a file to a file path in Box.

Parameters

Name Key Required Type Description
Source Url
source True string

The url to source file.

Destination File Path
destination True string

The destination file path in Box, including target filename.

Overwrite
overwrite boolean

Overwrites the destination file if set to 'true'.

Returns

Blob metadata

Create file

Uploads a file to Box.

Parameters

Name Key Required Type Description
Folder Path
folderPath True string

The folder path to upload the file to Box.

File Name
name True string

The name of the file to create in Box.

File Content
body True binary

The content of the file to upload to Box.

Returns

Blob metadata

Delete file

Deletes an existing file from Box.

Parameters

Name Key Required Type Description
File Id
id True string

The unique identifier of the file to delete from Box.

Extract archive to folder

Extracts an archive file into a folder in Box (example: .zip).

Parameters

Name Key Required Type Description
Source Archive File Path
source True string

The path to the archive file.

Destination Folder Path
destination True string

The path in Box to extract the archive contents.

Overwrite
overwrite boolean

Overwrites the destination files if set to 'true'.

Returns

Get file content using id

Retrieves the file content from Box using id.

Parameters

Name Key Required Type Description
File Id
id True string

The unique identifier of the file in Box.

Infer Content Type
inferContentType boolean

A boolean value (true, false) to infer content-type based on extension.

Returns

The content of the file.

File Content
binary

Get file content using path

Retrieves the file contents from Box using path.

Parameters

Name Key Required Type Description
File Path
path True string

The unique path to the file in Box.

Infer Content Type
inferContentType boolean

A boolean value (true, false) to infer content-type based on extension.

Returns

The content of the file.

File Content
binary

Get file metadata using id

Retrieves the file metadata from Box using file id.

Parameters

Name Key Required Type Description
File Id
id True string

The unique identifier of the file in Box.

Returns

Blob metadata

Get file metadata using path

Retrieves the file metadata from Box using path.

Parameters

Name Key Required Type Description
File Path
path True string

The unique path to the file in Box.

Returns

Blob metadata

List files and folders in folder

Lists the files and folders in a Box folder.

Parameters

Name Key Required Type Description
Folder Id
id True string

The unique identifier of the folder in Box.

Returns

List files and folders in root folder

Lists the files and folders in the Box root folder.

Returns

Update file

Updates an existing file in Box.

Parameters

Name Key Required Type Description
File Id
id True string

The unique identifier of the file to update in Box.

File Content
body True binary

The content of the file to update in Box.

Returns

Blob metadata

Triggers

When a file is created (properties only) (V2)

This operation triggers a flow when a new file is created in a folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created. In case when 'Split On' option is turned off for Trigger->Settings successful trigger runs may produce empty array for 'List of Files' output.

When a file is created (properties only) [DEPRECATED]

This action has been deprecated. Please use When a file is created (properties only) (V2) instead.

This operation triggers a flow when a new file is created in a folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.

When a file is created [DEPRECATED]

Triggers a flow when a new file is created in a Box folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.

When a file is modified (properties only)

This operation triggers a flow when a file is modified in a folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.

When a file is modified (properties only) (V2) (Preview)

This operation triggers a flow when a file is modified in a folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created. In case when 'Split On' option is turned off for Trigger->Settings successful trigger runs may produce empty array for 'List of Files' output.

When a file is modified [DEPRECATED]

Triggers a flow when a file is modified in a Box folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.

When a file is created (properties only) (V2)

This operation triggers a flow when a new file is created in a folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created. In case when 'Split On' option is turned off for Trigger->Settings successful trigger runs may produce empty array for 'List of Files' output.

Parameters

Name Key Required Type Description
Folder
folderId True string

The unique identifier of the folder.

Number of files to return
maxFileCount integer

Maximum number of files to return by single trigger run (1-100). Note that 'Split On' setting can force trigger to process each item individually.

Returns

Blob metadata

List of Files
BlobMetadata

When a file is created (properties only) [DEPRECATED]

This action has been deprecated. Please use When a file is created (properties only) (V2) instead.

This operation triggers a flow when a new file is created in a folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.

Parameters

Name Key Required Type Description
Folder
folderId True string

The unique identifier of the folder.

Number of files to return
maxFileCount integer

Maximum number of files to return by single trigger run (1-100). Note that 'Split On' setting can force trigger to process each item individually.

Returns

Blob metadata

List of Files
BlobMetadata

When a file is created [DEPRECATED]

Triggers a flow when a new file is created in a Box folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.

Parameters

Name Key Required Type Description
Folder Id
folderId True string

The unique identifier of the folder in Box.

Infer Content Type
inferContentType boolean

A boolean value (true, false) to infer content-type based on extension.

Returns

The content of the file.

File Content
binary

When a file is modified (properties only)

This operation triggers a flow when a file is modified in a folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.

Parameters

Name Key Required Type Description
Folder
folderId True string

Select a folder

Number of files to return
maxFileCount integer

Maximum number of files to return by single trigger run (1-100). Note that 'Split On' setting can force trigger to process each item individually.

Returns

Blob metadata

List of Files
BlobMetadata

When a file is modified (properties only) (V2) (Preview)

This operation triggers a flow when a file is modified in a folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created. In case when 'Split On' option is turned off for Trigger->Settings successful trigger runs may produce empty array for 'List of Files' output.

Parameters

Name Key Required Type Description
Folder
folderId True string

Select a folder

Number of files to return
maxFileCount integer

Maximum number of files to return by single trigger run (1-100). Note that 'Split On' setting can force trigger to process each item individually.

Returns

Blob metadata

List of Files
BlobMetadata

When a file is modified [DEPRECATED]

Triggers a flow when a file is modified in a Box folder. The trigger does not fire if a file is added/updated in a subfolder. If it is required to trigger on subfolders, multiple triggers should be created.

Parameters

Name Key Required Type Description
Folder Id
folderId True string

The unique identifier of the folder in Box.

Infer Content Type
inferContentType boolean

A boolean value (true, false) to infer content-type based on extension.

Returns

The content of the file.

File Content
binary

Definitions

BlobMetadata

Blob metadata

Name Path Type Description
Id
Id string

The unique id of the file or folder.

Name
Name string

The name of the file or folder.

DisplayName
DisplayName string

The display name of the file or folder.

Path
Path string

The path of the file or folder.

LastModified
LastModified date-time

The date and time the file or folder was last modified.

Size
Size integer

The size of the file or folder.

MediaType
MediaType string

The media type of the file or folder.

IsFolder
IsFolder boolean

A boolean value (true, false) to indicate whether or not the blob is a folder.

ETag
ETag string

The etag of the file or folder.

FileLocator
FileLocator string

The filelocator of the file or folder.

LastModifiedBy
LastModifiedBy string

The user who last modified the file or folder.

binary

This is the basic data type 'binary'.