High-Volume Agent SAP ECC on Db2 for i API Configuration Sunset
Request
POST https://api.fivetran.com/v1/connections
{
"group_id": "group_id",
"service": "db2i_sap_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",
"config": {
"agent_user": "hvr",
"connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
"agent_password": "agent_password",
"always_encrypted": true,
"log_journal": "test_log_journal",
"log_journal_schema": "test_log_journal_schema",
"agent_public_cert": "CERTIFICATE",
"tunnel_user": "fivetran",
"tunnel_port": 22,
"database": "db2i",
"password": "test_password",
"port": 8471,
"host": "host.com",
"tunnel_host": "XXX.XXX.XXX.XXX",
"agent_port": 4343,
"agent_host": "host.com",
"user": "test_user",
"sap_schema": "test_sap_schema",
"schema_prefix": "prefix"
}
}Config parameters
| Name | Description |
|---|---|
agent_user | The agent's user. |
connection_type | Possible values: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. |
agent_password | The agent user's password. It must have a minimum length of 10 characters. |
always_encrypted | Require TLS through Tunnel |
log_journal | The log journal name. |
log_journal_schema | The log journal schema. |
agent_public_cert | The agent public certificate. |
tunnel_user | SSH user, specify only to connect via an SSH tunnel. |
tunnel_port | SSH port, specify only to connect via an SSH tunnel. |
database | The database name. |
password | The user's password. |
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). |
agent_port | The port number of the agent. |
agent_host | The host of the agent. This is the same as the database host, since the agent must be installed on the same machine as the source database. |
user | The username. |
sap_schema | SAP schema name. |
schema_prefix | 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,agent_host,agent_port,agent_public_cert,agent_userandagent_passwordparameters in the request.POST https://api.fivetran.com/v1/connections{ "service": "db2i_sap_hva", "group_id": "group_id", "config": { "host": "host.com", "port": 8471, "user": "test_user", "password": "test_password", "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.