Snowflake API Configuration

Request

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

{
  "group_id": "group_id",
  "service": "snowflake",
  "region": "GCP_US_WEST1",
  "time_zone_offset": "+3",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "daylight_saving_time_enabled": true,
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "proxy_agent_id": "proxy_agent_id",
  "config": {
    "role": "string",
    "auth": "PASSWORD | KEY_PAIR | OAUTH",
    "gcs_service_account_credentials": {},
    "use_customer_staging": true,
    "external_storage_cloud_provider": "AZURE | GCP | INTERNAL_STAGE | AWS",
    "database": "fivetran",
    "password": "123456",
    "aws_bucket_auth_type": "IAM_ROLE | IAM_USER",
    "bucket_region": "string",
    "host": "your-account.snowflakecomputing.com",
    "directory_id": "string",
    "gcs_service_account_credentials_path": "string",
    "connection_type": "SshTunnel",
    "storage_account_name": "string",
    "aws_secret_access_key": "string",
    "private_key": "string",
    "storage_account_key": "string",
    "application_id": "string",
    "bucket": "string",
    "external_storage_integration": "string",
    "is_private_key_encrypted": true,
    "aws_access_key_id": "string",
    "port": 443,
    "enable_external_storage_for_unstructured_files": true,
    "passphrase": "string",
    "external_stage_storage_provider": "S3",
    "user": "fivetran_user",
    "external_storage_parent_folder_uri": "s3://fivetran-snowflake-integration/"
  }
}

Config parameters

Name	Description
`role`	If not specified, Fivetran will use the user's default role
`auth`	Password-based or key-based authentication type
`gcs_service_account_credentials`	The service account credentials for the Google Cloud Storage (GCS) bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use a GCS bucket to stage your data.
`use_customer_staging`	Set to `true` if you want to use an S3 bucket to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.
`external_storage_cloud_provider`	The cloud service provider you want to use for staging data. Use this parameter only if you are using Hybrid Deployment.
`database`	Database name
`password`	Database user password. The field should be specified if authentication type is `PASSWORD`.
`aws_bucket_auth_type`	Type of authentication configured for the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.
`bucket_region`	The AWS Region of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 bucket to stage your data.
`host`	Server name
`directory_id`	Tenant ID of your app created in Azure
`gcs_service_account_credentials_path`	The path to the JSON file that contains the service account credentials for the GCS bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use a GCS bucket to stage your data.
`connection_type`	Connection method. Default value: `Directly`.
`storage_account_name`	The name of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an Azure Blob storage container to stage your data.
`aws_secret_access_key`	The secret access key of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment , want to use an S3 bucket to stage your data, and `awsBucketAuthType` is set to `IAM_USER`.
`private_key`	Private access key. The field should be specified if authentication type is `KEY_PAIR`.
`storage_account_key`	The access key of the Azure storage account you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an Azure Blob storage container to stage your data.
`application_id`	Application ID of your app created in Azure
`bucket`	The name of the storage bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment and want to use an S3 or GCS bucket to stage your data.
`external_storage_integration`	External storage integration name
`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`.
`aws_access_key_id`	The unique access key ID of the S3 bucket you want to use to stage your data. Use this parameter only if you are using Hybrid Deployment, want to use an S3 bucket to stage your data, and `awsBucketAuthType` is set to `IAM_USER`.
`port`	Server port number
`enable_external_storage_for_unstructured_files`	Set to `true` if you want to enable external storage for unstructured files.
`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`.
`external_stage_storage_provider`	External stage storage provider[Internal, S3, Azure,GCS]
`user`	Database user name
`external_storage_parent_folder_uri`	External storage parent folder URL