---
title: "POST /v2/{+parent}/instances"
method: POST
path: "/v2/{+parent}/instances"
tags: ["projects"]
---

# POST /v2/{+parent}/instances

`POST /v2/{+parent}/instances`

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 serve_nodes is set to non-zero, then the cluster is manually scaled. If cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is enabled.

## Path parameters

- `parent` string, required

## Request body

- CreateInstanceRequest — Request message for BigtableInstanceAdmin.CreateInstance.
  - `instanceId` string — 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`.
  - `instance` Instance — A collection of Bigtable Tables and the resources that serve them. All tables in an instance are served from all Clusters in the instance.
    - `createTime` string, google-datetime — Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`.
    - `tags` object — Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: - "123/environment": "production", - "123/costCenter": "marketing" Tags and Labels (above) are both used to bind metadata to resources, with different use-cases. See https://cloud.google.com/resource-manager/docs/tags/tags-overview for an in-depth overview on the difference between tags and labels.
    - `satisfiesPzs` boolean — Output only. Reserved for future use.
    - `type` 'TYPE_UNSPECIFIED' | 'PRODUCTION' | 'DEVELOPMENT' — The type of the instance. Defaults to `PRODUCTION`.
    - `displayName` string — Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion.
    - `labels` object — Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes.
    - `knowledgeCatalogRegion` string — Output only. The region where Knowledge Catalog data is synced to and stored, including user-created aspects.
    - `state` 'STATE_NOT_KNOWN' | 'READY' | 'CREATING' — Output only. The current state of the instance.
    - `edition` 'EDITION_UNSPECIFIED' | 'ENTERPRISE' | 'ENTERPRISE_PLUS' — Optional. The edition of the instance. See Edition for details.
    - `name` string — The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`.
    - `satisfiesPzi` boolean — Output only. Reserved for future use.
  - `parent` string — Required. The unique name of the project in which to create the new instance. Values are of the form `projects/{project}`.
  - `clusters` object — 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.

## Response `200`

Successful response

---

[API](https://skmtc.net/google/apis/bigtableadmin.md) · [All operations](https://skmtc.net/google/apis/bigtableadmin/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/bigtableadmin/versions/d59c83bbbf1e/schema)