Skip to content
OpenParablePublic APIs

Cloud Bigtable Admin API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Administer your Cloud Bigtable tables and instances.

Cloud Bigtable Admin API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 28 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://bigtableadmin.googleapis.com/
Version
v2
Endpoints
28
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://bigtableadmin.googleapis.com/v2/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://bigtableadmin.googleapis.com/v2/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://bigtableadmin.googleapis.com/v2/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v2/{name}Gets information about a location.
PUT/v2/{name}Updates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you mu
PATCH/v2/{name}Updates a specified table.
DELETE/v2/{name}Permanently deletes a specified table and all of its data.
GET/v2/{name}/locationsLists information about the supported locations for this service.
GET/v2/{name}/operationsLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
POST/v2/{name}:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the serv
POST/v2/{name}:checkConsistencyChecks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check
POST/v2/{name}:dropRowRangePermanently drop/delete a row range from a specified table. The request can specify whether to delete all rows in a table, or only those that match a particular
POST/v2/{name}:generateConsistencyTokenGenerates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the table that finished before this call started
POST/v2/{name}:modifyColumnFamiliesPerforms a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data
POST/v2/{name}:undeleteRestores a specified table which was accidentally deleted.
GET/v2/{parent}/appProfilesLists information about app profiles in an instance.
POST/v2/{parent}/appProfilesCreates an app profile within an instance.
GET/v2/{parent}/backupsLists Cloud Bigtable backups. Returns both completed and pending backups.
POST/v2/{parent}/backupsStarts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is
POST/v2/{parent}/backups:copyCopy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
GET/v2/{parent}/clustersLists information about clusters in an instance.
POST/v2/{parent}/clustersCreates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_no
GET/v2/{parent}/hotTabletsLists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.
GET/v2/{parent}/instancesLists information about instances in a project.
POST/v2/{parent}/instancesCreate an instance within a project. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serve_nod
GET/v2/{parent}/tablesLists all tables served from a specified instance.
POST/v2/{parent}/tablesCreates a new table in the specified instance. The table can be created with a full set of initial column families, specified in the request.
POST/v2/{parent}/tables:restoreCreate a new table by restoring from a completed backup. The returned table long-running operation can be used to track the progress of the operation, and to ca
POST/v2/{resource}:getIamPolicyGets the access control policy for a Table resource. Returns an empty policy if the resource exists but does not have a policy set.
POST/v2/{resource}:setIamPolicySets the access control policy on a Table resource. Replaces any existing policy.
POST/v2/{resource}:testIamPermissionsReturns permissions that the caller has on the specified table resource.

Questions

Does the Cloud Bigtable Admin API API need an API key?

Yes. The Cloud Bigtable Admin API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Cloud Bigtable Admin API API support HTTPS?

Yes, the Cloud Bigtable Admin API API is served over HTTPS.

How many endpoints does the Cloud Bigtable Admin API API have?

Its OpenAPI description lists 28 endpoints in version v2. All of them are shown on this page.

What are alternatives to the Cloud Bigtable Admin API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).