Skip to content

Dropbox

Reference


Dropbox is a file hosting service that offers cloud storage, file synchronization, personal cloud, and client software.

Categories: [file-storage]

Version: 1


Connections

Version: 1

OAuth2 Authorization Code

Properties

NameTypeControl TypeDescription
Client IdSTRINGTEXT
Client SecretSTRINGTEXT

Actions

Copy

Copy a file or folder to a different location in the user’s Dropbox. If the source path is a folder all its contents will be copied.

Properties

NameTypeControl TypeDescription
FilenameSTRINGTEXTName of the file with the extension. Don’t fill in if you want a folder.
Source pathSTRINGTEXTThe path which the file or folder should be copyed from. Root is /.
Destination pathSTRINGTEXTThe path which the file or folder should be copyed to. Root is /.

Output

Type: OBJECT

Properties

TypeControl Type
{STRING(.tag), STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}OBJECT_BUILDER

Create new folder

Create a folder at a given path.

Properties

NameTypeControl TypeDescription
Folder path/nameSTRINGTEXTThe path of the new folder. Root is /.

Output

Type: OBJECT

Properties

TypeControl Type
{STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}OBJECT_BUILDER

Create a new paper file

Create a new .paper file on which you can write at a given path

Properties

NameTypeControl TypeDescription
PathSTRINGTEXTThe path of the new paper file. Root is /.
FilenameSTRINGTEXTName of the paper file
TextSTRINGTEXT_AREAThe text to write into the file.
Auto RenameBOOLEANSELECTIf there’s a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.
MuteBOOLEANSELECTNormally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn’t result in a user notification.
Strict conflictBOOLEANSELECTBe more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.update and the given “rev” doesn’t match the existing file’s “rev”, even if the existing file has been deleted.

Output

Type: OBJECT

Properties

TypeControl Type
STRINGTEXT
STRINGTEXT
STRINGTEXT
INTEGERINTEGER

Delete

Delete the file or folder at a given path. If the path is a folder, all its contents will be deleted too.

Properties

NameTypeControl TypeDescription
PathSTRINGTEXTPath of the file or folder. Root is /.
FilenameSTRINGTEXTName of the file. Leave empty if you want to delete a folder.

Output

Type: OBJECT

Properties

TypeControl Type
{STRING(.tag), STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}OBJECT_BUILDER

Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. This URL should not be used to display content directly in the browser. The Content-Type of the link is determined automatically by the file’s mime type.

Properties

NameTypeControl TypeDescription
Path to the fileSTRINGTEXTThe path to the file you want a temporary link to. Root is /.
FilenameSTRINGTEXTName of the file with the extension. Needs to have a streamable extension (.mp4, .mov, .webm, ect)

Output

Type: OBJECT

Properties

TypeControl Type
{STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}OBJECT_BUILDER
STRINGTEXT

List folder

List the contents of a folder.

Properties

NameTypeControl TypeDescription
PathSTRINGTEXTPath of the filename. Inputting nothing searches root.

Output

Type: OBJECT

Properties

TypeControl Type
[{{STRING(.tag), STRING(name), STRING(path_lower), STRING(path_Display), STRING(id)}(f)}]ARRAY_BUILDER

Move

Move a file or folder to a different location in the user’s Dropbox. If the source path is a folder all its contents will be moved. Note that we do not currently support case-only renaming.

Properties

NameTypeControl TypeDescription
FilenameSTRINGTEXTName of the file with the extension. Don’t fill in if you want a folder.
Source pathSTRINGTEXTPath in the user’s Dropbox to be moved. Root is /.
Destination pathSTRINGTEXTPath in the user’s Dropbox that is the destination. Root is /.

Output

Type: OBJECT

Properties

TypeControl Type
{STRING(.tag), STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}OBJECT_BUILDER

Searches for files and folders. Can only be used to retrieve a maximum of 10,000 matches. Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.

Properties

NameTypeControl TypeDescription
Search stringSTRINGTEXTThe string to search for. May match across multiple fields based on the request arguments.

Output

Type: OBJECT

Properties

TypeControl Type
[{{STRING(.tag)}(match_type), {STRING(.tag), STRING(id), STRING(name), STRING(path_display), STRING(path_lower)}(metadata)}]ARRAY_BUILDER

Upload file

Create a new file up to a size of 150MB with the contents provided in the request.

Properties

NameTypeControl TypeDescription
FileFILE_ENTRYFILE_ENTRYThe object property which contains a reference to the file to be written.
Destination pathSTRINGTEXTThe path to which the file should be written.
FilenameSTRINGTEXTName of the file. Needs to have the appropriate extension.
Auto RenameBOOLEANSELECTIf there’s a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.
MuteBOOLEANSELECTNormally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn’t result in a user notification.
Strict conflictBOOLEANSELECTBe more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.update and the given “rev” doesn’t match the existing file’s “rev”, even if the existing file has been deleted.

Output

Type: OBJECT

Properties

TypeControl Type
STRINGTEXT
DATEDATE
DATEDATE
STRINGTEXT
INTEGERINTEGER
{STRING(target)}OBJECT_BUILDER
{STRING(parentSharedFolderId), STRING(modifiedBy)}OBJECT_BUILDER
BOOLEANSELECT
{STRING(exportAs), [STRING](exportOptions)}OBJECT_BUILDER
[{STRING(templateId), [{STRING(name), STRING(value)}](fields)}]ARRAY_BUILDER
BOOLEANSELECT
STRINGTEXT
{BOOLEAN(isLockholder), STRING(lockholderName), STRING(lockholderAccountId), DATE(created)}OBJECT_BUILDER

Additional instructions


anl-c-dropbox-md

CONNECTION

Setting up OAuth2