To interact with a Box® drive, add a step in a chain that uses a Box connection command. For example:
- Upload, download, move, search, or delete files
- Create and delete folders
- Fetch file and folder URLs
To enable these commands, an IT admin first creates a Box connector.
Copy file
To copy a file in Box, use a Copy file command.
Equivalent API call: https://developer.box.com/reference/post-file-requests-id-copy/
Properties
| Property |
Detail |
| File ID |
Enter the ID of the file to copy. |
| File name |
Enter the name of the file to copy. Optional if you enter File ID. |
| Parent folder name |
Enter the name of the folder that contains the file to copy. Optional if you enter File ID. |
| Destination folder ID |
Enter the ID of the destination folder to copy the file to (optional). For the root, enter 0. |
| Destination folder name |
Enter the name of the folder to copy to. Optional if you enter Destination Folder ID. |
| Name |
To rename the copy of the file, enter its name (optional). |
Outputs
| Output |
Output type |
| File |
JSON |
| File ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Copy folder
To copy a folder in Box, use a Copy folder command.
Equivalent API call: https://developer.box.com/guides/folders/single/copy/
Properties
| Property |
Detail |
| Folder ID |
Enter the ID of the folder to copy. |
| Folder name |
Enter the name of the folder to copy. Optional if you enter Folder ID. |
| Destination folder ID |
Enter the ID of the folder to save the copy to. |
| Destination folder name |
Enter the name of the folder to save the copy to. Optional if you enter Destination Folder ID. |
| New folder name |
To rename the copy of the file, enter its name (optional). |
Outputs
| Output |
Output type |
| Folder |
JSON |
| Folder ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Create folder
To create a folder in Box, use a Create folder command.
Equivalent API call: https://developer.box.com/guides/folders/single/create/
Properties
| Property |
Detail |
| Folder name |
Enter the name of the new folder. |
| Destination folder ID |
Enter the ID of the destination folder. For the root, enter 0. |
| Destination folder name |
Enter the name of the destination folder (optional). |
Outputs
| Output |
Output type |
| Folder |
JSON |
| Folder ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Delete file
To delete a file in Box, use a Delete file command.
Equivalent API call: https://developer.box.com/guides/file-requests/delete/
Properties
| Property |
Detail |
| File ID |
Enter the ID of the file to delete |
| File name |
Enter the name of the file to delete. Optional if you enter File ID. |
| Parent folder name |
Enter the name of the folder that contains the file to delete. Optional if you enter File ID. |
Outputs
| Output |
Output type |
| File ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Delete folder
To delete a folder in Box, use a Delete folder command.
Equivalent API call: https://developer.box.com/guides/folders/single/delete/
Inputs
Properties
| Property |
Detail |
| Folder ID |
Enter the ID of the folder to delete |
| Folder name |
Enter the name of the folder to delete. Optional if you enter Folder ID. |
| Parent folder name |
Enter the name of the folder that contains the folder to delete. Optional if you enter Folder ID. |
| Recursive |
To delete folders recursively if they contain items, check this box. |
Outputs
| Output |
Output type |
| Folder ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Download file
To download a file from Box, use a Download file command.
Equivalent API call: https://developer.box.com/guides/downloads/file/
Properties
| Property |
Detail |
| File ID |
Enter the ID of the file to download. |
| File name |
Enter the name of the file to download. Optional if you enter File ID. |
| Parent folder name |
Enter the name of the folder that contains the file to download. Optional if you enter File ID. |
Outputs
| Output |
Output type |
| Lines |
Integer |
| File |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Get file info
To retrieve metadata about a file in Box, use a Get file info command.
Equivalent API call: https://developer.box.com/reference/get-files-id/
Properties
| Property |
Detail |
| File ID |
Enter the ID of the file to look up metadata for. |
| File name |
Enter the name of the file to look up metadata for. Optional if you enter File ID. |
| Parent folder name |
Enter the name of the folder that contains the file to look up metadata for. Optional if you enter File ID. |
Outputs
| Output |
Output type |
| File info |
JSON |
| File ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Get folder info
To retrieve metadata about a folder in Box, use a Get folder info command.
Equivalent API call: https://developer.box.com/reference/get-folders-id/
Properties
| Property |
Detail |
| Folder ID |
Enter the ID of the folder to get metadata for. |
| Folder name |
Enter the name of the folder to get metadata for. Optional if you enter Folder ID. |
Outputs
| Output |
Output type |
| Folder info |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Get folder items
To retrieve all items within a folder in Box, use a Get folder items command.
Equivalent API call: https://developer.box.com/reference/get-folders-id-items/
Properties
| Property |
Detail |
| Folder ID |
Enter the ID of the folder to retrieve items from. |
| Folder name |
Enter the name of the folder to retrieve items from. Optional if you enter Folder ID. |
| Parent folder name |
Enter the name of the folder that contains the folder to retrieve items from. Optional if you enter Folder ID. |
| Direction |
Select the sort order for folder items. |
| Limit |
Enter the limit for returned entries. |
Outputs
| Output |
Output type |
| Total |
Integer |
| Entries |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Search
To search for an object in Box, use a Search command.
Equivalent API call: https://developer.box.com/guides/search/
Properties
| Property |
Detail |
| Query |
Enter the search query. |
| File extensions |
Enter the file extensions to limit the search results to. |
| Type |
Select the type of objects to look for. For all types, leave blank. |
| Limit |
Enter the number of results to return. |
Outputs
| Output |
Output type |
| Entries |
JSON |
| Total |
Integer |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Update file info
To update the name, description, or parent folder of a file in Box, use an Update file info command.
Equivalent API call: https://developer.box.com/guides/file-requests/update/
Properties
| Property |
Detail |
| File ID |
Enter the ID of the file to update. |
| File name |
Enter the name of the file to update. Optional if you enter File ID. |
| Parent folder name |
Enter the name of the folder that contains the file to update. Optional if you enter File ID. |
| Name |
Enter the new name of the file. |
| Description |
Enter the description of the file. |
| Destination folder ID |
Enter the ID of the folder to move the file to (optional). |
| Destination folder name |
Enter the name of the folder to move the file to. Optional if you enter Destination Folder ID. |
Outputs
| Output |
Output type |
| File |
JSON |
| File ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Update folder
To update the name, description, or parent folder of a folder in Box, use an Update folder command.
Equivalent API call: https://developer.box.com/reference/put-folders-id/
Properties
| Property |
Detail |
| Folder ID |
Enter the ID of the folder to update. |
| Folder name |
Enter the name of the folder to update. Optional if you enter Folder ID. |
| Destination folder ID |
Enter the ID of the folder to move the folder to (optional). For the root, enter 0. |
| Destination folder name |
Enter the name of the folder to move the folder to. Optional if you enter Destination Folder ID. |
| Name |
Enter the new name of the folder. |
| Description |
Enter the description of the folder. |
Outputs
| Output |
Output type |
| Folder |
JSON |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Upload file
To upload a file to Box, use an Upload file command.
Equivalent API call: https://developer.box.com/guides/file-requests/update/
Properties
| Property |
Detail |
| File |
Enter the file to upload. |
| Destination folder ID |
Enter the ID of the destination folder to store the file. |
| Destination folder name |
Enter the name of the destination folder to store the file. Optional if you enter Destination folder ID. |
| Name |
Enter the new name of the file. |
Outputs
| Output |
Output type |
| File |
JSON |
| File ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |
Upload file version
To upload a new version of a file to Box, use an Upload file version command.
Equivalent API call: https://developer.box.com/guides/uploads/direct/file-version/
Properties
| Property |
Detail |
| File |
Enter the file to upload a new version of. |
| File ID |
Enter the ID of the file to create a new version of. |
| Name |
Enter the name of the file to upload a new version of. Optional if you enter File ID. |
| Parent folder name |
Enter the name of the folder that contains the file to upload a new version of. Optional if you enter File ID. |
Outputs
| Output |
Output type |
| Lines |
Integer |
| File |
JSON |
| File ID |
String |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
There was an error |