Skip to main content
PATCH
Change an integration's config

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

key
string
required

The integration key, such as snowflake or salesforce

Body

application/json
allowed_schemas
string[] | null

null removes the limit

Required string length: 1 - 255
allowed_tables
string[] | null

null removes the limit

Required string length: 1 - 255
default_catalog
string | null
default_database
string | null
default_project_id
string | null
default_schema
string | null
default_warehouse
string | null
expected_version
integer | null

The config version you read. Sent: a change against a version that is no longer live is a 409 and writes nothing (0 = the config was never saved). Left out, the change always lands

Required range: x >= 0
max_bytes_billed
integer | null
Required range: x >= 1
week_start_day
integer | null
Required range: 0 <= x <= 6

Response

200 - application/json

Successful Response

A SQL warehouse's settings. Its queries are their own resource (/queries).

allowed_schemas
string[] | null
required

The table allowlist's schemas: queries and browsing stay inside them. Null = no limit

allowed_tables
string[] | null
required

The table allowlist's tables, as table or schema.table. Null = every table in the allowed schemas

default_catalog
string | null
required

Databricks: the catalog unqualified names resolve in

default_database
string | null
required

Snowflake: the database unqualified names resolve in

default_project_id
string | null
required

BigQuery: the project queries run in

default_schema
string | null
required

Snowflake, Databricks: the schema unqualified names resolve in

default_warehouse
string | null
required

Snowflake: the warehouse queries run on

max_bytes_billed
integer | null
required

BigQuery: the most bytes one /sql or /preview query may bill; null means 10 GB

post_processing
PostProcessingConfig · object[]
required

Derived metrics computed after product usage queries. Read-only here: set up by Statisfy

version
integer
required

The config's version: send it as expected_version with a change (0 = never saved)

week_start_day
integer
required

The day product usage weeks start on: 0 = Monday … 6 = Sunday