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

Categories: File Storage

Type: dropbox/v1

Connections

Version: 1

OAuth2 Authorization Code

Properties

Name	Label	Type	Description	Required
clientId	Client Id	STRING		true
clientSecret	Client Secret	STRING		true

Name	Type	Description
metadata	OBJECT Properties {STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}	Metadata containing details about the copied file or folder.

Name	Label	Type	Description	Required
path	Folder Path/Name	STRING	The path of the new folder. Root is /.	true

Name	Type	Description
metadata	OBJECT Properties {STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}	Metadata containing details about the newly created folder.

Name	Label	Type	Description	Required
path	Path	STRING	The path of the new paper file. Root is /.	true
filename	Filename	STRING	Name of the paper file	true
text	Text	STRING	The text to write into the file.	true
autorename	Auto Rename	BOOLEAN Options true, false	If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.	false
mute	Mute	BOOLEAN Options true, false	Normally, 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.	false
strict_conflict	Strict Conflict	BOOLEAN Options true, false	Be 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.	false

Name	Type	Description
name	STRING	The name of the newly created file, including its extension. This is the last component of the path.
path_lower	STRING	The full path to the file in lowercase, as stored in the user's Dropbox.
path_display	STRING	The display-friendly version of the file's path, preserving original casing for readability.
id	STRING	ID of the file within Dropbox.
size	INTEGER	The size of the file in bytes, representing the total amount of data it contains.
is_downloadable	BOOLEAN Options true, false	Indicates whether the file can be directly downloaded from Dropbox.
content_hash	STRING	A hash value representing the content of the file, used for verifying data integrity.

Name	Label	Type	Description	Required
path	Path	STRING	Path of the file or folder. Root is /.	true
filename	Filename	STRING	Name of the file. Leave empty if you want to delete a folder.	false

Name	Type	Description
metadata	OBJECT Properties {STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}	Metadata containing details about the deleted file or folder.

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

Name	Label	Type	Description	Required
path	Namepath to the File	STRING	The path to the file you want a temporary link to. Root is /.	true
filename	Filename	STRING	Name of the file with the extension. Needs to have a streamable extension (.mp4, .mov, .webm, ect)	true

Example JSON Structure

{
  "label" : "Get File Link",
  "name" : "getFileLink",
  "parameters" : {
    "path" : "",
    "filename" : ""
  },
  "type" : "dropbox/v1/getFileLink"
}

Output

Type: OBJECT

Properties

Name	Type	Description
metadata	OBJECT Properties {STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}
link	STRING	A temporary URL that can be used to stream the content of the file. This link expires after four hours.

Output Example

{
  "metadata" : {
    "name" : "",
    "path_lower" : "",
    "path_display" : "",
    "id" : ""
  },
  "link" : ""
}

List Folder

Name: listFolder

List the contents of a folder.

Properties

Name	Label	Type	Description	Required
path	Path	STRING	Path of the filename. Inputting nothing searches root.	false

Example JSON Structure

{
  "label" : "List Folder",
  "name" : "listFolder",
  "parameters" : {
    "path" : ""
  },
  "type" : "dropbox/v1/listFolder"
}

Output

Type: OBJECT

Properties

Name	Type	Description
entries	ARRAY Items [{STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}]

Output Example

{
  "entries" : [ {
    "name" : "",
    "path_lower" : "",
    "path_display" : "",
    "id" : ""
  } ]
}

Move

Name: 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

Name	Label	Type	Description	Required
filename	Filename	STRING	Name of the file with the extension. Don't fill in if you want a folder.	false
from_path	Source Path	STRING	Path in the user's Dropbox to be moved. Root is /.	true
to_path	Destination Path	STRING	Path in the user's Dropbox that is the destination. Root is /.	true

Example JSON Structure

{
  "label" : "Move",
  "name" : "move",
  "parameters" : {
    "filename" : "",
    "from_path" : "",
    "to_path" : ""
  },
  "type" : "dropbox/v1/move"
}

Output

Type: OBJECT

Properties

Name	Type	Description
metadata	OBJECT Properties {STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}	Metadata containing details about the moved file or folder.

Output Example

{
  "metadata" : {
    "name" : "",
    "path_lower" : "",
    "path_display" : "",
    "id" : ""
  }
}

Search

Name: search

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

Name	Label	Type	Description	Required
query	Search String	STRING	The string to search for. May match across multiple fields based on the request arguments.	true

Example JSON Structure

{
  "label" : "Search",
  "name" : "search",
  "parameters" : {
    "query" : ""
  },
  "type" : "dropbox/v1/search"
}

Output

Type: OBJECT

Properties

Name	Type	Description
matches	ARRAY Items [{{STRING(name), STRING(path_lower), STRING(path_display), STRING(id)}(metadata)}]	A list (possibly empty) of matches for the query.

Output Example

{
  "matches" : [ {
    "metadata" : {
      "name" : "",
      "path_lower" : "",
      "path_display" : "",
      "id" : ""
    }
  } ]
}

Upload File

Name: uploadFile

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

Properties

Name	Label	Type	Description	Required
fileEntry	File Entry	FILE_ENTRY	The object property which contains a reference to the file to be written.	true
path	Destination Path	STRING	The path to which the file should be written.	true
filename	Filename	STRING	Name of the file. Needs to have the appropriate extension.	true
autorename	Auto Rename	BOOLEAN Options true, false	If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.	false
mute	Mute	BOOLEAN Options true, false	Normally, 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.	false
strict_conflict	Strict Conflict	BOOLEAN Options true, false	Be 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.	false

Example JSON Structure

{
  "label" : "Upload File",
  "name" : "uploadFile",
  "parameters" : {
    "fileEntry" : {
      "extension" : "",
      "mimeType" : "",
      "name" : "",
      "url" : ""
    },
    "path" : "",
    "filename" : "",
    "autorename" : false,
    "mute" : false,
    "strict_conflict" : false
  },
  "type" : "dropbox/v1/uploadFile"
}

Output

Type: OBJECT

Properties

Name	Type	Description
name	STRING	Name of the file. The last component of the path (including extension).
path_lower	STRING	The lowercased full path in the user's Dropbox.
path_display	STRING	The cased path to be used for display purposes only.
id	STRING	ID of the folder.
size	INTEGER	The file size in bytes.
is_downloadable	BOOLEAN Options true, false	If file can be downloaded directly.
content_hash	STRING	A hash of the file content.

Output Example

{
  "name" : "",
  "path_lower" : "",
  "path_display" : "",
  "id" : "",
  "size" : 1,
  "is_downloadable" : false,
  "content_hash" : ""
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.

Additional Instructions

CONNECTION

Setting up OAuth2

Dropbox

On this page