Method: backups.updateBackup

Updates the retention period and the description of the backup. You can use this API to update final backups only.

HTTP request

PATCH https://sqladmin.googleapis.com/sql/v1beta4/{backup.name=projects/*/backups/*}

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
backup.name

string

Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.

Query parameters

Parameters
updateMask

string (FieldMask format)

The list of fields that you can update. You can update only the description and retention period of the final backup.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

Request body

The request body contains an instance ofBackup.

Response body

If successful, the response body contains an instance ofOperation.

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 theAuthentication Overview.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-30 UTC.