High-Volume Agent SQL Server API Configuration
Request
POST https://api.fivetran.com/v1/connections
{ "group_id": "group_id", "service": "sql_server_hva", "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": { "agent_user": "hvr", "tde_certificate": "string", "update_method": "DIRECT", "agent_password": "agent_password", "agent_public_cert": "CERTIFICATE", "tunnel_port": 22, "database": "oracledb", "password": "test_password", "tde_password": "string", "host": "host.com", "agent_host": "host.com", "sap_schema": "string", "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent", "enable_tde": true, "tde_certificate_name": "string", "always_encrypted": true, "enable_archive_log_only": true, "tunnel_user": "fivetran", "tde_private_key": "string", "auth_method": "WindowsAuth | Password", "port": 1433, "archive_log_format": "string", "tunnel_host": "XXX.XXX.XXX.XXX", "archive_log_path": "string", "agent_port": 4343, "user": "test_user", "schema_prefix": "prefix" } }
Config parameters
| Name | Description |
|---|---|
agent_user | The agent's username. |
tde_certificate | Certificate used to protect a database encryption key |
update_method | (Optional) The incremental update method the connector will use. The possible values are "TELEPORT" or "NATIVE_UPDATE". The type defaults to "NATIVE_UPDATE" if the value is set to null or not specified. |
agent_password | The password for the agent user. |
agent_public_cert | The public certificate generated by the agent. |
tunnel_port | SSH port, specify only to connect via an SSH tunnel. |
database | The database name. |
password | The user's password. |
tde_password | Password of the TDE private key |
host | DB instance host or IP address. |
agent_host | The host address of the machine running the agent. Often the same as the DB host. |
sap_schema | SAP Schema Name. Required only for High-Volume Agent SAP ECC connector. |
connection_type | Possible values: Directly, PrivateLink, 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. |
enable_tde | Using Transparent Data Encryption (TDE) |
tde_certificate_name | Name of the Certificate used to protect a database encryption key |
always_encrypted | Require TLS. |
enable_archive_log_only | Use archive log only mode |
tunnel_user | SSH user, specify only to connect via an SSH tunnel. |
tde_private_key | Private key associated with the TDE certificate |
auth_method | Authentication Method |
port | The port number. |
archive_log_format | Format for archive log file names |
tunnel_host | SSH host, specify only to connect via an SSH tunnel (do not use a load balancer). |
archive_log_path | Directory where archive logs are located |
agent_port | The port that the agent has open for Fivetran's connection. Default value is 4343. |
user | The user name. For Azure Databases, the format must be user@domain. |
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,password,database,agent_host,agent_port,agent_public_cert,agent_userandagent_passwordparameters in the request.POST https://api.fivetran.com/v1/connections{ "service": "sql_server_hva", "group_id": "group_id", "config": { "host": "host.com", "port": 1433, "user": "test_user", "password": "test_password", "database": "oracledb", "agent_host": "host.com", "agent_port": 4343, "agent_public_cert": "CERTIFICATE", "agent_user": "hvr", "agent_password": "agent_password" } } By using the Connect Card or the Fivetran dashboard.