Skip to main content
GET
Get a BigQuery connection

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

bigquery_connection_id
string
required

Response

Successful Response

A connection to one BigQuery project.

id
string
required
read-only

The unique identifier of the connection.

etag
string
required
read-only

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

name
string
required

Display name for the connection, as shown throughout SELECT.

gcp_project_id
string
required

The GCP project SELECT reads BigQuery usage and spend from.

regions
string[]
required
read-only

The BigQuery regions SELECT detected query activity in. Empty until the first successful detection.

is_doit
boolean
required
read-only

Whether this project's GCP billing account is managed by DoiT as a resale customer, so SELECT reads its spend from DoiT's billing data rather than from an export in your own dataset.

connection_id
string
required
read-only

Identifier of the underlying connection this BigQuery project reads through.

sync_enabled
boolean
required

Whether SELECT is currently syncing data for this connection.

query_sanitization_enabled
boolean
required

Whether query text is sanitized before SELECT stores it.

create_time
string
required
read-only

When the connection was added.

update_time
string
required
read-only

When the connection was last changed.

bigquery_dataset_id
string | null

The BigQuery dataset holding the project's billing and pricing exports. Null when is_doit is true, since SELECT reads DoiT's export rather than one in your own dataset.

billing_account_id
string | null

The Cloud Billing account the exports belong to, in XXXXXX-XXXXXX-XXXXXX form. Null when is_doit is true.

service_account
string | null

The GCP service account SELECT impersonates to reach the project. Null for a connection SELECT reaches without impersonation.

gcp_organization_id
string | null

Numeric id of the GCP organization the project belongs to. Null for a standalone project, or when SELECT cannot read the project's ancestry.

gcp_organization_name
string | null

Display name of the GCP organization the project belongs to. Null when the name cannot be read even though the id resolved.

doit_billing_status
enum<string> | null

Whether SELECT can read this connection's spend from DoiT's billing data. pending while SELECT confirms access, active once spend is flowing, and inactive if it cannot be read — contact support. Null when is_doit is false.

Available options:
active,
pending,
inactive
added_by_email
string | null

Email address of the person who added the connection. Null when it was not added by a person.

last_successful_sync_time
string | null

When SELECT last completed a sync for this connection. Null before the first one succeeds.