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/v1beta1/{name=projects/*/locations/*/instances/*}:restore
Required. The resource name of the instance, in the formatprojects/{projectId}/locations/{locationId}/instances/{instanceId}.
Request body
The request body contains data with the following structure:
JSON representation
{"fileShare":string,// Union fieldsourcecan be only one of the following:"sourceSnapshot":string,"sourceBackup":string// End of list of possible types for union fieldsource.}
Fields
fileShare
string
Required. Name of the file share in the Filestore instance that the backup is being restored to.
Union fieldsource.
sourcecan be only one of the following:
sourceSnapshot (deprecated)
string
The resource name of the snapshot, in the formatprojects/{projectId}/locations/{locationId}/snapshots/{snapshotId}.
sourceBackup
string
The resource name of the backup, in the formatprojects/{projectId}/locations/{locationId}/backups/{backupId}.
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-06-17 UTC."],[[["\u003cp\u003eThis endpoint is used to restore an existing file share instance from a backup, requiring the instance's capacity to be equal to or larger than the backup's capacity.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a \u003ccode\u003ePOST\u003c/code\u003e method to the provided URL, which follows gRPC Transcoding syntax, including a required \u003ccode\u003ename\u003c/code\u003e path parameter for specifying the instance resource.\u003c/p\u003e\n"],["\u003cp\u003eThe request body, in JSON format, mandates a \u003ccode\u003efileShare\u003c/code\u003e field and allows one of either a \u003ccode\u003esourceSnapshot\u003c/code\u003e or \u003ccode\u003esourceBackup\u003c/code\u003e field to specify the restore source.\u003c/p\u003e\n"],["\u003cp\u003eA successful operation returns an instance of \u003ccode\u003eOperation\u003c/code\u003e in the response body, indicating the completion of the restore process.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this operation requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\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/v1beta1/{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)."]]
