Classes
Exception wrapper
Exception for when the API key is not provided
Abstraction for content downloads
A wrapper for the ContentUpload group of operations
Wrapper for RPC endpoints
A subtype of RPC that only accepts a single argument
A subtype of RPC that only needs a source path and a destination path
The most abstract operation wrapper
The Copy operation
Get a copy reference to a file or folder. This reference string can be used to save that file or folder to
another user's Dropbox by passing it to copy_reference/save.
Save a copy reference returned by copy_reference/get to the user's Dropbox.
Create a folder at a given path.
The delete operation
Download a file
The get_metadata operation
Get a preview for a file. Currently previews are only generated for the files with the following extensions:
Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will
get 410 Gone. Content-Type of the link is determined automatically by the file's mime type.
Get the file's thumbnail
A way to quickly get a cursor for the folder's state. Unlike listfolder, listfolder/getlatestcursor
doesn't return any entries. This endpoint is for app which only needs to know about new files and
modifications and doesn't need to know about files that already exist in Dropbox.
Returns the contents of a folder.
Once a cursor has been retrieved from list_folder, use this to paginate through all files and retrieve updates
to the folder.
A longpoll endpoint to wait for changes on an account. In conjunction with list_folder/continue, this call
gives you a low-latency way to monitor an account for file changes. The connection will block until there are
changes available or a timeout occurs. This endpoint is useful mostly for client-side apps.
Return revisions of a file
The Move operation
The permanently_delete operation
Restore a file to a specific revision
Check the status of a save_url job.
Save a specified URL into a file in user's Dropbox. If the given path already exists, the file will be renamed
to avoid the conflict (e.g. myfile (1).txt).
Searches for files and folders. Note: Recent changes may not immediately be reflected in search results due to
a short delay in indexing.
Create a new file with the contents provided in the request. Do not use this to upload a file larger than
150 MB. Instead, create an upload session with upload_session/start.
Append more data to an upload session. When the parameter close is set, this call will close the session. A
single request should not upload more than 150 MB of file contents.
Finish an upload session and save the uploaded data to the given file path. A single request should not upload
more than 150 MB of file contents.
Upload sessions allow you to upload a single file using multiple requests. This call starts a new upload
session with the given data. You can then use uploadsession/append to add more data and uploadsession/finish
to save all the data to a file in Dropbox.
Get information about a user's account.
Get information about multiple user accounts. At most 300 accounts may be queried per request.
Get information about the current user's account.
Get the space usage information for the current user's account.
Additional options for the GetMetadata operation
Options for the get_thumbnail operation
Additional options for the ListFolder operation
Additional options for the list_revisions operation
Options for the Longpoll operation
Options for the search operation
Additional options for the Upload operation
Additional options for upload_session/start
If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid
conflict. The default for this field is False.
The value to store as the client_modified timestamp. Dropbox automatically records the time at which the file
was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop
clients, mobile clients, and API apps of when the file was actually created or modified
If true, current session will be closed. You cannot do upload_session/append any more to current session The
default for this field is False.
If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.not_found will be
returned. The default for this field is False.
If true, the results will include a flag for each file indicating whether or not that file has any explicit
members. The default for this field is False.
If true, FileMetadata.media_info is set for photo and video. The default for this field is False.
The maximum number of entries returned. The default for this field is 10.
The maximum number of search results to return. The default for this field is 100.
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. The default for this field is False.
If true, the operation will apply to all subfolders, too. The default value is false.
The search mode (filename, filenameandcontent, or deleted_filename). Note that searching file content is
only available for Dropbox Business accounts. The default for this union is filename.
The starting index within the search results (used for paging). The default for this field is 0.
The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred,
while png is better for screenshots and digital arts. The default for this union is jpeg.
The size for the thumbnail image. The default for this union is w64h64.
A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random
jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some
network infrastructure does not support long timeouts. The default for this field is 30.
Selects what to do if the file already exists. The default for this union is add.
Option names
Abstract options wrapper
Topmost abstract parameter class
Contains the path and other optional modifiers for the commit.
What we're searching for
Note: Recent changes may not immediately be reflected in search results due to a short delay in indexing.
Note: Recent changes may not immediately be reflected in search results due to a short delay in indexing.
The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be
preferred, while png is better for screenshots and digital arts. The default for this union is jpeg.
The size for the thumbnail image. The default for this union is 64x64.
Contains the upload session ID and the offset.
Selects what to do if the file already exists. The default for this union is add.
Response attributes
Miscellaneous utilities