Method: projects.instances.create

Create an instance within a project.

Note that exactly one of Cluster.serve_nodes and Cluster.cluster_config.cluster_autoscaling_config can be set. If serveNodes is set to non-zero, then the cluster is manually scaled. If clusterConfig.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. The unique name of the project in which to create the new instance. Values are of the form projects/{project}.

Authorization requires the following IAM permission on the specified resource parent:

  • bigtable.instances.create

Request body

The request body contains data with the following structure:

JSON representation
  "instanceId": string,
  "instance": {
    object (Instance)
  "clusters": {
    string: {
      object (Cluster)


Required. The ID to be used when referring to the new instance within its project, e.g., just myinstance rather than projects/myproject/instances/myinstance.


object (Instance)

Required. The instance to create. Fields marked OutputOnly must be left blank.


map (key: string, value: object (Cluster))

Required. The clusters to be created within the instance, mapped by desired cluster ID, e.g., just mycluster rather than projects/myproject/instances/myinstance/clusters/mycluster. Fields marked OutputOnly must be left blank.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Response body

If successful, the response body contains a newly created instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.