CockroachDB API Configuration
Request
POST https://api.fivetran.com/v1/connections
{ "group_id": "group_id", "service": "cockroachdb", "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" }, "destination_schema_names": "SOURCE_NAMING", "config": { "tunnel_port": 0, "database": "string", "password": "string", "connection_type": "Directly | SshTunnel", "port": 0, "host": "string", "tunnel_host": "string", "always_encrypted": true, "user": "string", "tunnel_user": "string", "schema_prefix": "prefix" } }
Config parameters
| Name | Description |
|---|---|
tunnel_port | SSH port, specify only to connect via an SSH tunnel. |
database | The database name. |
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 via an SSH tunnel (do not use a load balancer). |
always_encrypted | Require TLS |
user | The user name. |
tunnel_user | SSH user, specify only to connect via an SSH tunnel. |
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
host,port,user,passwordanddatabaseparameters in the request.POST https://api.fivetran.com/v1/connections{ "service": "cockroachdb", "group_id": "group_id", "config": { "host": "string", "port": 0, "user": "string", "password": "string", "database": "string" } } By using the Connect Card or the Fivetran dashboard.