APIHub
Back to Explore

BigQuery Connection API

The BigQuery Connection API lets you create, list, retrieve, delete, and update credentials for BigQuery connections to external data sources, and also manage IAM policies (get, set, test) on those connection resources.

Analytics
OAuth
HTTPS
CORS: Unknown
Description enriched
Visit official documentation

Latency

425ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
DELETE

/v1beta1/{name}

Deletes connection and associated credential.

  • name (path, required) — Required. Name of the deleted connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
GET

/v1beta1/{name}

Returns specified connection.

  • name (path, required) — Required. Name of the requested connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}`
PATCH

/v1beta1/{name}

Sets the credential for the specified connection.

  • name (path, required) — Required. Name of the connection, for example: `projects/{project_id}/locations/{location_id}/connections/{connection_id}/credential`
GET

/v1beta1/{parent}/connections

Returns a list of connections in the given project.

  • parent (path, required) — Required. Parent resource name. Must be in the form: `projects/{project_id}/locations/{location_id}`
  • maxResults (query, limit) — Required. Maximum number of results per page.
  • pageToken (query) — Page token.
POST

/v1beta1/{parent}/connections

Creates a new connection.

  • parent (path, required) — Required. Parent resource name. Must be in the format `projects/{project_id}/locations/{location_id}`
  • connectionId (query) — Optional. Connection id that should be assigned to the created connection.
POST

/v1beta1/{resource}:getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

  • resource (path, required) — REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
POST

/v1beta1/{resource}:setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

  • resource (path, required) — REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
POST

/v1beta1/{resource}:testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

  • resource (path, required) — REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

8 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X DELETE \
  "https://bigqueryconnection.googleapis.com/v1beta1/{name}"

bigqueryconnection.googleapis.com · HTTPS only