Skip to main content
POST
Test a BigQuery connection 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

A BigQuery connection to add.

name
string
required

Display name for the connection, as shown throughout SELECT.

gcp_project_id
string
required

The GCP project to read BigQuery usage and spend from. 6-30 characters, starting with a lowercase letter, made up of lowercase letters, digits and hyphens, and not ending in a hyphen.

Pattern: ^[a-z][a-z0-9-]{4,28}[a-z0-9]$
service_account
string
required

The GCP service account SELECT impersonates to reach the project, in [email protected] form.

Pattern: ^[a-z][a-z0-9-]{4,28}[a-z0-9]@[a-z][a-z0-9-]{4,28}[a-z0-9]\.iam\.gserviceaccount\.com$
bigquery_dataset_id
string | null

The BigQuery dataset holding the project's billing and pricing exports. Letters, digits and underscores only. Required when is_doit is false, and must be omitted when it is true.

Pattern: ^[a-zA-Z0-9_]{1,1024}$
billing_account_id
string | null

The Cloud Billing account the exports belong to, in XXXXXX-XXXXXX-XXXXXX form, case-insensitive. Required when is_doit is false, and must be omitted when it is true.

Pattern: ^[0-9A-Fa-f]{6}-[0-9A-Fa-f]{6}-[0-9A-Fa-f]{6}$
is_doit
boolean
default:false

Set this when the project's GCP billing account is managed by DoiT as a resale customer, so SELECT reads its spend from DoiT's billing data. SELECT confirms access before spend can be read, so the connection is created with a doit_billing_status of pending; re-read it to see when it becomes active. Requires a user credential rather than an API key, and cannot be changed once the connection is added.

sync_enabled
boolean
default:true

Whether SELECT starts syncing data for this connection.

query_sanitization_enabled
boolean
default:false

Whether query text is sanitized before SELECT stores it.

Response

Successful Response

The result of validating a connection's configuration against BigQuery.

success
boolean
required

Whether every applicable check passed.

checks
BigQueryConnectionValidationCheck · object[]
required

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