Restores an existing instance's file share from a backup.
The capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).
HTTP request
POST https://file.googleapis.com/v1/{name=projects/*/locations/*/instances/*}:restore
Required. The resource name of the instance, in the format projects/{projectNumber}/locations/{locationId}/instances/{instanceId}.
Request body
The request body contains data with the following structure:
JSON representation
{"fileShare": string,// Union field source can be only one of the following:"sourceBackup": string// End of list of possible types for union field source.}
Fields
fileShare
string
Required. Name of the file share in the Filestore instance that the backup is being restored to.
Union field source.
source can be only one of the following:
sourceBackup
string
The resource name of the backup, in the format projects/{projectNumber}/locations/{locationId}/backups/{backupId}.
Response body
If successful, the response body contains an instance of Operation.
[[["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-06-17 UTC."],[[["\u003cp\u003eThis API operation restores a file share from a backup to an existing Filestore instance.\u003c/p\u003e\n"],["\u003cp\u003eThe instance's capacity must be equal to or larger than the backup's capacity, and meet the minimum tier capacity requirement.\u003c/p\u003e\n"],["\u003cp\u003eThe request uses a POST method with a specific URL structure as defined by gRPC Transcoding.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires specifying the target file share name and the source backup's resource name.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests will return an Operation instance, and authorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.instances.restore\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRestores an existing instance's file share from a backup.\n\nThe capacity of the instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier).\n\n### HTTP request\n\n`POST https://file.googleapis.com/v1/{name=projects/*/locations/*/instances/*}: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](/filestore/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
