Dropbox API Configuration
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "dropbox",
"trust_certificates": true,
"trust_fingerprints": true,
"run_setup_tests": true,
"paused": false,
"pause_after_trial": false,
"sync_frequency": 1440,
"data_delay_sensitivity": "NORMAL",
"data_delay_threshold": 0,
"daily_sync_time": "14:00",
"schedule_type": "auto",
"connect_card_config": {
"redirect_uri": "https://your.site/path",
"hide_setup_guide": true
},
"proxy_agent_id": "proxy_agent_id",
"private_link_id": "private_link_id",
"networking_method": "Directly",
"hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
"config": {
"append_file_option": "upsert_file | append_file | upsert_file_with_primary_keys",
"prefix": "folder_path",
"pattern": "file_pattern",
"escape_char": "escape_char",
"json_delivery_mode": "Packed | Unpacked",
"skip_after": 0,
"line_separator": ";",
"skip_before": 0,
"empty_header": true,
"null_sequence": "string",
"folder": "folder_url",
"is_single_table_mode": true,
"delimiter": "|",
"file_type": "csv | log | json | jsonl | infer | tsv | avro | parquet | xml | spreadsheet | unstructured",
"on_error": "fail | skip",
"compression": "bz2 | gz | gzip | zip | tar | tar_bz2 | tar_gz | uncompressed | infer",
"archive_pattern": "regex_pattern",
"schema": "schema_name",
"table": "table_name"
},
"auth": {
"refresh_token": "my_refresh_token",
"client_access": {
"client_secret": "my_client_secret",
"client_id": "my_client_id"
}
}
}Config parameters
| Name | Description |
|---|---|
append_file_option | If you know that the source completely over-writes the same file with new data, you can append the changes instead of upserting based on filename and line number. |
prefix | All files and folders under this folder path will be searched for files to sync. |
pattern | All files in your search path matching this regular expression will be synced. |
escape_char | If your CSV generator follows non-standard rules for escaping quotation marks, you can set the escape character here. |
json_delivery_mode | Control how your JSON data is delivered into your destination |
skip_after | We will skip over the number of lines specified at the end so as to not introduce aberrant data into your destination. |
line_separator | You can specify the custom line separator for your CSV files. The line separator is used in files to separate one row from the next. |
skip_before | We will skip over the number of lines specified before syncing data. |
empty_header | Optional. If your CSV generating software doesn't provide header line for the documents, Fivetran can generate the generic column names and sync data rows with them. |
null_sequence | If your CSVs use a special value indicating null, you can specify it here. |
folder | Your Dropbox Folder URL. |
is_single_table_mode | Allows the creation of connector using Merge Mode strategy. |
delimiter | You can specify the delimiter that your CSVs use here. Fivetran generally tries to infer the delimiter, but in some cases this is impossible. |
file_type | If your files are saved with improper extensions, you can force them to be synced as the selected filetype. |
on_error | If you know that your files contain some errors, you can choose to have poorly formatted lines skipped. We recommend leaving the value as fail unless you are certain that you have undesirable, malformed data. |
compression | The compression format is used to let Fivetran know that even files without a compression extension should be decompressed using the selected compression format. |
archive_pattern | Files inside of compressed archives with filenames matching this regular expression will be synced. |
schema | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
table | Destination table. Table is permanent and cannot be changed after connection creation |
Authorization
There are two ways to authorize this connector type:
By specifying the values for the
client_accessandrefresh_tokenparameters in theauthsection.POST https://api.fivetran.com/v1/connections{ "service": "dropbox", "group_id": "group_id", "auth": { "client_access": { "client_secret": "my_client_secret", "client_id": "my_client_id" }, "refresh_token": "my_refresh_token" } }Auth Parameters
Name Description refresh_tokenThe long-lived Refresh tokenalong with theclient_idandclient_secretparameters carry the information necessary to get a new access token for API resources.client_accessclient_access.client_secretClient Secretof your Dropbox client application.client_access.client_idClient IDof your Dropbox client application.By using the Connect Card or the Fivetran dashboard.