Update Warehouse Connection Parameters

patchhttps://statsigapi.net/console/v1/wh_connections

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Body

application/json
databricksobject
Show child attributes
hoststring
pathstring
accessTokenstring
stagingDatabasestring

Statsig will use this Database to save intermediate tables in the experimentation pipeline. Must be a database that the service user has write access to.

oauthClientIDstring
Constraints:nullable
consoleComputePathstring

An optional separate path that Statsig will use to run interactive queries made from the Console.

Constraints:nullable
snowflakeobject
Show child attributes
accountNamestring
serviceUserNamestring
serviceUserPasswordstring
privateKeystring
Constraints:nullable
keyPassPhrasestring
Constraints:nullable
stagingDatabaseNamestring

The database containing the staging schema

stagingSchemaNamestring

Statsig will use this Schema to save intermediate tables in the experimentation pipeline. Must be a schema that the service user has write access to.

computeWarehousestring

The warehouse that Statsig will use to run queries. Must be a warehouse that the service user has access to.

consoleComputeWarehousestring

An optional warehouse that Statsig will use to run interactive queries made from the Console.

Constraints:nullable
bigqueryobject
Show child attributes
privateKeystring

Private key for a first-party service account to use for the BigQuery connection.

projectstring

The project that Statsig will use to run queries.

consoleComputeProjectstring

An optional project that Statsig will use to run interactive queries made from the Console.

stagingDatasetstring

Statsig will use this dataset to save intermediate tables in the experimentation pipeline. Must be a dataset that the service user has write access to.

redshiftobject
Show child attributes
hoststring

The name of the Redshift cluster.

portnumber

The port of the Redshift cluster.

Constraints:format: double
databasestring

The database of the Redshift cluster.

usernamestring

The username of the admin of the Redshift cluster.

passwordstring

The password of the admin.

stagingSchemastring

The schema to use for staging tables.

useSshTunnelboolean
sshUsernamestring
sshPortnumber
Constraints:format: double
sshHoststring
sshPrivateKeystring
sshPublicKeystring
verifyCAboolean

Whether to verify CA over SSL.

useAssumeRoleboolean

Whether to use an IAM role to connect to the Redshift cluster.

roleArnstring
regionstring

The AWS region of your Redshift cluster. Needed if using an IAM Role to connect.

athenaobject
Show child attributes
regionstring

The AWS region of your resources.

bucketstring

The name of your S3 bucket.

dataCatalogstring

The name of your Athena Data Source/Catalog.

useCatalogInQueryContextboolean

Whether to specify the Data Catalog when making calls to your Athena instance via the SDK. This can be helpful to avoid needing to specify the same catalog in SQL for all queries.

databasestring

The name of the database to use for staging tables.

queryResultLocationstring

The S3 location for Athena query results.

workgroupstring

The name of the Athena Workgroup to use for query results.

roleArnstring

Response

application/json
200· Connection updated successfully
Other properties1
messagestring
403· Insufficient permissions.
statusintegerrequired
Allowed values:403
messagestringrequired

Was this helpful?