Add a BigQuery connection

curl --request POST \
  --url https://api.select.dev/v2/bigquery-connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "name": "<string>",
  "gcp_project_id": "<string>",
  "service_account": "<string>",
  "bigquery_dataset_id": "<string>",
  "billing_account_id": "<string>",
  "is_doit": false,
  "sync_enabled": true,
  "query_sanitization_enabled": false
}
'

import requests

url = "https://api.select.dev/v2/bigquery-connections"

payload = {
    "name": "<string>",
    "gcp_project_id": "<string>",
    "service_account": "<string>",
    "bigquery_dataset_id": "<string>",
    "billing_account_id": "<string>",
    "is_doit": False,
    "sync_enabled": True,
    "query_sanitization_enabled": False
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    gcp_project_id: '<string>',
    service_account: '<string>',
    bigquery_dataset_id: '<string>',
    billing_account_id: '<string>',
    is_doit: false,
    sync_enabled: true,
    query_sanitization_enabled: false
  })
};

fetch('https://api.select.dev/v2/bigquery-connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.select.dev/v2/bigquery-connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'gcp_project_id' => '<string>',
    'service_account' => '<string>',
    'bigquery_dataset_id' => '<string>',
    'billing_account_id' => '<string>',
    'is_doit' => false,
    'sync_enabled' => true,
    'query_sanitization_enabled' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.select.dev/v2/bigquery-connections"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"gcp_project_id\": \"<string>\",\n  \"service_account\": \"<string>\",\n  \"bigquery_dataset_id\": \"<string>\",\n  \"billing_account_id\": \"<string>\",\n  \"is_doit\": false,\n  \"sync_enabled\": true,\n  \"query_sanitization_enabled\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.select.dev/v2/bigquery-connections")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"gcp_project_id\": \"<string>\",\n  \"service_account\": \"<string>\",\n  \"bigquery_dataset_id\": \"<string>\",\n  \"billing_account_id\": \"<string>\",\n  \"is_doit\": false,\n  \"sync_enabled\": true,\n  \"query_sanitization_enabled\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.select.dev/v2/bigquery-connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"gcp_project_id\": \"<string>\",\n  \"service_account\": \"<string>\",\n  \"bigquery_dataset_id\": \"<string>\",\n  \"billing_account_id\": \"<string>\",\n  \"is_doit\": false,\n  \"sync_enabled\": true,\n  \"query_sanitization_enabled\": false\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "etag": "<string>",
  "name": "<string>",
  "gcp_project_id": "<string>",
  "regions": [
    "<string>"
  ],
  "is_doit": true,
  "connection_id": "<string>",
  "sync_enabled": true,
  "query_sanitization_enabled": true,
  "create_time": "<string>",
  "update_time": "<string>",
  "bigquery_dataset_id": "<string>",
  "billing_account_id": "<string>",
  "service_account": "<string>",
  "gcp_organization_id": "<string>",
  "gcp_organization_name": "<string>",
  "doit_billing_status": "active",
  "added_by_email": "<string>",
  "last_successful_sync_time": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

POST

bigquery-connections

Add a BigQuery connection

curl --request POST \
  --url https://api.select.dev/v2/bigquery-connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "name": "<string>",
  "gcp_project_id": "<string>",
  "service_account": "<string>",
  "bigquery_dataset_id": "<string>",
  "billing_account_id": "<string>",
  "is_doit": false,
  "sync_enabled": true,
  "query_sanitization_enabled": false
}
'

import requests

url = "https://api.select.dev/v2/bigquery-connections"

payload = {
    "name": "<string>",
    "gcp_project_id": "<string>",
    "service_account": "<string>",
    "bigquery_dataset_id": "<string>",
    "billing_account_id": "<string>",
    "is_doit": False,
    "sync_enabled": True,
    "query_sanitization_enabled": False
}
headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-tenant-id': '<x-tenant-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    gcp_project_id: '<string>',
    service_account: '<string>',
    bigquery_dataset_id: '<string>',
    billing_account_id: '<string>',
    is_doit: false,
    sync_enabled: true,
    query_sanitization_enabled: false
  })
};

fetch('https://api.select.dev/v2/bigquery-connections', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.select.dev/v2/bigquery-connections",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'gcp_project_id' => '<string>',
    'service_account' => '<string>',
    'bigquery_dataset_id' => '<string>',
    'billing_account_id' => '<string>',
    'is_doit' => false,
    'sync_enabled' => true,
    'query_sanitization_enabled' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.select.dev/v2/bigquery-connections"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"gcp_project_id\": \"<string>\",\n  \"service_account\": \"<string>\",\n  \"bigquery_dataset_id\": \"<string>\",\n  \"billing_account_id\": \"<string>\",\n  \"is_doit\": false,\n  \"sync_enabled\": true,\n  \"query_sanitization_enabled\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.select.dev/v2/bigquery-connections")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"gcp_project_id\": \"<string>\",\n  \"service_account\": \"<string>\",\n  \"bigquery_dataset_id\": \"<string>\",\n  \"billing_account_id\": \"<string>\",\n  \"is_doit\": false,\n  \"sync_enabled\": true,\n  \"query_sanitization_enabled\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.select.dev/v2/bigquery-connections")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"gcp_project_id\": \"<string>\",\n  \"service_account\": \"<string>\",\n  \"bigquery_dataset_id\": \"<string>\",\n  \"billing_account_id\": \"<string>\",\n  \"is_doit\": false,\n  \"sync_enabled\": true,\n  \"query_sanitization_enabled\": false\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "etag": "<string>",
  "name": "<string>",
  "gcp_project_id": "<string>",
  "regions": [
    "<string>"
  ],
  "is_doit": true,
  "connection_id": "<string>",
  "sync_enabled": true,
  "query_sanitization_enabled": true,
  "create_time": "<string>",
  "update_time": "<string>",
  "bigquery_dataset_id": "<string>",
  "billing_account_id": "<string>",
  "service_account": "<string>",
  "gcp_organization_id": "<string>",
  "gcp_organization_name": "<string>",
  "doit_billing_status": "active",
  "added_by_email": "<string>",
  "last_successful_sync_time": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

{
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "code": "<string>",
  "retryable": true,
  "type": "about:blank",
  "details": [
    {}
  ]
}

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

A connection to one BigQuery project.

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.

Get Started

Endpoints

Add a BigQuery connection

Authorizations

Headers

Body

Response