Elastic Dropbox connector reference

This connector is available as a native connector in Elastic versions 8.10.0 and later.

To use this connector natively in Elastic Cloud, satisfy all native connector requirements.

To use this connector as a native connector, see Native connectors.

For additional operations, see Using connectors.

Before you can configure your connector, you’ll need to:

You’ll need to create an OAuth app in the Dropbox platform by following these steps:

To generate a refresh token, follow these steps:

The following configuration fields are required to set up the connector:

The connector syncs the following objects and entities:

Basic sync rules are identical for all connectors and are available by default.

The following section describes advanced sync rules for this connector.

Advanced sync rules for Dropbox allow you to sync Dropbox files based on a query that matches strings in the filename. You can optionally filter the results of the query by file_extensions or file_categories. When both are provided, priority is given to file_categories. We have some examples below for illustration.

[
  {
    "query": "confidential"
  },
  {
    "query": "dropbox"
  }
]

[
  {
    "query": "dropbox",
    "options": {
      "file_extensions": [
        "txt",
        "pdf"
      ]
    }
  }
]

[
  {
    "query": "test",
    "options": {
      "file_categories": [
        {
          ".tag": "paper"
        },
        {
          ".tag": "png"
        }
      ]
    }
  }
]

Refer to Known issues for a list of known issues for all connectors.

See Troubleshooting for a list of troubleshooting tips for all connectors.

See Security for a list of security tips for all connectors.

See Content extraction.

This connector is available as a self-managed connector client.

This connector client is compatible with Elastic versions 8.9.0+.

To use this connector, satisfy all connector client requirements.

Before you can configure your connector, you’ll need to:

To use this connector as a connector client, see Connector clients.

Once set up, for additional usage operations, see Using connectors.

You’ll need to create an OAuth app in the Dropbox platform by following these steps:

To generate a refresh token, follow these steps:

The following configuration fields are required to set up the connector:

You can deploy the Dropbox connector as a self-managed connector client using Docker. Follow these instructions.

curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml.example --output ~/connectors-config/config.yml

# When connecting to your cloud deployment you should edit the host value
elasticsearch.host: http://host.docker.internal:9200
elasticsearch.api_key: <ELASTICSEARCH_API_KEY>

connectors:
  -
    connector_id: <CONNECTOR_ID_FROM_KIBANA>
    service_type: dropbox
    api_key: <CONNECTOR_API_KEY_FROM_KIBANA>

docker run \
-v ~/connectors-config:/config \
--network "elastic" \
--tty \
--rm \
docker.elastic.co/enterprise-search/elastic-connectors:8.11.4.0 \
/app/bin/elastic-ingest \
-c /config/config.yml

Refer to DOCKER.md in the elastic/connectors repo for more details.

Find all available Docker images in the official registry.

The connector syncs the following objects and entities:

Basic sync rules are identical for all connectors and are available by default.

The following section describes advanced sync rules for this connector.

Advanced sync rules for Dropbox allow you to sync Dropbox files based on a query that matches strings in the filename. You can optionally filter the results of the query by file_extensions or file_categories. When both are provided, priority is given to file_categories. We have some examples below for illustration.

[
  {
    "query": "confidential"
  },
  {
    "query": "dropbox"
  }
]

[
  {
    "query": "dropbox",
    "options": {
      "file_extensions": [
        "txt",
        "pdf"
      ]
    }
  }
]

[
  {
    "query": "test",
    "options": {
      "file_categories": [
        {
          ".tag": "paper"
        },
        {
          ".tag": "png"
        }
      ]
    }
  }
]

The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.

To perform E2E testing for the Dropbox connector, run the following command:

$ make ftest NAME=dropbox

For faster tests, add the DATA_SIZE=small flag:

make ftest NAME=dropbox DATA_SIZE=small

Refer to Known issues for a list of known issues for all connectors.

See Troubleshooting for a list of troubleshooting tips for all connectors.

See Security for a list of security tips for all connectors.

See Content extraction.