Starts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the formatprojects/<project>/instances/<instance>/backups/<backup>/operations/<operationId>and can be used to track creation of the backup. The metadata field type isCreateBackupMetadata. The response field type isBackup, if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.
Required. The name of the instance in which the backup is created. This must be the same instance that contains the database the backup is created from. The backup will be stored in the locations specified in the instance configuration of this instance. Values are of the formprojects/<project>/instances/<instance>.
Authorization requires the followingIAMpermission on the specified resourceparent:
spanner.backups.create
Query parameters
Parameters
backupId
string
Required. The id of the backup to be created. ThebackupIdappended toparentforms the full backup name of the formprojects/<project>/instances/<instance>/backups/<backupId>.
Optional. The encryption configuration used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database by default, namelyencryptionType=USE_DATABASE_ENCRYPTION.
[[["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-07-23 UTC."],[],[],null,["# Method: projects.instances.backups.create\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [Try it!](#try-it)\n\nStarts creating a new Cloud Spanner Backup. The returned backup long-running operation will have a name of the format `projects/\u003cproject\u003e/instances/\u003cinstance\u003e/backups/\u003cbackup\u003e/operations/\u003coperationId\u003e` and can be used to track creation of the backup. The metadata field type is [CreateBackupMetadata](/spanner/docs/reference/rest/v1/CreateBackupMetadata). The response field type is [Backup](/spanner/docs/reference/rest/v1/projects.instances.backups#Backup), if successful. Cancelling the returned operation will stop the creation and delete the backup. There can be only one pending backup creation per database. Backup creation of different databases can run concurrently.\n\n### HTTP request\n\nChoose a location: \nglobal europe-west8 me-central2 us-central1 us-central2 us-east1 us-east4 us-east5 us-south1 us-west1 us-west2 us-west3 us-west4 us-west8 us-east7 \n\n\u003cbr /\u003e\n\nThe URLs use [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](/spanner/docs/reference/rest/v1/projects.instances.backups#Backup).\n\n### Response body\n\nIf successful, the response body contains a newly created instance of [Operation](/spanner/docs/reference/rest/v1/projects.instanceConfigs.operations#Operation).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/spanner.admin`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `database` resource:\n\n- `spanner.databases.createBackup`\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `spanner.backups.create`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs)."]]
