Skip to main content
POST
Test Mode BI access for an account

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

snowflake_account_id
string
required

Body

application/json

Mode BI credentials to test against an existing account, without persisting them. Any field left out falls back to the account's currently stored Mode configuration, so an empty body re-tests what's saved and a partial body tests a candidate change before it's written via a PATCH.

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.

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.