Skip to main content
PATCH
Update a Snowflake account

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

If-Match
string | null
x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

snowflake_account_id
string
required

Body

application/json

A merge-patch update to an existing Snowflake account. Omitted fields are left unchanged; null clears a field.

Every field mirrors its SnowflakeAccountCreate counterpart except id, which cannot be changed once the account is added. name, credentials, sync_enabled and query_sanitization_enabled cannot be cleared: they are optional here only so they can be omitted, and rejecting an explicit null on them (rather than silently ignoring it) matches the JSON Merge Patch contract that null means "clear," which isn't a legal state for these. mode_token_secret cannot be cleared either, for a different reason: the secret is only meaningful alongside mode_workspace and mode_token_id, so clearing it alone would leave the pair pointing at a Mode connection with no secret behind it. Disconnect Mode entirely with mode_workspace: null, which clears all three together.

username is top-level rather than nested in credentials so the Snowflake user can be corrected without resupplying a password or private key — the same reason mode_workspace/mode_token_id/mode_token_secret are three separate fields rather than one Mode object. It cannot be sent alongside credentials, which already carries its own username; picking a winner between the two silently would be worse than rejecting the request. It also cannot be cleared: a Snowflake user is always required for password and key_pair, and does not exist for workload_identity_federation, so there is no method for which null is a legal state.

name
string | null

Display name for the account, as shown throughout SELECT.

credentials
SnowflakeCredentials · object | null

How SELECT authenticates to the account.

username
string | null

The Snowflake user SELECT connects as. Changes just the username, leaving the stored password or private key untouched. Cannot be sent alongside credentials, and not valid for an account using workload_identity_federation, which has no username.

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. Cannot be cleared with null; disconnect Mode with mode_workspace: null instead.

sync_enabled
boolean | null

Whether SELECT starts syncing data for this account.

query_sanitization_enabled
boolean | null

Whether query text is sanitized before SELECT stores it.

Response

Successful Response

A connection to one Snowflake account.

id
string
required

The account's Snowflake identifier, in ORGANIZATION-ACCOUNT form. Set by the caller when the account is added and cannot be changed afterward.

etag
string
required
read-only

Opaque strong ETag for this account's configuration. Matches the ETag response header, and is what If-Match requires on a write. It changes whenever a configurable field on the account changes.

name
string
required

Display name for the account, as shown throughout SELECT.

snowflake_organization_name
string
required
read-only

Name of the Snowflake organization the account belongs to.

snowflake_account_name
string
required
read-only

The account's name within its Snowflake organization.

mode_credentials_configured
boolean
required
read-only

Whether Mode BI credentials are configured for this account. The credentials themselves are never returned.

connection_id
string
required
read-only

Identifier of the underlying connection this account reads through.

sync_enabled
boolean
required

Whether SELECT is currently syncing data for this account.

query_sanitization_enabled
boolean
required

Whether query text is sanitized before SELECT stores it.

has_org_admin_access
boolean
required
read-only

Whether SELECT can read this account's Snowflake organization-level usage views, which is what makes organization-wide rates and spend available.

has_data_share
boolean
required
read-only

Whether the account reads SELECT's data share.

create_time
string
required
read-only

When the account was added to SELECT, as an RFC 3339 UTC timestamp.

update_time
string
required
read-only

When the account was last changed, as an RFC 3339 UTC timestamp.

locator
string | null

The account's Snowflake locator, as returned by current_account().

account_region
string | null

The Snowflake region the account is hosted in.

snowsight_url
string | null

Link to the account in Snowsight.

snowflake_reader_parent_account_name
string | null

For a reader account, the name of the account that created it. Null for a regular account.

role
string | null

The Snowflake role SELECT assumes when reading this account.

warehouse
string | null

The Snowflake warehouse SELECT runs its queries on.

describe_object_sproc_name
string | null

Fully qualified name of the stored procedure SELECT calls to describe objects it cannot read directly.

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, for accounts that export through a stage rather than a storage integration.

compute_cost_per_credit
number | null

Overrides the credit rate SELECT reads from Snowflake when costing compute. Null uses the rate on the account's contract.

storage_cost_per_tb
number | null

Overrides the rate SELECT uses when costing storage, per terabyte per month. Null uses the rate on the account's contract.

customer_side_sanitization_database_schema
string | null

DATABASE.SCHEMA hosting the customer's 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.

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.

has_manage_warehouses_grant
boolean | null

Whether SELECT's role holds manage warehouses on the account, which smart suspension requires. Null until first checked.

added_by_email
string | null

Email address of the user who added the account.

latest_sync_time
string | null

When SELECT last synced data for this account, as an RFC 3339 UTC timestamp.

last_successful_sync_time
string | null

When the account's last sync succeeded, as an RFC 3339 UTC timestamp. Behind latest_sync_time if the most recent attempt failed.

latest_hourly_spend_time
string | null

The most recent hour SELECT holds spend data for, as an RFC 3339 UTC timestamp.