Snowflake API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "snowflake_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
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "config": {
    "role": "role",
    "connection_type": "Directly | PrivateLink | SshTunnel | ProxyAgent",
    "auth": "KEY_PAIR | PASSWORD | OAUTH",
    "private_key": "privateKey",
    "workspace_schema": "string",
    "database": "database",
    "password": "password",
    "is_private_key_encrypted": true,
    "port": 443,
    "host": "host",
    "passphrase": "passphrase",
    "user": "user",
    "workspace_name": "string",
    "use_workspace": true,
    "schema_prefix": "prefix"
  }
}

Config parameters

Name	Description
`role`	Snowflake Connector role name
`connection_type`	Directly or Private Link
`auth`	Password-based or key-based authentication type
`private_key`	Private access key. The field should be specified if authentication type is `KEY_PAIR`.
`workspace_schema`	The name of the schema that belongs to the workspace database where the temporary tables will be created.
`database`	The database name: Snowflake
`password`	The Snowflake user's password.
`is_private_key_encrypted`	Indicates that a private key is encrypted. The default value: `false`. The field can be specified if authentication type is `KEY_PAIR`.
`port`	The Snowflake optional port number.
`host`	Host name
`passphrase`	In case private key is encrypted, you are required to enter passphrase that was used to encrypt the private key. The field can be specified if authentication type is `KEY_PAIR`.
`user`	The Snowflake username.
`workspace_name`	The name of the database where the temporary tables will be created.
`use_workspace`	Choose a database and schema to create temporary tables for syncs.
`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

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