MySQL API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "mysql",
  "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": {
    "always_encrypted": true,
    "auth_method": "PASSWORD",
    "client_private_key": "string",
    "client_public_certificate": "string",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "database": "mysqldb",
    "host": "mysqlinstance.mycompany.com",
    "password": "test_password",
    "port": 3306,
    "replica_id": 4573961,
    "tunnel_host": "XXX.XXX.XXX.XXX",
    "tunnel_port": 22,
    "tunnel_user": "fivetran",
    "update_method": "BINLOG | TELEPORT",
    "user": "test_user",
    "schema_prefix": "prefix"
  }
}

Config parameters

Name	Description
`always_encrypted`	Require TLS through Tunnel
`auth_method`	Database authentication method
`client_private_key`	Client Private Key in .pem format.
`client_public_certificate`	Client Certificate in .pem format.
`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.
`replica_id`	Unique ID within the MySQL replica set. Must be an integer different from all other master and replica servers within the same group.
`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`	The method to detect new or changed rows. Supported values: `BINLOG` - Fivetran uses your binary logs (also called binlogs) to request only the data that has changed since our last sync. This is the default value if no value is specified. `TELEPORT` - Fivetran's proprietary replication method that uses compressed snapshots to detect and apply changes.
`user`	The user name.
`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 and password parameters in the request.

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

{
  "service": "mysql",
  "group_id": "group_id",
  "config": {
    "host": "mysqlinstance.mycompany.com",
    "port": 3306,
    "user": "test_user",
    "password": "test_password"
  }
}

By using the Connect Card or the Fivetran dashboard.