Google

Cloud Bigtable Admin API

Administer your Cloud Bigtable tables and instances.

Data & analytics#openapi#analytics#media

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Administer your Cloud Bigtable tables and instances.

Endpoints 36

projects.instances.tables.schemaBundles

  • GETGets metadata information about the specified schema bundle./v2/:nameGets metadata information about the specified schema bundle.
  • DELETEDeletes a schema bundle in the specified table./v2/:name?etag=stringDeletes a schema bundle in the specified table.
  • PATCHUpdates a schema bundle in the specified table./v2/:name?ignoreWarnings=true&updateMask=stringUpdates a schema bundle in the specified table.
  • POSTGets the access control policy for a Bigtable resource/v2/:resource:getIamPolicyGets the access control policy for a Bigtable resource. Returns an empty policy if the resource exists but does not have a policy set.
  • POSTSets the access control policy on a Bigtable resource/v2/:resource:setIamPolicySets the access control policy on a Bigtable resource. Replaces any existing policy.
  • POSTReturns permissions that the caller has on the specified Bigtable resource./v2/:resource:testIamPermissionsReturns permissions that the caller has on the specified Bigtable resource.
  • GETLists all schema bundles associated with the specified table./v2/:parent/schemaBundles?pageSize=0&pageToken=string&view=SCHEMA_BUNDLE_VIEW_UNSPECIFIEDLists all schema bundles associated with the specified table.
  • POSTCreates a new schema bundle in the specified table./v2/:parent/schemaBundles?schemaBundleId=stringCreates a new schema bundle in the specified table.

projects.instances.clusters

  • PUTUpdates a cluster within an instance/v2/:nameUpdates a cluster within an instance. Note that UpdateCluster does not support updating cluster_config.cluster_autoscaling_config. In order to update it, you…
  • GETLists information about clusters in an instance./v2/:parent/clusters?pageToken=stringLists information about clusters in an instance.
  • POSTCreates a cluster within an instance/v2/:parent/clusters?clusterId=stringCreates a cluster within an instance. Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If…

operations.projects.operations

  • GETLists operations that match the specified filter in the request/v2/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.instances

  • GETLists information about instances in a project./v2/:parent/instances?pageToken=stringLists information about instances in a project.
  • POSTCreate an instance within a project/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…

projects.instances.appProfiles

  • GETLists information about app profiles in an instance./v2/:parent/appProfiles?pageSize=0&pageToken=stringLists information about app profiles in an instance.
  • POSTCreates an app profile within an instance./v2/:parent/appProfiles?appProfileId=string&ignoreWarnings=trueCreates an app profile within an instance.

projects.instances.clusters.backups

  • POSTCopy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project./v2/:parent/backups:copyCopy a Cloud Bigtable backup to a new backup in the destination cluster located in the destination instance and project.
  • GETLists Cloud Bigtable backups/v2/:parent/backups?filter=string&orderBy=string&pageSize=0&pageToken=stringLists Cloud Bigtable backups. Returns both completed and pending backups.
  • POSTStarts creating a new Cloud Bigtable Backup/v2/:parent/backups?backupId=stringStarts 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…

projects.instances.clusters.hotTablets

  • GETLists hot tablets in a cluster, within the time range provided/v2/:parent/hotTablets?endTime=string&pageSize=0&pageToken=string&startTime=stringLists hot tablets in a cluster, within the time range provided. Hot tablets are ordered based on CPU usage.

projects.instances.clusters.memoryLayers

  • GETLists information about memory layers./v2/:parent/memoryLayers?pageSize=0&pageToken=stringLists information about memory layers.

projects.instances.logicalViews

  • GETLists information about logical views in an instance./v2/:parent/logicalViews?pageSize=0&pageToken=stringLists information about logical views in an instance.
  • POSTCreates a logical view within an instance./v2/:parent/logicalViews?logicalViewId=stringCreates a logical view within an instance.

projects.instances.materializedViews

  • GETLists information about materialized views in an instance./v2/:parent/materializedViews?pageSize=0&pageToken=string&view=VIEW_UNSPECIFIEDLists information about materialized views in an instance.
  • POSTCreates a materialized view within an instance./v2/:parent/materializedViews?ignoreWarnings=true&materializedViewId=stringCreates a materialized view within an instance.

projects.instances.tables

  • POSTChecks replication consistency based on a consistency token, that is, if replication has caught up based on the…/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…
  • GETLists all tables served from a specified instance./v2/:parent/tables?pageSize=0&pageToken=string&view=VIEW_UNSPECIFIEDLists all tables served from a specified instance.
  • POSTCreates a new table in the specified instance/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.
  • POSTPermanently drop/delete a row range from a specified table/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…
  • POSTGenerates a consistency token for a Table, which can be used in CheckConsistency to check whether mutations to the…/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…
  • POSTPerforms a series of column family modifications on the specified table/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…
  • POSTCreate a new table by restoring from a completed backup/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…
  • POSTRestores a specified table which was accidentally deleted./v2/:name:undeleteRestores a specified table which was accidentally deleted.

projects.instances.tables.authorizedViews

  • GETLists all AuthorizedViews from a specific table./v2/:parent/authorizedViews?pageSize=0&pageToken=string&view=RESPONSE_VIEW_UNSPECIFIEDLists all AuthorizedViews from a specific table.
  • POSTCreates a new AuthorizedView in a table./v2/:parent/authorizedViews?authorizedViewId=stringCreates a new AuthorizedView in a table.

projects.locations

  • GETLists information about the supported locations for this service/v2/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

API details

Base URL
https://bigtableadmin.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 9 scopes
An API key in the key query parameter
Operations
36 operations on 24 pathsPOST 19GET 14PUT 1PATCH 1DELETE 1
Main resources
projects.instances.tables 8projects.instances.tables.schemaBundles 8projects.instances.clusters 3projects.instances.clusters.backups 3projects.instances 2projects.instances.appProfiles 2projects.instances.logicalViews 2projects.instances.materializedViews 2projects.instances.tables.authorizedViews 2operations.projects.operations 1
Response formats
application/json
Description format
Google API Discovery, API version v2

How to test the Cloud Bigtable Admin API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Bigtable Admin API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 9 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets metadata information about the specified schema bundle.” (GET /v2/:name), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloud Bigtable Admin API?

Administer your Cloud Bigtable tables and instances. It is listed under Data & analytics and has 36 endpoints.

Who publishes the Cloud Bigtable Admin API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Cloud Bigtable Admin API?

Requests go to https://bigtableadmin.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Cloud Bigtable Admin API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 9 scopes; an API key in the key query parameter.

How many endpoints does the Cloud Bigtable Admin API have?

36 operations on 24 paths (19 POST, 14 GET, 1 PUT, 1 PATCH, 1 DELETE). The largest groups are projects.instances.tables, projects.instances.tables.schemaBundles, projects.instances.clusters, projects.instances.clusters.backups.

Is forking the Cloud Bigtable Admin API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.