backupRuns

Changed on

Creates a new backup run on demand.

post/v1/projects/{project}/instances/{instance}/backupRuns

Request

  • Base URL: https://sqladmin.googleapis.com
  • URL: https://sqladmin.googleapis.com/v1/projects/{project}/instances/{instance}/backupRuns
  • Auth: one of:
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/cloud-platform) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/cloud-platform)
    • OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/sqlservice.admin) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/sqlservice.admin)

Path parameters

projectstring required

Project ID of the project that contains the instance.

instancestring required

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

Request body

backupKind'SQL_BACKUP_KIND_UNSPECIFIED' | 'SNAPSHOT' | 'PHYSICAL'

Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

databaseVersion'SQL_DATABASE_VERSION_UNSPECIFIED' | 'MYSQL_5_1' | 'MYSQL_5_5' | 'MYSQL_5_6' | 'MYSQL_5_7' | 'MYSQL_8_0' | 'MYSQL_8_0_18' | 'MYSQL_8_0_26' | 'MYSQL_8_0_27' | 'MYSQL_8_0_28' | 'MYSQL_8_0_29' | 'MYSQL_8_0_30' | 'MYSQL_8_0_31' | 'MYSQL_8_0_32' | 'MYSQL_8_0_33' | 'MYSQL_8_0_34' | 'MYSQL_8_0_35' | 'MYSQL_8_0_36' | 'MYSQL_8_0_37' | 'MYSQL_8_0_39' | 'MYSQL_8_0_40' | 'MYSQL_8_0_41' | 'MYSQL_8_0_42' | 'MYSQL_8_0_43' | 'MYSQL_8_0_44' | 'MYSQL_8_0_45' | 'MYSQL_8_0_46' | 'MYSQL_8_4' | 'MYSQL_9_7' | 'SQLSERVER_2017_STANDARD' | 'SQLSERVER_2017_ENTERPRISE' | 'SQLSERVER_2017_EXPRESS' | 'SQLSERVER_2017_WEB' | 'POSTGRES_9_6' | 'POSTGRES_10' | 'POSTGRES_11' | 'POSTGRES_12' | 'POSTGRES_13' | 'POSTGRES_14' | 'POSTGRES_15' | 'POSTGRES_16' | 'POSTGRES_17' | 'POSTGRES_18' | 'POSTGRES_19' | 'POSTGRES_20' | 'SQLSERVER_2019_STANDARD' | 'SQLSERVER_2019_ENTERPRISE' | 'SQLSERVER_2019_EXPRESS' | 'SQLSERVER_2019_WEB' | 'SQLSERVER_2022_STANDARD' | 'SQLSERVER_2022_ENTERPRISE' | 'SQLSERVER_2022_EXPRESS' | 'SQLSERVER_2022_WEB' | 'SQLSERVER_2025_STANDARD' | 'SQLSERVER_2025_ENTERPRISE' | 'SQLSERVER_2025_EXPRESS'

Output only. The instance database version at the time this backup was made.

descriptionstring

The description of this run, only applicable to on-demand backups.

endTimestring google-datetime

The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

enqueuedTimestring google-datetime

The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

idstring int64

The identifier for this backup run. Unique only for a specific Cloud SQL instance.

instancestring

Name of the database instance.

kindstring

This is always sql#backupRun.

locationstring

Location of the backups.

maxChargeableBytesstring int64

Output only. The maximum chargeable bytes for the backup.

selfLinkstring

The URI of this resource.

startTimestring google-datetime

The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

status'SQL_BACKUP_RUN_STATUS_UNSPECIFIED' | 'ENQUEUED' | 'OVERDUE' | 'RUNNING' | 'FAILED' | 'SUCCESSFUL' | 'SKIPPED' | 'DELETION_PENDING' | 'DELETION_FAILED' | 'DELETED'

The status of this run.

timeZonestring

Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.

type'SQL_BACKUP_RUN_TYPE_UNSPECIFIED' | 'AUTOMATED' | 'ON_DEMAND'

The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.

windowStartTimestring google-datetime

The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.

Response

Successful response

Changes

  • ba002bd969e1Revision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/sqlservice.admin was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/sqlservice.admin was removed from the endpoint's security scheme Oauth2c

  • fcad54e36005Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/sqlservice.admin was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/sqlservice.admin was removed from the endpoint's security scheme Oauth2c