Azure Cosmos DB for MongoDB API Configuration

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "azure_cosmos_for_mongo",
  "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",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "config": {
    "packed_mode_tables": [
      "string"
    ],
    "packing_mode": "UsePackedModeOnly | UseUnpackedModeOnly",
    "binary_representation": "Base64 | Uuid",
    "connection_type": "Directly | PrivateLink",
    "hosts": [
      "string"
    ],
    "always_encrypted": true,
    "tunnel_user": "string",
    "tunnel_port": 0,
    "database": "admin",
    "password": "test_password",
    "tunnel_host": "string",
    "user": "test_user",
    "schema_prefix": "prefix"
  }
}

Config parameters

Name	Description
`packed_mode_tables`	List of tables to be synced in packed mode; format:`<db>.<table>`(case-sensitive).
`packing_mode`	Indicates the desired sync pack mode. Accepted values are `UsePackedModeOnly` and `UseUnpackedModeOnly`. `SelectTablesForPackedMode` is deprecated.
`binary_representation`	How binary data is represented in the database. Possible values: 'Base64' (default), 'Uuid'.
`connection_type`	Possible values:`Directly`, `PrivateLink`. `Directly` is the default value
`hosts`	A list of host addresses for Azure Cosmos DB for Mongo DB.
`always_encrypted`	Require TLS
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`database`	Authentication database for the source. Usually 'admin'.
`password`	Password used for source database authentication.
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`user`	Username for source database access.
`schema_prefix` (required)	Destination schema prefix. Prefix for each replicated schema. For example with prefix 'x', source schemas 'foo' and 'bar' get replicated as 'x_foo' and 'x_bar'. The prefix 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 user and password parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "azure_cosmos_for_mongo",
  "group_id": "group_id",
  "config": {
    "user": "test_user",
    "password": "test_password"
  }
}

By using the Connect Card or the Fivetran dashboard.