Skip to main content
POST
Generate warehouse destination setup script

Authorizations

Authorization
string
header
required

Path Parameters

projKey
string<string>
required

The project key

envKey
string<string>
required

The environment key

kind
string<string>
required

The destination kind (snowflake-v2, redshift, clickhouse)

Body

application/json
name
string
snowflakeHostAddress
string
databaseName
string
warehouseName
string
roleName
string
schemaName
string
userName
string
includeNetworkPolicy
boolean
clusterIdentifier
string
clusterRegion
string
clusterAwsAccountId
string
endpoint
string
clickHouseDatabaseName
string
clickHouseUserName
string
clickHouseS3BucketName
string
clickHouseIncludeHostRestriction
boolean
clickHouseServiceRoleArn
string
clickHousePassword
string
s3BucketName
string

Response

Generate warehouse destination setup script response

script
string

The SQL setup script to run in your data warehouse

publicKey
string

The RSA public key (Snowflake only) to store as the destination public_key

publicKeyPkcs8
string

The PKCS8 RSA public key (Snowflake only)

redshiftIAMPermissionsPolicy
string

For Redshift, present only when clusterIdentifier, clusterRegion, and clusterAwsAccountId are supplied in the request body.

redshiftIAMTrustPolicy
string

For Redshift, present only when clusterIdentifier, clusterRegion, and clusterAwsAccountId are supplied in the request body.

s3BucketName
string

The auto-generated S3 staging bucket name (ClickHouse and Redshift)