Method: instances.restoreBackup

Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

HTTP request

POST https://sqladmin.googleapis.com/v1/projects/{project}/instances/{instance}/restoreBackup

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID of the project that contains the instance.
instance

string

Cloud SQL instance ID. This does not include the project ID.

Request body

The request body contains an instance of InstancesRestoreBackupRequest.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/sqlservice.admin

For more information, see the Authentication Overview.

InstancesRestoreBackupRequest

Database instance restore backup request.

JSON representation 
{
  "restoreBackupContext": {
    object (RestoreBackupContext)
  },
  "backup": string,
  "restoreInstanceSettings": {
    object (DatabaseInstance)
  }
}
Fields
restoreBackupContext

object (RestoreBackupContext)

Parameters required to perform the restore backup operation.
backup

string

The name of the backup that's used to restore a Cloud SQL instance: Format: projects/{project-id}/backups/{backup-uid}. Only one of restoreBackupContext, backup, backupdrBackup can be passed to the input.
restoreInstanceSettings

object (DatabaseInstance)

Optional. By using this parameter, Cloud SQL overrides any instance settings stored in the backup you are restoring from. You can't change the instance's major database version and you can only increase the disk size. You can use this field to restore new instances only. This field is not applicable for restore to existing instances.

RestoreBackupContext

Database instance restore from backup context. Backup context contains source instance id and project id.

JSON representation 
{
  "kind": string,
  "backupRunId": string,
  "instanceId": string,
  "project": string
}
Fields
kind

string

This is always sql#restoreBackupContext.
backupRunId

string (int64 format)

The ID of the backup run to restore from.
instanceId

string

The ID of the instance that the backup was taken from.
project

string

The full project ID of the source instance.