← Files operations · All schemas
A way to quickly get a cursor for the folder's state — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
cursor | string | Required within parent | Minimum length: 1 |
Add a tag to an item — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:/(.|[\r\n])*)$ |
tag_text | string | Required within parent | Maximum length: 32
Minimum length: 1
Pattern: ^(?:[\w]+)$ |
Append more data to an upload session — request body — headers Dropbox-API-Arg
Referenced models: Append more data to an upload session — request body — headers Dropbox-API-Arg cursor
Append more data to an upload session — request body — headers Dropbox-API-Arg cursor
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
session_id | string | Required within parent | |
offset | integer | Required within parent | Minimum: 0 |
Append more data to multiple upload sessions — request body — headers Dropbox-API-Arg
Referenced models: Append more data to multiple upload sessions — request body — headers Dropbox-API-Arg entries item
Append more data to multiple upload sessions — request body — headers Dropbox-API-Arg entries item
Referenced models: Append more data to an upload session — request body — headers Dropbox-API-Arg cursor
Append more data to multiple upload sessions — response body
Referenced models: Append more data to multiple upload sessions — response body — entries item
Append more data to multiple upload sessions — response body — entries item
Referenced models: Append more data to multiple upload sessions — response body — entries item tag failure failure
Append more data to multiple upload sessions — response body — entries item tag failure failure
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: not_found, closed, too_large, concurrent_session_invalid_offset, concurrent_session_invalid_data_size |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: not_found |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: incorrect_offset |
$ (anyOf 3).correct_offset | JSON | Required within parent | |
$ (anyOf 3).correct_offset (anyOf 1) | integer | Alternative | Minimum: 0 |
$ (anyOf 3).correct_offset (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: closed |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: too_large |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: concurrent_session_invalid_offset |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: concurrent_session_invalid_data_size |
$ (anyOf 8) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 8)..tag | string | Required within parent | Pattern: ^(?!(?:not_found|incorrect_offset|closed|too_large|concurrent_session_invalid_offset|concurrent_session_invalid_data_size)$) |
Check the status of a save url job — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Arguments for methods that poll the status of an asynchronous job. |
async_job_id | string | Required within parent | Minimum length: 1 |
Check the status of a save url job — response body
Referenced models: Check the status of a save url job — response body — tag failed failed, Check the status of a save url job — response body — tag complete
Check the status of a save url job — response body — tag complete
Referenced models: Add property groups to a Dropbox file — request body — body property groups item, Restore a specific revision of a file to the given path — response body — export info Export information for a file, Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name, Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only, Restore a specific revision of a file to the given path — response body — symlink info target, Restore a specific revision of a file to the given path — response body — media info value
Check the status of a save url job — response body — tag failed failed
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: download_failed, invalid_url, not_found |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: path |
$ (anyOf 2).path | Model | Required within parent | Expand Check the status of a save url job — response body — tag failed failed tag path path |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: download_failed |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: invalid_url |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: not_found |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?:path|download_failed|invalid_url|not_found)$) |
Referenced models: Check the status of a save url job — response body — tag failed failed tag path path
Check the status of a save url job — response body — tag failed failed tag path path
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: no_write_permission, insufficient_space, disallowed_name, team_folder, operation_suppressed, too_many_write_operations, access_restricted, team_folder_insufficient_space, member_folder_insufficient_space, upload_traffic_limit_reached |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: malformed_path |
$ (anyOf 2).malformed_path | Model | Optional | Expand Check the status of a save url job — response body — tag failed failed tag path path tag malformed path malformed path |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: conflict |
$ (anyOf 3).conflict | Model | Required within parent | Expand Check the status of a save url job — response body — tag failed failed tag path path tag conflict conflict |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: no_write_permission |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: insufficient_space |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: disallowed_name |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: team_folder |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: operation_suppressed |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: too_many_write_operations |
$ (anyOf 10) | object | Alternative | |
$ (anyOf 10)..tag | string | Required within parent | Must equal: access_restricted |
$ (anyOf 11) | object | Alternative | |
$ (anyOf 11)..tag | string | Required within parent | Must equal: team_folder_insufficient_space |
$ (anyOf 12) | object | Alternative | |
$ (anyOf 12)..tag | string | Required within parent | Must equal: member_folder_insufficient_space |
$ (anyOf 13) | object | Alternative | |
$ (anyOf 13)..tag | string | Required within parent | Must equal: upload_traffic_limit_reached |
$ (anyOf 14) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 14)..tag | string | Required within parent | Pattern: ^(?!(?:malformed_path|conflict|no_write_permission|insufficient_space|disallowed_name|team_folder|operation_suppressed|too_many_write_operations|access_restricted|team_folder_insufficient_space|member_folder_insufficient_space|upload_traffic_limit_reached)$) |
Referenced models: Check the status of a save url job — response body — tag failed failed tag path path tag malformed path malformed path, Check the status of a save url job — response body — tag failed failed tag path path tag conflict conflict
Check the status of a save url job — response body — tag failed failed tag path path tag conflict conflict
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: file, folder, file_ancestor |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: file |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: folder |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: file_ancestor |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:file|folder|file_ancestor)$) |
Check the status of a save url job — response body — tag failed failed tag path path tag malformed path malformed path
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | |
$ (anyOf 2) | null | Alternative | |
Copy a file or folder to a different location in the user's Dropbox — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
from_path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?)|(id:.*))$ |
to_path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?)|(id:.*))$ |
allow_shared_folder | boolean | Optional | |
autorename | boolean | Optional | |
allow_ownership_transfer | boolean | Optional | |
Copy multiple files or folders to different locations at once in the user's Dropbox — request body — body
Referenced models: Copy multiple files or folders to different locations at once in the user's Dropbox — request body — body entries item
Copy multiple files or folders to different locations at once in the user's Dropbox — request body — body entries item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
from_path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?)|(id:.*))$ |
to_path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?)|(id:.*))$ |
Copy multiple files or folders to different locations at once in the user's Dropbox — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Result returned by copy_batch:2 or move_batch:2 that may either launch an asynchronous job or complete synchronously. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: async_job_id |
$ (anyOf 1).async_job_id | string | Required within parent | Minimum length: 1 |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: complete |
$ (anyOf 2).entries | array | Required within parent | |
$ (anyOf 2).entries[] | Model | Each item | Expand Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item |
Referenced models: Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item
Create a folder at a given path — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
autorename | boolean | Optional | |
Create a folder at a given path — response body
Referenced models: Create a folder at a given path — response body — metadata
Create a folder at a given path — response body — metadata
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
name | string | Required within parent | |
path_lower | JSON | Optional | |
path_lower (anyOf 1) | string | Alternative | |
path_lower (anyOf 2) | null | Alternative | |
path_display | JSON | Optional | |
path_display (anyOf 1) | string | Alternative | |
path_display (anyOf 2) | null | Alternative | |
parent_shared_folder_id | JSON | Optional | |
parent_shared_folder_id (anyOf 1) | string | Alternative | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
parent_shared_folder_id (anyOf 2) | null | Alternative | |
preview_url | JSON | Optional | |
preview_url (anyOf 1) | string | Alternative | |
preview_url (anyOf 2) | null | Alternative | |
id | string | Required within parent | Minimum length: 1 |
shared_folder_id | JSON | Optional | |
shared_folder_id (anyOf 1) | string | Alternative | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
shared_folder_id (anyOf 2) | null | Alternative | |
sharing_info | JSON | Optional | |
sharing_info (anyOf 1) | Model | Alternative | Expand Create a folder at a given path — response body — metadata sharing info no access, parent shared folder id, read only, shared folder id, traverse only |
sharing_info (anyOf 2) | null | Alternative | |
property_groups | JSON | Optional | |
property_groups (anyOf 1) | array | Alternative | |
property_groups (anyOf 1)[] | Model | Each item | Expand Add property groups to a Dropbox file — request body — body property groups item |
property_groups (anyOf 2) | null | Alternative | |
Referenced models: Add property groups to a Dropbox file — request body — body property groups item, Create a folder at a given path — response body — metadata sharing info no access, parent shared folder id, read only, shared folder id, traverse only
Create a folder at a given path — response body — metadata sharing info no access, parent shared folder id, read only, shared folder id, traverse only
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Sharing info for a folder which is contained in a shared folder or is a shared folder mount point. |
read_only | boolean | Required within parent | |
parent_shared_folder_id | JSON | Optional | |
parent_shared_folder_id (anyOf 1) | string | Alternative | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
parent_shared_folder_id (anyOf 2) | null | Alternative | |
shared_folder_id | JSON | Optional | |
shared_folder_id (anyOf 1) | string | Alternative | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
shared_folder_id (anyOf 2) | null | Alternative | |
traverse_only | boolean | Optional | |
no_access | boolean | Optional | |
Create a new file with the contents provided in the request — request body — headers Dropbox-API-Arg
Referenced models: Add property groups to a Dropbox file — request body — body property groups item, Get a one-time use temporary upload link to upload a file to a Dropbox location — request body — body commit info mode
Create multiple folders at once — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
paths | array | Required within parent | Maximum items: 10000 |
paths[] | string | Each item | Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
autorename | boolean | Optional | |
force_async | boolean | Optional | |
Create multiple folders at once — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Result returned by create_folder_batch that may either launch an asynchronous job or complete synchronously. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: async_job_id |
$ (anyOf 1).async_job_id | string | Required within parent | Minimum length: 1 |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: complete |
$ (anyOf 2).entries | array | Required within parent | |
$ (anyOf 2).entries[] | Model | Each item | Expand Create multiple folders at once — response body — tag complete entries item |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:async_job_id|complete)$) |
Referenced models: Create multiple folders at once — response body — tag complete entries item
Create multiple folders at once — response body — tag complete entries item
Referenced models: Create a folder at a given path — response body — metadata, Create multiple folders at once — response body — tag complete entries item tag failure failure
Create multiple folders at once — response body — tag complete entries item tag failure failure
Referenced models: Check the status of a save url job — response body — tag failed failed tag path path
Creates a new Paper doc with the provided content — request body — headers Dropbox-API-Arg
Referenced models: Creates a new Paper doc with the provided content — request body — headers Dropbox-API-Arg import format
Creates a new Paper doc with the provided content — request body — headers Dropbox-API-Arg import format
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | The import format of the incoming Paper doc content. |
$ (anyOf 1) | string | Alternative | One of: html, markdown, plain_text |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: html |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: markdown |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: plain_text |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:html|markdown|plain_text)$) |
Creates a new Paper doc with the provided content — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
url | string | Required within parent | |
result_path | string | Required within parent | |
file_id | string | Required within parent | Minimum length: 4
Pattern: ^(?:id:.+)$ |
paper_revision | JSON | Required within parent | |
paper_revision (anyOf 1) | integer | Alternative | |
paper_revision (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Delete multiple files folders at once — request body — body
Referenced models: Delete the file or folder at a given path — request body — body
Delete multiple files folders at once — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Result returned by delete_batch that may either launch an asynchronous job or complete synchronously. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: async_job_id |
$ (anyOf 1).async_job_id | string | Required within parent | Minimum length: 1 |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: complete |
$ (anyOf 2).entries | array | Required within parent | |
$ (anyOf 2).entries[] | Model | Each item | Expand Delete multiple files folders at once — response body — tag complete entries item |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:async_job_id|complete)$) |
Referenced models: Delete multiple files folders at once — response body — tag complete entries item
Delete multiple files folders at once — response body — tag complete entries item
Referenced models: Delete multiple files folders at once — response body — tag complete entries item tag failure failure, Returns the metadata for a file or folder — response body
Delete multiple files folders at once — response body — tag complete entries item tag failure failure
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: too_many_write_operations, too_many_files |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: path_lookup |
$ (anyOf 2).path_lookup | Model | Required within parent | Expand Get thumbnails for a list of images — response body — entries item tag failure failure tag path path |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: path_write |
$ (anyOf 3).path_write | Model | Required within parent | Expand Check the status of a save url job — response body — tag failed failed tag path path |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: too_many_write_operations |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: too_many_files |
$ (anyOf 6) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 6)..tag | string | Required within parent | Pattern: ^(?!(?:path_lookup|path_write|too_many_write_operations|too_many_files)$) |
Referenced models: Get thumbnails for a list of images — response body — entries item tag failure failure tag path path, Check the status of a save url job — response body — tag failed failed tag path path
Delete the file or folder at a given path — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?)|(id:.*))$ |
parent_rev | JSON | Optional | |
parent_rev (anyOf 1) | string | Alternative | Minimum length: 9
Pattern: ^(?:[0-9a-f]+)$ |
parent_rev (anyOf 2) | null | Alternative | |
Delete the file or folder at a given path — response body
Referenced models: Returns the metadata for a file or folder — response body
Export a file from a user's Dropbox — request body — headers Dropbox-API-Arg
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
export_format | JSON | Optional | |
export_format (anyOf 1) | string | Alternative | |
export_format (anyOf 2) | null | Alternative | |
Finish an upload session and save the uploaded data to the given file path — request body — headers Dropbox-API-Arg
Referenced models: Get a one-time use temporary upload link to upload a file to a Dropbox location — request body — body commit info, Append more data to an upload session — request body — headers Dropbox-API-Arg cursor
Get a copy reference to a file or folder — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
Get a copy reference to a file or folder — response body
Referenced models: Returns the metadata for a file or folder — response body
Get a one-time use temporary upload link to upload a file to a Dropbox location — request body — body
Referenced models: Get a one-time use temporary upload link to upload a file to a Dropbox location — request body — body commit info
Get a one-time use temporary upload link to upload a file to a Dropbox location — request body — body commit info
Referenced models: Add property groups to a Dropbox file — request body — body property groups item, Get a one-time use temporary upload link to upload a file to a Dropbox location — request body — body commit info mode
Get a one-time use temporary upload link to upload a file to a Dropbox location — request body — body commit info mode
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | 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. |
$ (anyOf 1) | string | Alternative | One of: add, overwrite |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: add |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: overwrite |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: update |
$ (anyOf 4).update | string | Required within parent | Minimum length: 9
Pattern: ^(?:[0-9a-f]+)$ |
Get a one-time use temporary upload link to upload a file to a Dropbox location — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
link | string | Required within parent | |
Get a preview for a file — request body — headers Dropbox-API-Arg
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
rev | JSON | Optional | |
rev (anyOf 1) | string | Alternative | Minimum length: 9
Pattern: ^(?:[0-9a-f]+)$ |
rev (anyOf 2) | null | Alternative | |
Get a temporary link to stream content of a file — response body
Referenced models: Restore a specific revision of a file to the given path — response body
Get a thumbnail for an image — files get Thumbnail V2 — request body — headers Dropbox-API-Arg
Referenced models: Get a thumbnail for an image — files get Thumbnail V2 — request body — headers Dropbox-API-Arg resource, Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg format, Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg mode, Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg size
Get a thumbnail for an image — files get Thumbnail V2 — request body — headers Dropbox-API-Arg resource
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: path |
$ (anyOf 1).path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: link |
$ (anyOf 2).url | string | Required within parent | |
$ (anyOf 2).path | JSON | Optional | |
$ (anyOf 2).path (anyOf 1) | string | Alternative | |
$ (anyOf 2).path (anyOf 2) | null | Alternative | |
$ (anyOf 2).password | JSON | Optional | |
$ (anyOf 2).password (anyOf 1) | string | Alternative | |
$ (anyOf 2).password (anyOf 2) | null | Alternative | |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:path|link)$) |
Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg
Referenced models: Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg format, Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg mode, Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg size
Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg format
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: jpeg, png, webp |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: jpeg |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: png |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: webp |
Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg mode
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: strict, bestfit, fitone_bestfit, original |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: strict |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: bestfit |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: fitone_bestfit |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: original |
Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg size
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: w32h32, w64h64, w128h128, w256h256, w480h320, w640h480, w960h640, w1024h768, w2048h1536 |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: w32h32 |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: w64h64 |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: w128h128 |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: w256h256 |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: w480h320 |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: w640h480 |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: w960h640 |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: w1024h768 |
$ (anyOf 10) | object | Alternative | |
$ (anyOf 10)..tag | string | Required within parent | Must equal: w2048h1536 |
Get list of tags assigned to items — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
paths | array | Required within parent | |
paths[] | string | Each item | Pattern: ^(?:/(.|[\r\n])*)$ |
Get list of tags assigned to items — response body
Referenced models: Get list of tags assigned to items — response body — paths to tags item
Get list of tags assigned to items — response body — paths to tags item
Referenced models: Get list of tags assigned to items — response body — paths to tags item tags item
Get list of tags assigned to items — response body — paths to tags item tags item
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Tag that can be added in multiple ways. |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: user_generated_tag |
$ (anyOf 1).tag_text | string | Required within parent | Maximum length: 32
Minimum length: 1
Pattern: ^(?:[\w]+)$ |
$ (anyOf 2) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 2)..tag | string | Required within parent | Pattern: ^(?!(?:user_generated_tag)$) |
Get thumbnails for a list of images — request body — body
Referenced models: Get a thumbnail for an image — files get Thumbnail — request body — headers Dropbox-API-Arg
Get thumbnails for a list of images — response body
Referenced models: Get thumbnails for a list of images — response body — entries item
Get thumbnails for a list of images — response body — entries item
Referenced models: Restore a specific revision of a file to the given path — response body, Get thumbnails for a list of images — response body — entries item tag failure failure
Get thumbnails for a list of images — response body — entries item tag failure failure
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: unsupported_extension, unsupported_image, encrypted_content, conversion_error |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: path |
$ (anyOf 2).path | Model | Required within parent | Expand Get thumbnails for a list of images — response body — entries item tag failure failure tag path path |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: unsupported_extension |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: unsupported_image |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: encrypted_content |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: conversion_error |
Referenced models: Get thumbnails for a list of images — response body — entries item tag failure failure tag path path
Get thumbnails for a list of images — response body — entries item tag failure failure tag path path
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: not_found, not_file, not_folder, restricted_content, unsupported_content_type, locked |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: malformed_path |
$ (anyOf 2).malformed_path | Model | Optional | Expand Check the status of a save url job — response body — tag failed failed tag path path tag malformed path malformed path |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: not_found |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: not_file |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: not_folder |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: restricted_content |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: unsupported_content_type |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: locked |
$ (anyOf 9) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 9)..tag | string | Required within parent | Pattern: ^(?!(?:malformed_path|not_found|not_file|not_folder|restricted_content|unsupported_content_type|locked)$) |
Referenced models: Check the status of a save url job — response body — tag failed failed tag path path tag malformed path malformed path
Lock the files at the given paths — request body — body
Referenced models: Lock the files at the given paths — request body — body entries item
Lock the files at the given paths — request body — body entries item
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?)|(id:.*))$ |
Lock the files at the given paths — response body
Referenced models: Lock the files at the given paths — response body — entries item
Lock the files at the given paths — response body — entries item
Referenced models: Lock the files at the given paths — response body — entries item tag success lock, Lock the files at the given paths — response body — entries item tag failure failure, Returns the metadata for a file or folder — response body
Lock the files at the given paths — response body — entries item tag failure failure
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: too_many_write_operations, too_many_files, no_write_permission, cannot_be_locked, file_not_shared, internal_error |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: path_lookup |
$ (anyOf 2).path_lookup | Model | Required within parent | Expand Get thumbnails for a list of images — response body — entries item tag failure failure tag path path |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: too_many_write_operations |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: too_many_files |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: no_write_permission |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: cannot_be_locked |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: file_not_shared |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: lock_conflict |
$ (anyOf 8).lock | Model | Required within parent | Expand Lock the files at the given paths — response body — entries item tag success lock |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: internal_error |
$ (anyOf 10) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 10)..tag | string | Required within parent | Pattern: ^(?!(?:path_lookup|too_many_write_operations|too_many_files|no_write_permission|cannot_be_locked|file_not_shared|lock_conflict|internal_error)$) |
Referenced models: Lock the files at the given paths — response body — entries item tag success lock, Get thumbnails for a list of images — response body — entries item tag failure failure tag path path
Lock the files at the given paths — response body — entries item tag success lock
Referenced models: Lock the files at the given paths — response body — entries item tag success lock content
Lock the files at the given paths — response body — entries item tag success lock content
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: unlocked |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: unlocked |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: single_user |
$ (anyOf 3).created | string | Required within parent | |
$ (anyOf 3).lock_holder_account_id | string | Required within parent | Maximum length: 40
Minimum length: 40 |
$ (anyOf 3).lock_holder_team_id | JSON | Optional | |
$ (anyOf 3).lock_holder_team_id (anyOf 1) | string | Alternative | |
$ (anyOf 3).lock_holder_team_id (anyOf 2) | null | Alternative | |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:unlocked|single_user)$) |
Move multiple files or folders to different locations at once in the user's Dropbox — request body — body
Referenced models: Copy multiple files or folders to different locations at once in the user's Dropbox — request body — body entries item
Restore a specific revision of a file to the given path — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*)|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
rev | string | Required within parent | Minimum length: 9
Pattern: ^(?:[0-9a-f]+)$ |
Restore a specific revision of a file to the given path — response body
Referenced models: Add property groups to a Dropbox file — request body — body property groups item, Restore a specific revision of a file to the given path — response body — export info Export information for a file, Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name, Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only, Restore a specific revision of a file to the given path — response body — symlink info target, Restore a specific revision of a file to the given path — response body — media info value
Restore a specific revision of a file to the given path — response body — export info Export information for a file
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Export information for a file. |
export_as | JSON | Optional | |
export_as (anyOf 1) | string | Alternative | |
export_as (anyOf 2) | null | Alternative | |
export_options | JSON | Optional | |
export_options (anyOf 1) | array | Alternative | |
export_options (anyOf 1)[] | string | Each item | |
export_options (anyOf 2) | null | Alternative | |
Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
is_lockholder | JSON | Optional | |
is_lockholder (anyOf 1) | boolean | Alternative | |
is_lockholder (anyOf 2) | null | Alternative | |
lockholder_name | JSON | Optional | |
lockholder_name (anyOf 1) | string | Alternative | |
lockholder_name (anyOf 2) | null | Alternative | |
lockholder_account_id | JSON | Optional | |
lockholder_account_id (anyOf 1) | string | Alternative | Maximum length: 40
Minimum length: 40 |
lockholder_account_id (anyOf 2) | null | Alternative | |
created | JSON | Optional | |
created (anyOf 1) | string | Alternative | |
created (anyOf 2) | null | Alternative | |
Restore a specific revision of a file to the given path — response body — media info value
Referenced models: Restore a specific revision of a file to the given path — response body — media info value tag metadata metadata
Restore a specific revision of a file to the given path — response body — media info value tag metadata metadata
Referenced models: Restore a specific revision of a file to the given path — response body — media info value tag metadata metadata tag photo dimensions Dimensions for a photo or video, Restore a specific revision of a file to the given path — response body — media info value tag metadata metadata tag photo location GPS coordinates for a photo or video
Restore a specific revision of a file to the given path — response body — media info value tag metadata metadata tag photo dimensions Dimensions for a photo or video
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Dimensions for a photo or video. |
height | JSON | Required within parent | |
height (anyOf 1) | integer | Alternative | Minimum: 0 |
height (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
width | JSON | Required within parent | |
width (anyOf 1) | integer | Alternative | Minimum: 0 |
width (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Restore a specific revision of a file to the given path — response body — media info value tag metadata metadata tag photo location GPS coordinates for a photo or video
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | GPS coordinates for a photo or video. |
latitude | JSON | Required within parent | |
latitude (anyOf 1) | number | Alternative | |
latitude (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
longitude | JSON | Required within parent | |
longitude (anyOf 1) | number | Alternative | |
longitude (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | Sharing info for a file which is contained by a shared folder. |
read_only | boolean | Required within parent | |
parent_shared_folder_id | string | Required within parent | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
modified_by | JSON | Optional | |
modified_by (anyOf 1) | string | Alternative | Maximum length: 40
Minimum length: 40 |
modified_by (anyOf 2) | null | Alternative | |
Restore a specific revision of a file to the given path — response body — symlink info target
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
target | string | Required within parent | |
Returns revisions for files based on a file path or a file id — request body — body
Referenced models: Returns revisions for files based on a file path or a file id — request body — body mode
Returns revisions for files based on a file path or a file id — request body — body mode
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: path, id |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: path |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: id |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:path|id)$) |
Returns revisions for files based on a file path or a file id — response body
Referenced models: Restore a specific revision of a file to the given path — response body
Returns the metadata for a file or folder — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:(/(.|[\r\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
include_media_info | boolean | Optional | |
include_deleted | boolean | Optional | |
include_has_explicit_shared_members | boolean | Optional | |
include_property_groups | JSON | Optional | |
include_property_groups (anyOf 1) | Model | Alternative | Expand Returns the metadata for a file or folder — request body — body include property groups value |
include_property_groups (anyOf 2) | null | Alternative | |
Referenced models: Returns the metadata for a file or folder — request body — body include property groups value
Returns the metadata for a file or folder — request body — body include property groups value
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | |
$ (anyOf 1)..tag | string | Required within parent | Must equal: filter_some |
$ (anyOf 1).filter_some | array | Required within parent | Minimum items: 1 |
$ (anyOf 1).filter_some[] | string | Each item | Minimum length: 1
Pattern: ^(?:(/|ptid:).*)$ |
$ (anyOf 2) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 2)..tag | string | Required within parent | Pattern: ^(?!(?:filter_some)$) |
Returns the metadata for a file or folder — response body
Referenced models: Add property groups to a Dropbox file — request body — body property groups item, Restore a specific revision of a file to the given path — response body — export info Export information for a file, Restore a specific revision of a file to the given path — response body — file lock info created, is lockholder, lockholder account id, lockholder name, Restore a specific revision of a file to the given path — response body — sharing info modified by, parent shared folder id, read only, Restore a specific revision of a file to the given path — response body — symlink info target, Restore a specific revision of a file to the given path — response body — media info value, Returns the metadata for a file or folder — response body — tag deleted, Returns the metadata for a file or folder — response body — tag folder
Returns the metadata for a file or folder — response body — tag deleted
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
.tag | string | Required within parent | Must equal: deleted |
name | string | Required within parent | |
path_lower | JSON | Optional | |
path_lower (anyOf 1) | string | Alternative | |
path_lower (anyOf 2) | null | Alternative | |
path_display | JSON | Optional | |
path_display (anyOf 1) | string | Alternative | |
path_display (anyOf 2) | null | Alternative | |
parent_shared_folder_id | JSON | Optional | |
parent_shared_folder_id (anyOf 1) | string | Alternative | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
parent_shared_folder_id (anyOf 2) | null | Alternative | |
preview_url | JSON | Optional | |
preview_url (anyOf 1) | string | Alternative | |
preview_url (anyOf 2) | null | Alternative | |
is_restorable | JSON | Optional | |
is_restorable (anyOf 1) | boolean | Alternative | |
is_restorable (anyOf 2) | null | Alternative | |
Returns the metadata for a file or folder — response body — tag folder
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
.tag | string | Required within parent | Must equal: folder |
name | string | Required within parent | |
path_lower | JSON | Optional | |
path_lower (anyOf 1) | string | Alternative | |
path_lower (anyOf 2) | null | Alternative | |
path_display | JSON | Optional | |
path_display (anyOf 1) | string | Alternative | |
path_display (anyOf 2) | null | Alternative | |
parent_shared_folder_id | JSON | Optional | |
parent_shared_folder_id (anyOf 1) | string | Alternative | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
parent_shared_folder_id (anyOf 2) | null | Alternative | |
preview_url | JSON | Optional | |
preview_url (anyOf 1) | string | Alternative | |
preview_url (anyOf 2) | null | Alternative | |
id | string | Required within parent | Minimum length: 1 |
shared_folder_id | JSON | Optional | |
shared_folder_id (anyOf 1) | string | Alternative | Pattern: ^(?:[-_0-9a-zA-Z:]+)$ |
shared_folder_id (anyOf 2) | null | Alternative | |
sharing_info | JSON | Optional | |
sharing_info (anyOf 1) | Model | Alternative | Expand Create a folder at a given path — response body — metadata sharing info no access, parent shared folder id, read only, shared folder id, traverse only |
sharing_info (anyOf 2) | null | Alternative | |
property_groups | JSON | Optional | |
property_groups (anyOf 1) | array | Alternative | |
property_groups (anyOf 1)[] | Model | Each item | Expand Add property groups to a Dropbox file — request body — body property groups item |
property_groups (anyOf 2) | null | Alternative | |
Referenced models: Add property groups to a Dropbox file — request body — body property groups item, Create a folder at a given path — response body — metadata sharing info no access, parent shared folder id, read only, shared folder id, traverse only
Returns the status of an asynchronous job for copy batch:2 — response body
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Result returned by copy_batch/check:2 or move_batch/check:2 that may either be in progress or completed with result for each entry. |
$ (anyOf 1) | string | Alternative | Known values: in_progress |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: in_progress |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: complete |
$ (anyOf 3).entries | array | Required within parent | |
$ (anyOf 3).entries[] | Model | Each item | Expand Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item |
Referenced models: Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item
Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item
Referenced models: Returns the metadata for a file or folder — response body, Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure
Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: internal_error, too_many_write_operations |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: relocation_error |
$ (anyOf 2).relocation_error | Model | Required within parent | Expand Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: internal_error |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: too_many_write_operations |
$ (anyOf 5) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 5)..tag | string | Required within parent | Pattern: ^(?!(?:relocation_error|internal_error|too_many_write_operations)$) |
Referenced models: Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error
Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: cant_copy_shared_folder, cant_nest_shared_folder, cant_move_folder_into_itself, too_many_files, duplicated_or_nested_paths, cant_transfer_ownership, insufficient_quota, internal_error, cant_move_shared_folder, team_folder_insufficient_quota, member_folder_insufficient_quota |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: from_lookup |
$ (anyOf 2).from_lookup | Model | Required within parent | Expand Get thumbnails for a list of images — response body — entries item tag failure failure tag path path |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: from_write |
$ (anyOf 3).from_write | Model | Required within parent | Expand Check the status of a save url job — response body — tag failed failed tag path path |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: to |
$ (anyOf 4).to | Model | Required within parent | Expand Check the status of a save url job — response body — tag failed failed tag path path |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: cant_copy_shared_folder |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: cant_nest_shared_folder |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: cant_move_folder_into_itself |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: too_many_files |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: duplicated_or_nested_paths |
$ (anyOf 10) | object | Alternative | |
$ (anyOf 10)..tag | string | Required within parent | Must equal: cant_transfer_ownership |
$ (anyOf 11) | object | Alternative | |
$ (anyOf 11)..tag | string | Required within parent | Must equal: insufficient_quota |
$ (anyOf 12) | object | Alternative | |
$ (anyOf 12)..tag | string | Required within parent | Must equal: internal_error |
$ (anyOf 13) | object | Alternative | |
$ (anyOf 13)..tag | string | Required within parent | Must equal: cant_move_shared_folder |
$ (anyOf 14) | object | Alternative | |
$ (anyOf 14)..tag | string | Required within parent | Must equal: cant_move_into_vault |
$ (anyOf 14).cant_move_into_vault | Model | Required within parent | Expand Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error tag cant move into vault cant move into vault |
$ (anyOf 15) | object | Alternative | |
$ (anyOf 15)..tag | string | Required within parent | Must equal: cant_move_into_family |
$ (anyOf 15).cant_move_into_family | Model | Required within parent | Expand Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error tag cant move into family cant move into family |
$ (anyOf 16) | object | Alternative | |
$ (anyOf 16)..tag | string | Required within parent | Must equal: team_folder_insufficient_quota |
$ (anyOf 17) | object | Alternative | |
$ (anyOf 17)..tag | string | Required within parent | Must equal: member_folder_insufficient_quota |
$ (anyOf 18) | Model | Alternative | Expand Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error tag |
Referenced models: Get thumbnails for a list of images — response body — entries item tag failure failure tag path path, Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error tag cant move into family cant move into family, Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error tag cant move into vault cant move into vault, Check the status of a save url job — response body — tag failed failed tag path path, Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error tag
Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error tag
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | A tag this contract version does not list (Dropbox's other). |
.tag | string | Required within parent | Pattern: ^(?!(?:from_lookup|from_write|to|cant_copy_shared_folder|cant_nest_shared_folder|cant_move_folder_into_itself|too_many_files|duplicated_or_nested_paths|cant_transfer_ownership|insufficient_quota|internal_error|cant_move_shared_folder|cant_move_into_vault|cant_move_into_family|team_folder_insufficient_quota|member_folder_insufficient_quota)$) |
Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error tag cant move into family cant move into family
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: is_shared_folder |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: is_shared_folder |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:is_shared_folder)$) |
Returns the status of an asynchronous job for copy batch:2 — response body — tag complete entries item tag failure failure tag relocation error relocation error tag cant move into vault cant move into vault
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | Deprecated: the server no longer emits this error. |
$ (anyOf 1) | string | Alternative | Known values: is_shared_folder |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: is_shared_folder |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:is_shared_folder)$) |
Returns the status of an asynchronous job for create folder batch — response body
Referenced models: Returns the status of an asynchronous job for create folder batch — response body — tag failed failed, Create multiple folders at once — response body — tag complete entries item
Returns the status of an asynchronous job for create folder batch — response body — tag failed failed
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: too_many_files |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: too_many_files |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:too_many_files)$) |
Returns the status of an asynchronous job for delete batch — response body
Referenced models: Returns the status of an asynchronous job for delete batch — response body — tag failed failed, Delete multiple files folders at once — response body — tag complete entries item
Returns the status of an asynchronous job for delete batch — response body — tag failed failed
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | Known values: too_many_write_operations |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: too_many_write_operations |
$ (anyOf 3) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 3)..tag | string | Required within parent | Pattern: ^(?!(?:too_many_write_operations)$) |
Returns the status of an asynchronous job for upload session finish batch — response body
Referenced models: This route helps you commit many files at once into a user's Dropbox — response body — entries item
Save a copy reference returned by copy reference get to the user's Dropbox — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
copy_reference | string | Required within parent | |
path | string | Required within parent | Pattern: ^(?:/(.|[\r\n])*)$ |
Save the data from a specified URL into a file in user's Dropbox — request body — body
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | string | Required within parent | Pattern: ^(?:/(.|[\r\n])*)$ |
url | string | Required within parent | |
Save the data from a specified URL into a file in user's Dropbox — response body
Referenced models: Check the status of a save url job — response body — tag complete
Searches for files and folders — request body — body
Referenced models: Searches for files and folders — request body — body match field options include highlights, Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path
Searches for files and folders — request body — body match field options include highlights
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
include_highlights | boolean | Optional | |
Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path
| Field | Type | Presence | Description and constraints |
|---|
$ | object | Root | |
path | JSON | Optional | |
path (anyOf 1) | string | Alternative | Pattern: ^(?:(/(.|[\r\n])*)?|id:.*|(ns:[0-9]+(/(.|[\r\n])*)?))$ |
path (anyOf 2) | null | Alternative | |
max_results | integer | Optional | Minimum: 1
Maximum: 1000 |
order_by | JSON | Optional | |
order_by (anyOf 1) | Model | Alternative | Expand Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path order by value |
order_by (anyOf 2) | null | Alternative | |
file_status | Model | Optional | Expand Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path file status |
filename_only | boolean | Optional | |
file_extensions | JSON | Optional | |
file_extensions (anyOf 1) | array | Alternative | |
file_extensions (anyOf 1)[] | string | Each item | |
file_extensions (anyOf 2) | null | Alternative | |
file_categories | JSON | Optional | |
file_categories (anyOf 1) | array | Alternative | |
file_categories (anyOf 1)[] | Model | Each item | Expand Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path file categories array item |
file_categories (anyOf 2) | null | Alternative | |
account_id | JSON | Optional | |
account_id (anyOf 1) | string | Alternative | Maximum length: 40
Minimum length: 40 |
account_id (anyOf 2) | null | Alternative | |
Referenced models: Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path file categories array item, Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path file status, Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path order by value
Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path file categories array item
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: image, document, pdf, spreadsheet, presentation, audio, video, folder, paper, others |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: image |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: document |
$ (anyOf 4) | object | Alternative | |
$ (anyOf 4)..tag | string | Required within parent | Must equal: pdf |
$ (anyOf 5) | object | Alternative | |
$ (anyOf 5)..tag | string | Required within parent | Must equal: spreadsheet |
$ (anyOf 6) | object | Alternative | |
$ (anyOf 6)..tag | string | Required within parent | Must equal: presentation |
$ (anyOf 7) | object | Alternative | |
$ (anyOf 7)..tag | string | Required within parent | Must equal: audio |
$ (anyOf 8) | object | Alternative | |
$ (anyOf 8)..tag | string | Required within parent | Must equal: video |
$ (anyOf 9) | object | Alternative | |
$ (anyOf 9)..tag | string | Required within parent | Must equal: folder |
$ (anyOf 10) | object | Alternative | |
$ (anyOf 10)..tag | string | Required within parent | Must equal: paper |
$ (anyOf 11) | object | Alternative | |
$ (anyOf 11)..tag | string | Required within parent | Must equal: others |
$ (anyOf 12) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 12)..tag | string | Required within parent | Pattern: ^(?!(?:image|document|pdf|spreadsheet|presentation|audio|video|folder|paper|others)$) |
Searches for files and folders — request body — body options account id, file categories, file extensions, file status, filename only, max results, order by, path file status
| Field | Type | Presence | Description and constraints |
|---|
$ | JSON | Root | |
$ (anyOf 1) | string | Alternative | One of: active, deleted |
$ (anyOf 2) | object | Alternative | |
$ (anyOf 2)..tag | string | Required within parent | Must equal: active |
$ (anyOf 3) | object | Alternative | |
$ (anyOf 3)..tag | string | Required within parent | Must equal: deleted |
$ (anyOf 4) | object | Alternative | A tag this contract version does not list (Dropbox's other). |
$ (anyOf 4)..tag | string | Required within parent | Pattern: ^(?!(?:active|deleted)$) |
