SAP ERP on HANA 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": "sap_hana_db",
  "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,
    "client": "string",
    "connection_type": "PrivateLink | SshTunnel | ProxyAgent",
    "convert_dats_type_to_date": true,
    "database": "string",
    "group": "string",
    "hana_db_port": 30215,
    "host": "string",
    "ms_host": "string",
    "ms_serv": "string",
    "password": "string",
    "port": 0,
    "r3_name": "string",
    "sap_hana_connection_mode": "NETWEAVER | DIRECT",
    "sap_router": "/H/hostname/S/3299",
    "schema_name": "SAPHANADB",
    "snc_certificate_source": "string",
    "snc_mode": "SncUserPass | NoSnc | SncCertificate",
    "snc_source_name": "string",
    "sysnr": "string",
    "tunnel_host": "string",
    "tunnel_port": 0,
    "tunnel_user": "string",
    "use_message_server": true,
    "use_sap_router": true,
    "user": "string",
    "schema_prefix": "prefix"
  },
  "external_secrets_keys_config": {
    "password": "PASSWORD_KEY",
    "user": "USER_KEY"
  }
}

Config parameters

Name	Description
`always_encrypted`
`client`
`connection_type`
`convert_dats_type_to_date`
`database`
`group`	SAP Logon Group name for load balancing
`hana_db_port`	Port number of the SAP HANA database
`host`
`ms_host`	SAP Message Server host name
`ms_serv`	SAP Message Server service port number
`password`
`port`
`r3_name`	SAP System ID (SID)
`sap_hana_connection_mode`	Connection mode for SAP HANA database (DIRECT or NETWEAVER)
`sap_router`	SAP Router connection string (format: /H/hostname/S/port)
`schema_name`	SAP schema name
`snc_certificate_source`
`snc_mode`
`snc_source_name`
`sysnr`
`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.
`use_message_server`	Enable connection via SAP Message Server for load balancing
`use_sap_router`	Enable connection via SAP Router
`user`
`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.