Open Distro API Configuration Beta

Request

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

{
  "group_id": "group_id",
  "service": "opendistro",
  "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": {
    "tunnel_port": 22,
    "password": "password",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "port": 443,
    "host": "opensearchinstance.mycompany.com",
    "tunnel_host": "XXX.XXX.XXX.XXX",
    "always_encrypted": true,
    "user": "user",
    "tunnel_user": "tunnel_user",
    "schema": "schema_name"
  }
}

Config parameters

Name	Description
`tunnel_port`	SSH port, specify only to connect using an SSH tunnel.
`password`	The user's password.
`connection_type`	Possible values:`Directly`, `SshTunnel`. `SshTunnel` is used as a value if this parameter is omitted in the request and any of the following parameter's values is specified: `tunnel_host`, `tunnel_port`, `tunnel_user`. Otherwise, `Directly` is used as a value if the parameter is omitted.
`port`	The port number.
`host`	DB instance host or IP address.
`tunnel_host`	SSH host, specify only to connect using an SSH tunnel (do not use a load balancer).
`always_encrypted`	Default value: true. Set to false if TLS is not required when using an SSH tunnel.
`user`	The user name.
`tunnel_user`	SSH user, specify only to connect using an SSH tunnel.
`schema`	Destination schema name. Schema name is permanent and cannot be changed after connection creation

Authorization

This type of connector can only be authorized through the Connect Card or through the Fivetran dashboard.