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

# POST /v2/{+parent}/backups

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

Starts 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 CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

## Path parameters

- `parent` string, required

## Query parameters

- `backupId` string

## Request body

- Backup — A backup of a Cloud Bigtable table.
  - `sourceTable` string — Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects/{project}/instances/{instance}/tables/{source_table}`.
  - `expireTime` string, google-datetime — Required. The expiration time of the backup. When creating a backup or updating its `expire_time`, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the `expire_time` has passed, Cloud Bigtable will delete the backup.
  - `state` 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' — Output only. The current state of the backup.
  - `encryptionInfo` EncryptionInfo — Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status.
    - `encryptionType` 'ENCRYPTION_TYPE_UNSPECIFIED' | 'GOOGLE_DEFAULT_ENCRYPTION' | 'CUSTOMER_MANAGED_ENCRYPTION' — Output only. The type of encryption used to protect this resource.
    - `encryptionStatus` Status — The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
      - `details` object[] — A list of messages that carry the error details. There is a common set of message types for APIs to use.
      - `message` string — A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      - `code` integer — The status code, which should be an enum value of google.rpc.Code.
    - `kmsKeyVersion` string — Output only. The version of the Cloud KMS key specified in the parent cluster that is in use for the data underlying this table.
  - `hotToStandardTime` string, google-datetime — The time at which the hot backup will be converted to a standard backup. Once the `hot_to_standard_time` has passed, Cloud Bigtable will convert the hot backup to a standard backup. This value must be greater than the backup creation time by: - At least 24 hours This field only applies for hot backups. When creating or updating a standard backup, attempting to set this field will fail the request.
  - `name` string — A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`.
  - `startTime` string, google-datetime — Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp.
  - `backupType` 'BACKUP_TYPE_UNSPECIFIED' | 'STANDARD' | 'HOT' — Indicates the backup type of the backup.
  - `endTime` string, google-datetime — Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp.
  - `sizeBytes` string, int64 — Output only. Size of the backup in bytes.
  - `sourceBackup` string — Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//clusters//backups/

## 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)