Azure SQL Database 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": "azure_sql_db",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "LOW",
  "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,
    "auth_method": "EntraIDServicePrincipalSecret | EntraIDServicePrincipalCertificate | ActiveDirectory | Password",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "database": "sqldb",
    "host": "sqlinstance.mycompany.com",
    "password": "test_password",
    "port": 1433,
    "tenant_id": "your_tenant_id",
    "tunnel_host": "XXX.XXX.XXX.XXX",
    "tunnel_port": 22,
    "tunnel_user": "fivetran",
    "update_method": "NATIVE_UPDATE | TELEPORT",
    "user": "test_user",
    "schema_prefix": "prefix"
  },
  "auth": {
    "access_token": "my_access_token",
    "managed_identity_user_assigned": "managed_identity_user_assigned",
    "refresh_token": "my_refresh_token",
    "service_principal_client_cert_pvt_key": "service_principal_client_cert_pvt_key",
    "service_principal_client_certificate": "service_principal_client_certificate",
    "service_principal_client_secret": "service_principal_client_secret",
    "service_principal_id": "service_principal_id"
  },
  "external_secrets_keys_config": {
    "password": "PASSWORD_KEY",
    "user": "USER_KEY"
  }
}

Config parameters

Name	Description
`always_encrypted`	Require TLS through Tunnel.
`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.
`host`	DB instance host or IP address.
`password`	The user's password.
`port`	The port number.
`tenant_id`	Azure AD tenant ID.
`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

There are six ways to authorize this connector type:

default: By specifying the values for the access_token and refresh_token parameters in the auth section and the values for the auth_method and tenant_id parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "azure_sql_db",
  "group_id": "group_id",
  "config": {
    "auth_method": "EntraIDServicePrincipalSecret | EntraIDServicePrincipalCertificate | ActiveDirectory | Password",
    "tenant_id": "your_tenant_id"
  },
  "auth": {
    "access_token": "my_access_token",
    "refresh_token": "my_refresh_token"
  }
}

Auth Parameters

Name	Description
`access_token`	The long-lived Access token carries the information necessary to access API resources.
`refresh_token`	The long-lived Refresh token carries the information necessary to get a new access token for API resources.

Service Principal + Client Secret: By specifying the values for the service_principal_id and service_principal_client_secret parameters in the auth section and the value for the auth_method parameter in the request.
POST https://api.fivetran.com/v1/connections
```
{
  "service": "azure_sql_db",
  "group_id": "group_id",
  "config": {
    "auth_method": "EntraIDServicePrincipalSecret | EntraIDServicePrincipalCertificate | ActiveDirectory | Password"
  },
  "auth": {
    "service_principal_id": "service_principal_id",
    "service_principal_client_secret": "service_principal_client_secret"
  }
}
```
Auth Parameters
Name Description
service_principal_client_secret Service Principal Client Secret.
service_principal_id Service Principal Client ID.
Service Principal + Client Certificate: By specifying the values for the service_principal_id and service_principal_client_certificate parameters in the auth section and the value for the auth_method parameter in the request.
POST https://api.fivetran.com/v1/connections
```
{
  "service": "azure_sql_db",
  "group_id": "group_id",
  "config": {
    "auth_method": "EntraIDServicePrincipalSecret | EntraIDServicePrincipalCertificate | ActiveDirectory | Password"
  },
  "auth": {
    "service_principal_id": "service_principal_id",
    "service_principal_client_certificate": "service_principal_client_certificate"
  }
}
```
Auth Parameters
Name Description
service_principal_client_certificate Contents of Service Principal Client Certificate.
service_principal_id Service Principal Client ID.
Entra ID Managed Identity: By specifying the value for the managed_identity_user_assigned parameter in the auth section and the value for the auth_method parameter in the request.
POST https://api.fivetran.com/v1/connections
```
{
  "service": "azure_sql_db",
  "group_id": "group_id",
  "config": {
    "auth_method": "EntraIDServicePrincipalSecret | EntraIDServicePrincipalCertificate | ActiveDirectory | Password"
  },
  "auth": {
    "managed_identity_user_assigned": "managed_identity_user_assigned"
  }
}
```
Auth Parameters
Name Description
managed_identity_user_assigned User Assigned Managed Identity Client ID.

Name	Description
`service_principal_client_secret`	Service Principal Client Secret.
`service_principal_id`	Service Principal Client ID.

Name	Description
`service_principal_client_certificate`	Contents of Service Principal Client Certificate.
`service_principal_id`	Service Principal Client ID.

Name	Description
`managed_identity_user_assigned`	User Assigned Managed Identity Client ID.

Username and Password: By specifying the values for the auth_method, user and password parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "azure_sql_db",
  "group_id": "group_id",
  "config": {
    "auth_method": "EntraIDServicePrincipalSecret | EntraIDServicePrincipalCertificate | ActiveDirectory | Password",
    "user": "test_user",
    "password": "test_password"
  }
}

By using the Connect Card or the Fivetran dashboard.