Skip to main content
POST
Test a Snowflake account configuration

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Body

application/json

The configuration SELECT needs to start reading a Snowflake account.

Every field here is returned by a read of the created account, except the credentials, which are write-only and never returned.

id
string
required

The account's Snowflake identifier, in ORGANIZATION-ACCOUNT form (e.g. acme-us-east-1). Cannot be changed once the account is added.

Must already be normalized: lower case, no surrounding whitespace, and - rather than . between organization and account. A PrivateLink identifier, which ends in .privatelink, keeps its dots because the host it resolves to does. A value that is not already normalized is rejected rather than rewritten, so what you submit always matches what a subsequent read returns.

name
string
required

Display name for the account, as shown throughout SELECT.

credentials
SnowflakeCredentials · object
required

How SELECT authenticates to the account.

role
string | null

The Snowflake role SELECT assumes when reading this account. Null uses the user's default role.

warehouse
string | null

The Snowflake warehouse SELECT runs its queries on. Null uses the user's default warehouse.

describe_object_sproc_name
string | null

Fully qualified name of the stored procedure SELECT calls to describe objects it cannot read directly. Null if there is none.

export_storage_integration_name
string | null

Name of the Snowflake storage integration used to export data to SELECT. Mutually exclusive with export_stage_name.

export_stage_name
string | null

Fully qualified name of the Snowflake stage used to export data to SELECT. Mutually exclusive with export_storage_integration_name.

compute_cost_per_credit
number | null

Overrides the credit rate SELECT reads from Snowflake when costing compute. Required together with storage_cost_per_tb when the account cannot read organization-level rates.

storage_cost_per_tb
number | null

Overrides the rate SELECT uses when costing storage, per terabyte per month. Required together with compute_cost_per_credit when the account cannot read organization-level rates.

customer_side_sanitization_database_schema
string | null

DATABASE.SCHEMA hosting your own sanitized copies of Snowflake's account usage views, which SELECT reads instead of the originals. Null disables the redirection.

customer_side_sanitization_views
string[] | null

The account usage views to redirect, such as query_history. Null redirects every view SELECT reads. Requires customer_side_sanitization_database_schema.

excluded_users_filter_expression
string | null

JSON-encoded filter selecting Snowflake users whose activity is excluded from SELECT's cost and usage figures.

fivetran_users
string[] | null

Snowflake users that Fivetran runs as, so their activity is attributed to Fivetran.

mode_workspace
string | null

The Mode workspace to attribute queries to.

mode_token_id
string | null

Identifier of the Mode API token SELECT uses.

mode_token_secret
string | null

The Mode API token secret.

sync_enabled
boolean
default:true

Whether SELECT starts syncing data for this account.

query_sanitization_enabled
boolean
default:false

Whether query text is sanitized before SELECT stores it.

Response

Successful Response

The result of validating an account's configuration against Snowflake.

success
boolean
required

Whether every applicable check passed.

checks
SnowflakeAccountValidationCheck · object[]
required

The checks that ran, in the order they ran. Read top-down to find where setup stopped working.