Stay organized with collectionsSave and categorize content based on your preferences.
Create a new table by restoring from a completed backup. The returned tablelong-running operationcan be used to track the progress of the operation, and to cancel it. Themetadatafield type isRestoreTableMetadata. Theresponsetype isTable, if successful.
HTTP request
POST https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*}/tables:restore
Required. The name of the instance in which to create the restored table. Values are of the formprojects/<project>/instances/<instance>.
Authorization requires the followingIAMpermission on the specified resourceparent:
bigtable.tables.create
Request body
The request body contains data with the following structure:
JSON representation
{"tableId":string,// Union fieldsourcecan be only one of the following:"backup":string// End of list of possible types for union fieldsource.}
Fields
tableId
string
Required. The id of the table to create and restore to. This table must not already exist. ThetableIdappended toparentforms the full table name of the formprojects/<project>/instances/<instance>/tables/<tableId>.
Union fieldsource. Required. The source from which to restore.sourcecan be only one of the following:
backup
string
Name of the backup from which to restore. Values are of the formprojects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>.
Authorization requires the followingIAMpermission on the specified resourcebackup:
bigtable.backups.restore
Response body
If successful, the response body contains an instance ofOperation.
[[["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 operation restores a new table from a completed backup, allowing you to track progress and cancel the operation.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request to restore a table uses the \u003ccode\u003ePOST\u003c/code\u003e method at the specified URL, including parameters to specify the instance in which to create the table.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires a \u003ccode\u003etableId\u003c/code\u003e to identify the new table and a \u003ccode\u003ebackup\u003c/code\u003e name indicating the source backup for the restore.\u003c/p\u003e\n"],["\u003cp\u003eThe successful response will contain an instance of \u003ccode\u003eOperation\u003c/code\u003e, which can be used to monitor the restore process.\u003c/p\u003e\n"],["\u003cp\u003eProper authorization scopes are needed, such as \u003ccode\u003ehttps://www.googleapis.com/auth/bigtable.admin\u003c/code\u003e, \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e, or others, along with appropriate IAM permissions.\u003c/p\u003e\n"]]],[],null,["# Method: projects.instances.tables.restore\n\nCreate a new table by restoring from a completed backup. The returned table [long-running operation](/bigtable/docs/reference/admin/rest/v2/operations#Operation) can be used to track the progress of the operation, and to cancel it. The [metadata](/bigtable/docs/reference/admin/rest/v2/operations#Operation.FIELDS.metadata) field type is [RestoreTableMetadata](/bigtable/docs/reference/admin/rest/v2/RestoreTableMetadata). The [response](/bigtable/docs/reference/admin/rest/v2/operations#Operation.FIELDS.response) type is [Table](/bigtable/docs/reference/admin/rest/v2/projects.instances.tables#Table), if successful.\n\n### HTTP request\n\n`POST https://bigtableadmin.googleapis.com/v2/{parent=projects/*/instances/*}/tables:restore`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an 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)."]]
