Available on crate features
sync_routes and dbx_files only.Structs§
- AddTag
Arg - Alpha
GetMetadata Arg - Commit
Info - Content
Sync Setting - Content
Sync Setting Arg - Create
Folder Arg - Create
Folder Batch Arg - Create
Folder Batch Result - Create
Folder Entry Result - Create
Folder Result - Delete
Arg - Delete
Batch Arg - Delete
Batch Result - Delete
Batch Result Data - Delete
Result - Deleted
Metadata - Indicates that there used to be a file or folder at this path, but it no longer exists.
- Dimensions
- Dimensions for a photo or video.
- Download
Arg - Download
ZipArg - Download
ZipResult - Export
Arg - Export
Info - Export information for a file.
- Export
Metadata - Export
Result - File
Lock - File
Lock Metadata - File
Metadata - File
OpsResult - File
Sharing Info - Sharing info for a file which is contained by a shared folder.
- Folder
Metadata - Folder
Sharing Info - Sharing info for a folder which is contained in a shared folder or is a shared folder mount point.
- GetCopy
Reference Arg - GetCopy
Reference Result - GetMetadata
Arg - GetTags
Arg - GetTags
Result - GetTemporary
Link Arg - GetTemporary
Link Result - GetTemporary
Upload Link Arg - GetTemporary
Upload Link Result - GetThumbnail
Batch Arg - Arguments for
get_thumbnail_batch(). - GetThumbnail
Batch Result - GetThumbnail
Batch Result Data - GpsCoordinates
- GPS coordinates for a photo or video.
- Highlight
Span - List
Folder Arg - List
Folder Continue Arg - List
Folder GetLatest Cursor Result - List
Folder Longpoll Arg - List
Folder Longpoll Result - List
Folder Result - List
Revisions Arg - List
Revisions Result - Lock
Conflict Error - Lock
File Arg - Lock
File Batch Arg - Lock
File Batch Result - Lock
File Result - Minimal
File Link Metadata - Move
Batch Arg - Paper
Create Arg - Paper
Create Result - Paper
Update Arg - Paper
Update Result - Path
ToTags - Photo
Metadata - Metadata for a photo.
- Preview
Arg - Preview
Result - Relocation
Arg - Relocation
Batch Arg - Relocation
Batch ArgBase - Relocation
Batch Result - Relocation
Batch Result Data - Relocation
Batch V2Result - Relocation
Path - Relocation
Result - Remove
TagArg - Restore
Arg - Save
Copy Reference Arg - Save
Copy Reference Result - Save
UrlArg - Search
Arg - Search
Match - Search
Match Field Options - Search
Match V2 - Search
Options - Search
Result - Search
V2Arg - Search
V2Continue Arg - Search
V2Result - Shared
Link - Shared
Link File Info - Sharing
Info - Sharing info for a file or folder.
- Single
User Lock - Symlink
Info - Thumbnail
Arg - Thumbnail
V2Arg - Unlock
File Arg - Unlock
File Batch Arg - Upload
Arg - Upload
Session Append Arg - Upload
Session Cursor - Upload
Session Finish Arg - Upload
Session Finish Batch Arg - Upload
Session Finish Batch Result - Upload
Session Offset Error - Upload
Session Start Arg - Upload
Session Start Batch Arg - Upload
Session Start Batch Result - Upload
Session Start Result - Upload
Write Failed - User
Generated Tag - Video
Metadata - Metadata for a video.
Enums§
- AddTag
Error - Alpha
GetMetadata Error - Base
TagError - Create
Folder Batch Error - Create
Folder Batch JobStatus - Create
Folder Batch Launch - Result returned by
create_folder_batch()that may either launch an asynchronous job or complete synchronously. - Create
Folder Batch Result Entry - Create
Folder Entry Error - Create
Folder Error - Delete
Batch Error - Delete
Batch JobStatus - Delete
Batch Launch - Result returned by
delete_batch()that may either launch an asynchronous job or complete synchronously. - Delete
Batch Result Entry - Delete
Error - Download
Error - Download
ZipError - Export
Error - File
Category - File
Lock Content - File
Status - GetCopy
Reference Error - GetMetadata
Error - GetTemporary
Link Error - GetThumbnail
Batch Error - GetThumbnail
Batch Result Entry - Import
Format - The import format of the incoming Paper doc content.
- List
Folder Continue Error - List
Folder Error - List
Folder Longpoll Error - List
Revisions Error - List
Revisions Mode - Lock
File Error - Lock
File Result Entry - Lookup
Error - Media
Info - Media
Metadata - Metadata for a photo or video.
- Metadata
- Metadata for a file or folder.
- Metadata
V2 - Metadata for a file, folder or other resource types.
- Move
Into Family Error - Move
Into Vault Error - Paper
Content Error - Paper
Create Error - Paper
DocUpdate Policy - Paper
Update Error - Path
OrLink - Preview
Error - Relocation
Batch Error - Relocation
Batch Error Entry - Relocation
Batch JobStatus - Relocation
Batch Launch - Result returned by
copy_batch()ormove_batch()that may either launch an asynchronous job or complete synchronously. - Relocation
Batch Result Entry - Relocation
Batch V2Job Status - Result returned by
copy_batch_check_v2()ormove_batch_check_v2()that may either be in progress or completed with result for each entry. - Relocation
Batch V2Launch - Result returned by
copy_batch_v2()ormove_batch_v2()that may either launch an asynchronous job or complete synchronously. - Relocation
Error - Remove
TagError - Restore
Error - Save
Copy Reference Error - Save
UrlError - Save
UrlJob Status - Save
UrlResult - Search
Error - Search
Match Type - Indicates what type of match was found for a given item.
- Search
Match Type V2 - Indicates what type of match was found for a given item.
- Search
Mode - Search
Order By - Sync
Setting - Sync
Setting Arg - Sync
Settings Error - Tag
- Tag that can be added in multiple ways.
- Thumbnail
Error - Thumbnail
Format - Thumbnail
Mode - Thumbnail
Size - Thumbnail
V2Error - Upload
Error - Upload
Session Append Error - Upload
Session Finish Batch JobStatus - Upload
Session Finish Batch Launch - Result returned by
upload_session_finish_batch()that may either launch an asynchronous job or complete synchronously. - Upload
Session Finish Batch Result Entry - Upload
Session Finish Error - Upload
Session Lookup Error - Upload
Session Start Error - Upload
Session Type - Write
Conflict Error - Write
Error - Write
Mode - Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is. In some situations, the conflict behavior is identical: (a) If the target path doesn’t refer to anything, the file is always written; no conflict. (b) If the target path refers to a folder, it’s always a conflict. (c) If the target path refers to a file with identical contents, nothing gets written; no conflict. The conflict checking differs in the case where there’s a file at the target path with contents different from the contents you’re trying to write.
Functions§
- alpha_
get_ metadata Deprecated unstable - Returns the metadata for a file or folder. This is an alpha endpoint compatible with the properties API. Note: Metadata for the root folder is unsupported.
- alpha_
upload Deprecated unstable - Create a new file with the contents provided in the request. Note that the behavior of this
alpha endpoint is unstable and subject to change. Do not use this to upload a file larger than
150 MB. Instead, create an upload session with
upload_session_start(). - copy
Deprecated - 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.
- copy_
batch Deprecated - Copy multiple files or folders to different locations at once in the user’s Dropbox. This route
will return job ID immediately and do the async copy job in background. Please use
copy_batch_check()to check the job status. - copy_
batch_ check Deprecated - Returns the status of an asynchronous job for
copy_batch(). If success, it returns list of results for each entry. - copy_
batch_ check_ v2 - Returns the status of an asynchronous job for
copy_batch_v2(). It returns list of results for each entry. - copy_
batch_ v2 - Copy multiple files or folders to different locations at once in the user’s Dropbox. This route
will replace
copy_batch(). The main difference is this route will return status for each entry, whilecopy_batch()raises failure if any entry fails. This route will either finish synchronously, or return a job ID and do the async copy job in background. Please usecopy_batch_check_v2()to check the job status. - copy_
reference_ get - 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(). - copy_
reference_ save - Save a copy reference returned by
copy_reference_get()to the user’s Dropbox. - copy_v2
- 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.
- create_
folder Deprecated - Create a folder at a given path.
- create_
folder_ batch - Create multiple folders at once. This route is asynchronous for large batches, which returns a
job ID immediately and runs the create folder batch asynchronously. Otherwise, creates the
folders and returns the result synchronously for smaller inputs. You can force asynchronous
behaviour by using the
CreateFolderBatchArg::force_asyncflag. Usecreate_folder_batch_check()to check the job status. - create_
folder_ batch_ check - Returns the status of an asynchronous job for
create_folder_batch(). If success, it returns list of result for each entry. - create_
folder_ v2 - Create a folder at a given path.
- delete
Deprecated - Delete the file or folder at a given path. If the path is a folder, all its contents will be
deleted too. A successful response indicates that the file or folder was deleted. The returned
metadata will be the corresponding
FileMetadataorFolderMetadatafor the item at time of deletion, and not aDeletedMetadataobject. - delete_
batch - Delete multiple files/folders at once. This route is asynchronous, which returns a job ID
immediately and runs the delete batch asynchronously. Use
delete_batch_check()to check the job status. - delete_
batch_ check - Returns the status of an asynchronous job for
delete_batch(). If success, it returns list of result for each entry. - delete_
v2 - Delete the file or folder at a given path. If the path is a folder, all its contents will be
deleted too. A successful response indicates that the file or folder was deleted. The returned
metadata will be the corresponding
FileMetadataorFolderMetadatafor the item at time of deletion, and not aDeletedMetadataobject. - do_move
Deprecated - 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.
- download
- Download a file from a user’s Dropbox.
- download_
zip - Download a folder from the user’s Dropbox, as a zip file. The folder must be less than 20 GB in size and any single file within must be less than 4 GB in size. The resulting zip must have fewer than 10,000 total file and folder entries, including the top level folder. The input cannot be a single file. Note: this endpoint does not support HTTP range requests.
- export
unstable - Export a file from a user’s Dropbox. This route only supports exporting files that cannot be
downloaded directly and whose
ExportResult::file_metadatahasExportInfo::export_aspopulated. - get_
file_ lock_ batch - Return the lock metadata for the given list of paths.
- get_
metadata - Returns the metadata for a file or folder. Note: Metadata for the root folder is unsupported.
- get_
preview - Get a preview for a file. Currently, PDF previews are generated for files with the following extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf. HTML previews are generated for files with the following extensions: .csv, .ods, .xls, .xlsm, .gsheet, .xlsx. Other formats will return an unsupported extension error.
- get_
temporary_ link - 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.
- get_
temporary_ upload_ link - Get a one-time use temporary upload link to upload a file to a Dropbox location.
- get_
thumbnail - Get a thumbnail for an image. This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp. Photos that are larger than 20MB in size won’t be converted to a thumbnail.
- get_
thumbnail_ batch - Get thumbnails for a list of images. We allow up to 25 thumbnails in a single batch. This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp. Photos that are larger than 20MB in size won’t be converted to a thumbnail.
- get_
thumbnail_ v2 - Get a thumbnail for an image. This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp. Photos that are larger than 20MB in size won’t be converted to a thumbnail.
- get_
thumbnail_ v2_ app_ auth - Get a thumbnail for an image. This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif, webp, ppm and bmp. Photos that are larger than 20MB in size won’t be converted to a thumbnail.
- list_
folder - Starts returning the contents of a folder. If the result’s
ListFolderResult::has_morefield istrue, calllist_folder_continue()with the returnedListFolderResult::cursorto retrieve more entries. If you’re usingListFolderArg::recursiveset totrueto keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them as follows to keep your local state in sync: For eachFileMetadata, store the new entry at the given path in your local state. If the required parent folders don’t exist yet, create them. If there’s already something else at the given path, replace it and remove all its children. For eachFolderMetadata, store the new entry at the given path in your local state. If the required parent folders don’t exist yet, create them. If there’s already something else at the given path, replace it but leave the children as they are. Check the new entry’sFolderSharingInfo::read_onlyand set all its children’s read-only statuses to match. For eachDeletedMetadata, if your local state has something at the given path, remove it and all its children. If there’s nothing at the given path, ignore this entry. Note:auth::RateLimitErrormay be returned if multiplelist_folder()orlist_folder_continue()calls with same parameters are made simultaneously by same API app for same user. If your app implements retry logic, please hold off the retry until the previous request finishes. - list_
folder_ app_ auth - Starts returning the contents of a folder. If the result’s
ListFolderResult::has_morefield istrue, calllist_folder_continue()with the returnedListFolderResult::cursorto retrieve more entries. If you’re usingListFolderArg::recursiveset totrueto keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them as follows to keep your local state in sync: For eachFileMetadata, store the new entry at the given path in your local state. If the required parent folders don’t exist yet, create them. If there’s already something else at the given path, replace it and remove all its children. For eachFolderMetadata, store the new entry at the given path in your local state. If the required parent folders don’t exist yet, create them. If there’s already something else at the given path, replace it but leave the children as they are. Check the new entry’sFolderSharingInfo::read_onlyand set all its children’s read-only statuses to match. For eachDeletedMetadata, if your local state has something at the given path, remove it and all its children. If there’s nothing at the given path, ignore this entry. Note:auth::RateLimitErrormay be returned if multiplelist_folder()orlist_folder_continue()calls with same parameters are made simultaneously by same API app for same user. If your app implements retry logic, please hold off the retry until the previous request finishes. - list_
folder_ continue - Once a cursor has been retrieved from
list_folder(), use this to paginate through all files and retrieve updates to the folder, following the same rules as documented forlist_folder(). - list_
folder_ continue_ app_ auth - Once a cursor has been retrieved from
list_folder(), use this to paginate through all files and retrieve updates to the folder, following the same rules as documented forlist_folder(). - list_
folder_ get_ latest_ cursor - A way to quickly get a cursor for the folder’s state. Unlike
list_folder(),list_folder_get_latest_cursor()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. - list_
folder_ longpoll - 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. If you’re looking for server-side notifications, check out our webhooks documentation. - list_
revisions - Returns revisions for files based on a file path or a file id. The file path or file id is
identified from the latest file entry at the given file path or id. This end point allows your
app to query either by file path or file id by setting the mode parameter appropriately. In the
ListRevisionsMode::Path(default) mode, all revisions at the same file path as the latest file entry are returned. If revisions with the same file id are desired, then mode must be set toListRevisionsMode::Id. TheListRevisionsMode::Idmode is useful to retrieve revisions for a given file across moves or renames. - lock_
file_ batch - Lock the files at the given paths. A locked file will be writable only by the lock holder. A successful response indicates that the file has been locked. Returns a list of the locked file paths and their metadata after this operation.
- move_
batch Deprecated - Move multiple files or folders to different locations at once in the user’s Dropbox. This route
will return job ID immediately and do the async moving job in background. Please use
move_batch_check()to check the job status. - move_
batch_ check Deprecated - Returns the status of an asynchronous job for
move_batch(). If success, it returns list of results for each entry. - move_
batch_ check_ v2 - Returns the status of an asynchronous job for
move_batch_v2(). It returns list of results for each entry. - move_
batch_ v2 - Move multiple files or folders to different locations at once in the user’s Dropbox. Note that
we do not currently support case-only renaming. This route will replace
move_batch(). The main difference is this route will return status for each entry, whilemove_batch()raises failure if any entry fails. This route will either finish synchronously, or return a job ID and do the async move job in background. Please usemove_batch_check_v2()to check the job status. - move_v2
- 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.
- paper_
create unstable - Creates a new Paper doc with the provided content.
- paper_
update unstable - Updates an existing Paper doc with the provided content.
- permanently_
delete - Permanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40). If the given file or folder is not yet deleted, this route will first delete it. It is possible for this route to successfully delete, then fail to permanently delete. Note: This endpoint is only available for Dropbox Business apps.
- properties_
add Deprecated - properties_
overwrite Deprecated - properties_
remove Deprecated - properties_
template_ get Deprecated - properties_
template_ list Deprecated - properties_
update Deprecated - restore
- Restore a specific revision of a file to the given path.
- save_
url - Save the data from a specified URL into a file in user’s Dropbox. Note that the transfer from the URL must complete within 15 minutes, or the operation will time out and the job will fail. If the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt).
- save_
url_ check_ job_ status - Check the status of a
save_url()job. - search
Deprecated - Searches for files and folders. Note: Recent changes will be reflected in search results within a few seconds and older revisions of existing files may still match your query for up to a few days.
- search_
continue_ v2 - Fetches the next page of search results returned from
search_v2(). Note:search_v2()along withsearch_continue_v2()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. - search_
v2 - Searches for files and folders. Note:
search_v2()along withsearch_continue_v2()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. - tags_
add unstable - Add a tag to an item. A tag is a string. The strings are automatically converted to lowercase letters. No more than 20 tags can be added to a given item.
- tags_
get unstable - Get list of tags assigned to items.
- tags_
remove unstable - Remove a tag from an item.
- unlock_
file_ batch - Unlock the files at the given paths. A locked file can only be unlocked by the lock holder or, if a business account, a team admin. A successful response indicates that the file has been unlocked. Returns a list of the unlocked file paths and their metadata after this operation.
- upload
- 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(). Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page. - upload_
session_ append Deprecated - Append more data to an upload session. A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.
- upload_
session_ append_ v2 - 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. The maximum size of a file one can upload to an upload session is 350 GB. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.
- upload_
session_ finish - Finish an upload session and save the uploaded data to the given file path. A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.
- upload_
session_ finish_ batch Deprecated - This route helps you commit many files at once into a user’s Dropbox. Use
upload_session_start()andupload_session_append_v2()to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than callingupload_session_finish(), use this route to finish all your upload sessions in a single request.UploadSessionStartArg::closeorUploadSessionAppendArg::closeneeds to be true for the lastupload_session_start()orupload_session_append_v2()call. The maximum size of a file one can upload to an upload session is 350 GB. This route will return a job_id immediately and do the async commit job in background. Useupload_session_finish_batch_check()to check the job status. For the same account, this route should be executed serially. That means you should not start the next job before current job finishes. We allow up to 1000 entries in a single request. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page. - upload_
session_ finish_ batch_ check - Returns the status of an asynchronous job for
upload_session_finish_batch(). If success, it returns list of result for each entry. - upload_
session_ finish_ batch_ v2 - This route helps you commit many files at once into a user’s Dropbox. Use
upload_session_start()andupload_session_append_v2()to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than callingupload_session_finish(), use this route to finish all your upload sessions in a single request.UploadSessionStartArg::closeorUploadSessionAppendArg::closeneeds to be true for the lastupload_session_start()orupload_session_append_v2()call of each upload session. The maximum size of a file one can upload to an upload session is 350 GB. We allow up to 1000 entries in a single request. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page. - upload_
session_ start - Upload sessions allow you to upload a single file in one or more requests, for example where the
size of the file is greater than 150 MB. This call starts a new upload session with the given
data. You can then use
upload_session_append_v2()to add more data andupload_session_finish()to save all the data to a file in Dropbox. A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB. An upload session can be used for a maximum of 7 days. Attempting to use anUploadSessionStartResult::session_idwithupload_session_append_v2()orupload_session_finish()more than 7 days after its creation will return aUploadSessionLookupError::NotFound. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page. By default, upload sessions require you to send content of the file in sequential order via consecutiveupload_session_start(),upload_session_append_v2(),upload_session_finish()calls. For better performance, you can instead optionally use aUploadSessionType::Concurrentupload session. To start a new concurrent session, setUploadSessionStartArg::session_typetoUploadSessionType::Concurrent. After that, you can send file data in concurrentupload_session_append_v2()requests. Finally finish the session withupload_session_finish(). There are couple of constraints with concurrent sessions to make them work. You can not send data withupload_session_start()orupload_session_finish()call, only withupload_session_append_v2()call. Also data uploaded inupload_session_append_v2()call must be multiple of 4194304 bytes (except for lastupload_session_append_v2()withUploadSessionStartArg::closetotrue, that may contain any remaining data). - upload_
session_ start_ batch - This route starts batch of upload_sessions. Please refer to
upload_session/startusage. Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.