Stay organized with collections
Save and categorize content based on your preferences.
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.
HTTP request
POST https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*/clusters/*}/backups
Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.
Authorization requires one or more of the following IAM permissions on the specified resource parent:
bigtable.backups.create
bigtable.tables.readRows
Query parameters
Parameters
backupId
string
Required. The id of the backup to be created. The backupId along with the parent parent are combined as {parent}/backups/{backupId} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backupId}. This string must be between 1 and 50 characters in length and match the regex [_a-zA-Z0-9][-_.a-zA-Z0-9]*.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-08 UTC."],[[["\u003cp\u003eThis process initiates the creation of a new Cloud Bigtable Backup, utilizing a long-running operation to monitor the backup's progress.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e parameter in the HTTP request specifies the cluster where the backup will be stored, and requires specific IAM permissions for authorization.\u003c/p\u003e\n"],["\u003cp\u003eA unique \u003ccode\u003ebackupId\u003c/code\u003e query parameter, between 1 and 50 characters in length, must be provided to identify the backup being created.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires an instance of the \u003ccode\u003eBackup\u003c/code\u003e resource, while a successful operation returns an \u003ccode\u003eOperation\u003c/code\u003e instance.\u003c/p\u003e\n"],["\u003cp\u003eCreating a backup requires specific OAuth scopes, such as those related to Bigtable administration or the broader cloud platform.\u003c/p\u003e\n"]]],[],null,["# Method: projects.instances.clusters.backups.create\n\nStarts creating a new Cloud Bigtable Backup. The returned backup [long-running operation](/bigtable/docs/reference/admin/rest/v2/operations#Operation) can be used to track creation of the backup. The [metadata](/bigtable/docs/reference/admin/rest/v2/operations#Operation.FIELDS.metadata) field type is [CreateBackupMetadata](/bigtable/docs/reference/admin/rest/v2/CreateBackupMetadata). The [response](/bigtable/docs/reference/admin/rest/v2/operations#Operation.FIELDS.response) field type is [Backup](/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters.backups#Backup), if successful. Cancelling the returned operation will stop the creation and delete the backup.\n\n### HTTP request\n\n`POST https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*/clusters/*}/backups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body contains an instance of [Backup](/bigtable/docs/reference/admin/rest/v2/projects.instances.clusters.backups#Backup).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [Operation](/bigtable/docs/reference/admin/rest/v2/operations#Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/bigtable.admin`\n- `https://www.googleapis.com/auth/bigtable.admin.table`\n- `https://www.googleapis.com/auth/cloud-bigtable.admin`\n- `https://www.googleapis.com/auth/cloud-bigtable.admin.table`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
