HVA SAP ECC on SQL Server API Configuration

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": "sql_server_sap_ecc_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,
    "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": {
    "agent_host": "host.com",
    "agent_password": "agent_password",
    "agent_port": 4343,
    "agent_public_cert": "CERTIFICATE",
    "agent_user": "hvr",
    "always_encrypted": true,
    "archive_log_format": "string",
    "archive_log_path": "string",
    "auth_method": "WindowsAuth | Password",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "database": "oracledb",
    "enable_archive_log_only": true,
    "enable_tde": true,
    "host": "host.com",
    "password": "test_password",
    "port": 1433,
    "sap_schema": "string",
    "server_name": "string",
    "tde_certificate": "string",
    "tde_certificate_name": "string",
    "tde_password": "string",
    "tde_private_key": "string",
    "tunnel_host": "XXX.XXX.XXX.XXX",
    "tunnel_port": 22,
    "tunnel_user": "fivetran",
    "update_method": "DIRECT",
    "user": "test_user",
    "schema_prefix": "prefix"
  }
}

Config parameters

Name	Description
`agent_host`	The host address of the machine running the agent. Often the same as the DB host.
`agent_password`	The password for the agent user.
`agent_port`	The port that the agent has open for Fivetran's connection. Default value is 4343.
`agent_public_cert`	The public certificate generated by the agent.
`agent_user`	The agent's username.
`always_encrypted`	Require TLS.
`archive_log_format`	Format for archive log file names
`archive_log_path`	Directory where archive logs are located
`auth_method`	Authentication Method
`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.
`database`	The database name.
`enable_archive_log_only`	Use archive log only mode
`enable_tde`	Using Transparent Data Encryption (TDE)
`host`	DB instance host or IP address.
`password`	The user's password.
`port`	The port number.
`sap_schema`	SAP Schema Name.
`server_name`	Server name. Used when authenticating with Windows Authentication.
`tde_certificate`	Certificate used to protect a database encryption key
`tde_certificate_name`	Name of the Certificate used to protect a database encryption key
`tde_password`	Password of the TDE private key
`tde_private_key`	Private key associated with the TDE certificate
`tunnel_host`	SSH host, specify only to connect via an SSH tunnel (do not use a load balancer).
`tunnel_port`	SSH port, specify only to connect via an SSH tunnel.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel.
`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.
`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

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