Box

Description

Interact with the Box API

Component key: box

Authorization Methods

Box requires one of the following authorization methods.

KeyNameDescription
api_keyAPI KeyAPI authorization based on an API key
oauth2OAuth 2.0OAuth 2.0 authorization using an OAuth 2 flow

Actions

Copy Object

Copy a Folder or File from one path to another

Action key: copyObject

Inputs

KeyTypeDefaultRequiredComments
fromPathSTRINGNoneTrueThe path to the source object, typically starts with /
toPathSTRINGNoneTrueThe path to the destination object, typically starts with /

Create Folder

Create a Folder at the specified path

Action key: createFolder

Inputs

KeyTypeDefaultRequiredComments
pathSTRINGNoneTrueThe location of the object, typically starts with /

Delete Object

Delete a Folder or File at the specified path

Action key: deleteObject

Inputs

KeyTypeDefaultRequiredComments
pathSTRINGNoneTrueThe location of the object, typically starts with /

Download File

Download the file at the specified path

Action key: downloadFile

Inputs

KeyTypeDefaultRequiredComments
pathSTRINGNoneTrueThe location of the object, typically starts with /

Get File Download URL

Get a URL to download the file at the specified path

Action key: getFileDownloadUrl

Inputs

KeyTypeDefaultRequiredComments
pathSTRINGNoneTrueThe location of the object, typically starts with /

List Folder

List Folder contents at the specified path

Action key: listFolder

Inputs

KeyTypeDefaultRequiredComments
pathSTRINGNoneTrueThe location of the object, typically starts with /

Move Object

Move a Folder or File from one path to another

Action key: moveObject

Inputs

KeyTypeDefaultRequiredComments
fromPathSTRINGNoneTrueThe path to the source object, typically starts with /
toPathSTRINGNoneTrueThe path to the destination object, typically starts with /

Path Details

Get detailed information about folders/files in the specified path

Action key: pathDetails

Inputs

KeyTypeDefaultRequiredComments
pathSTRINGNoneTrueThe location of the object, typically starts with /

Upload File

Upload a file to the specified path

Action key: uploadFile

Inputs

KeyTypeDefaultRequiredComments
fileContentsDATANoneTrueBinary file data
pathSTRINGNoneTrueThe location of the object, typically starts with /

Box Developer Documentation

Information about generating Box OAuth2 Tokens can be found on their developer documentation site.

Last updated on