Elastic Cloud API Configuration Beta
For more information about authentication, accessing the Fivetran REST API, and request and response formats, see Getting Started with the Fivetran REST API.
Request
POST https://api.fivetran.com/v1/connections
{ "group_id": "group_id", "service": "elastic_cloud", "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, "all_fields": 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" }, "destination_schema_names": "FIVETRAN_NAMING", "external_secrets_manager_id": "esm_id", "config": { "always_encrypted": true, "authentication_method": "BASICAUTH | APIKEY", "capture_deletes": true, "connection_type": "Directly | SshTunnel", "host": "elasticinstance.mycompany.com", "password": "password", "port": 443, "tunnel_host": "XXX.XXX.XXX.XXX", "tunnel_port": 22, "tunnel_user": "tunnel_user", "user": "user", "schema": "schema_name" }, "auth": { "api_key": "your_elasticsearch_api_key" }, "external_secrets_keys_config": { "api_key": "API_KEY_KEY", "password": "PASSWORD_KEY", "user": "USER_KEY" } }
Config parameters
| Name | Description |
|---|---|
always_encrypted | Default value: true. Set to false if TLS is not required when using an SSH tunnel. |
authentication_method | The authentication method used to connect to your cluster. Supported values: BASICAUTH (default), APIKEY. |
capture_deletes | Whether to capture hard deletes, meaning source documents removed from the index. Set to false to skip hard-delete detection, which may improve connector performance for sources that do not hard-delete documents. This does not affect source-level soft-delete fields; those fields sync as ordinary document updates. If you re-enable delete capture later, resync the affected tables to rebuild an accurate delete baseline. Default value: true. |
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. |
host | DB instance host or IP address. |
password | The user's password. |
port | The port number. |
tunnel_host | SSH host, specify only to connect using an SSH tunnel (do not use a load balancer). |
tunnel_port | SSH port, specify only to connect using an SSH tunnel. |
tunnel_user | SSH user, specify only to connect using an SSH tunnel. |
user | The user name. |
schema (required) | Destination schema name. Schema name is permanent and cannot be changed after connection creation |
Authorization
There are three ways to authorize this connector type:
- Basic: By specifying the values for the
userandpasswordparameters in the request.POST https://api.fivetran.com/v1/connections{ "service": "elastic_cloud", "group_id": "group_id", "config": { "user": "user", "password": "password" } } - API key: By specifying the value for the
api_keyparameter in theauthsection.POST https://api.fivetran.com/v1/connections{ "service": "elastic_cloud", "group_id": "group_id", "auth": { "api_key": "your_elasticsearch_api_key" } }Auth Parameters
Name Description api_keyThe Elasticsearch API key. If omitted, then basic user and password authentication will apply. By using the Connect Card or the Fivetran dashboard.