This page describes how to manage final backups for your Cloud SQL instance. Before you delete an instance , you can take a final backup of the instance. You can then restore the final backup to a new or existing instance. This way, you can recreate any instances that you delete accidentally or use these instances for any disaster recovery scenarios.
Unlike automated and on-demand backups, which are associated with an instance, you can take a final backup before you delete the instance. Cloud SQL stores this backup beyond the lifetime of the instance.
You can use existing gcloud CLI commands to list, describe, update, and delete a final backup. If you're using custom roles, then add the following permissions to the roles:
cloudsql.backupRuns.list
cloudsql.backupRuns.get
cloudsql.backupRuns.update
cloudsql.backupRuns.delete
For more information about these permissions, see Required permissions . Also, for more information about how backups work, see
About Cloud SQL backups .
Required permissions
Note: You create a final backup before you delete an instance. For more information, see Delete instances .
Google Cloud console
To manage final backups in a Google Cloud project, you need the following permissions:
Task
Required permissions
List final backups
cloudsql.backupRuns.list
Describe a final backup
cloudsql.backupRuns.get
Update a final backup
cloudsql.backupRuns.update
Delete a final backup
cloudsql.backupRuns.delete
To manage final backups in a Google Cloud project, you need the following permissions:
Action
Command
Required permissions
List final backups
gcloud sql backups list
cloudsql.backupRuns.list
Describe a final backup
gcloud sql backups describe
cloudsql.backupRuns.get
Update a final backup
gcloud sql backups patch
cloudsql.backupRuns.update
Delete a final backup
gcloud sql backups delete
cloudsql.backupRuns.delete
REST
To manage final backups in a Google Cloud project, you need the following permissions:
Action
Method
Required permissions
List final backups
backups.list
cloudsql.backupRuns.list
Describe a final backup
backups.describe
cloudsql.backupRuns.get
Update a final backup
backups.patch
cloudsql.backupRuns.update
Delete a final backup
backups.delete
cloudsql.backupRuns.delete
View a list of final backups
You can view a list of final backups and details about a backup by using the Google Cloud console, gcloud CLI , or the Cloud SQL API.
The Google Cloud console doesn't show skipped or failed backups in the
backup history. To see these types of backups, use gcloud
or the Cloud SQL API.
Console
In the Google Cloud console, go to the Cloud SQL Backups page.
Go to Cloud SQL Backups
This page lists all backups, including final backups, that are associated with a Google Cloud project.
To view details about a final backup, click the backup. A Final backup dialog appears. This dialog displays the following information:
The date and time of when the instance, which was used to create the final backup, was deleted
The name and version of the deleted instance
A date-and-time stamp of how long Cloud SQL retains the final backup
A description of the final backup
gcloud
To get a list of all final backups that are associated with a Google Cloud project, use the gcloud sql backups list
command:
gcloud sql backups list \
--filter= "type=FINAL"
Note : By using this command, you can retrieve information about the backups, including their IDs. You need a backup ID to view details about a final backup.
Also, you can filter and control the results of running this command by using standard list parameters. For a complete list, see the gcloud sql backups list command reference page.
To view details about a final backup, use the gcloud sql backups describe
command:
gcloud sql backups describe \
BACKUP_NAME
You obtain the BACKUP_NAME from the output of running the gcloud sql backups list
command. The BACKUP_NAME has the following format: projects/PROJECT_ID /backups/BACKUP_ID
.
REST v1
Get a list of final backups
Use this example to get a list of all final backups that are associated with a Google Cloud project. For a complete list of parameters for this call, see the
backupRuns.list
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID
INSTANCE_ID : the instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups?filter=type=FINAL
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Execute the following command:
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups?filter=type=FINAL"
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method GET ` -Headers $headers ` -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups?filter=type=FINAL" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"name": "projects/PROJECT_ID /backups/BACKUP_ID ",
"kind": "sql#backup",
"status": "SUCCESSFUL",
"backupInterval": {
"startTime": "2020-01-21T11:25:33.858Z",
"endTime": "2020-01-21T11:26:18.663Z",
}
"type": "FINAL",
"instance": "INSTANCE_ID ",
"selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ",
"location": "us"
"description": "final backup",
"backupKind": "SNAPSHOT",
"dataDiskSizeGB": "10",
"expiryTime": "2020-01-30T11:26:18.663Z",
"backup_run": "projects/PROJECT_ID /instances/INSTANCE_ID /backupRuns/BACKUP_RUN_ID ",
"satisfies_pzs": false,
"satisfies_pzi": false
}
View details about a final backup
Use this example to view the details about a final backup. For a complete list of parameters for this call, see the
backupRuns.get
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID.
BACKUP_ID : the backup ID. You obtain this ID from the output of running the previous call.
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Execute the following command:
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID "
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method GET ` -Headers $headers ` -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID " | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"name": "projects/PROJECT_ID /backups/BACKUP_ID ",
"kind": "sql#backup",
"status": "SUCCESSFUL",
"backupInterval": {
"startTime": "2020-01-21T11:25:33.858Z",
"endTime": "2020-01-21T11:26:18.663Z",
}
"type": "FINAL",
"instance": "INSTANCE_ID ",
"selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ",
"location": "us"
"description": "final backup",
"backupKind": "SNAPSHOT",
"dataDiskSizeGB": "10",
"expiryTime": "2020-01-30T11:26:18.663Z",
"backup_run": "projects/PROJECT_ID /instances/INSTANCE_ID /backupRuns/BACKUP_RUN_ID ",
"satisfies_pzs": false,
"satisfies_pzi": false
}
REST v1beta4
Get a list of final backups
Use this example to get a list of all final backups that are associated with a Google Cloud project. For a complete list of parameters for this call, see the
backupRuns.list
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID
INSTANCE_ID : the instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups?filter=type=FINAL
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Execute the following command:
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups?filter=type=FINAL"
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method GET ` -Headers $headers ` -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups?filter=type=FINAL" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"name": "projects/PROJECT_ID /backups/BACKUP_ID ",
"kind": "sql#backup",
"status": "SUCCESSFUL",
"backupInterval": {
"startTime": "2020-01-21T11:25:33.858Z",
"endTime": "2020-01-21T11:26:18.663Z",
}
"type": "FINAL",
"instance": "INSTANCE_ID ",
"selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ",
"location": "us"
"description": "final backup",
"backupKind": "SNAPSHOT",
"dataDiskSizeGB": "10",
"expiryTime": "2020-01-30T11:26:18.663Z",
"backup_run": "projects/PROJECT_ID /instances/INSTANCE_ID /backupRuns/BACKUP_RUN_ID ",
"satisfies_pzs": false,
"satisfies_pzi": false
}
View details about a final backup
Use this example to view the details about a final backup. For a complete list of parameters for this call, see the
backupRuns.get
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID.
BACKUP_ID : the backup ID. You obtain this ID from the output of running the previous call.
HTTP method and URL:
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Execute the following command:
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID "
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method GET ` -Headers $headers ` -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID " | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"name": "projects/PROJECT_ID /backups/BACKUP_ID ",
"kind": "sql#backup",
"status": "SUCCESSFUL",
"backupInterval": {
"startTime": "2020-01-21T11:25:33.858Z",
"endTime": "2020-01-21T11:26:18.663Z",
}
"type": "FINAL",
"instance": "INSTANCE_ID ",
"selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ",
"location": "us"
"description": "final backup",
"backupKind": "SNAPSHOT",
"dataDiskSizeGB": "10",
"expiryTime": "2020-01-30T11:26:18.663Z",
"backup_run": "projects/PROJECT_ID /instances/INSTANCE_ID /backupRuns/BACKUP_RUN_ID ",
"satisfies_pzs": false,
"satisfies_pzi": false
}
Update a final backup
You can update how long Cloud SQL retains a final backup for an instance and the description for the backup by using the Google Cloud console, gcloud CLI , or the Cloud SQL API.
Console
In the Google Cloud console, go to the Cloud SQL Backups page.
Go to Cloud SQL Backups
This page lists all backups, including final backups, that are associated with a Google Cloud project.
To update a final backup, click the backup. A Final backup dialog appears.
To update how long Cloud SQL retains the final backup, complete the following actions:
Click the Edit retention icon next to the Backup retained until field.
Click the Select date icon next to the Retain backup until field.
In the calendar, select the new date that indicates how long Cloud SQL retains the final backup.
Click Update . You're returned to the Cloud SQL Backups page.
To update the description of the final backup, complete the following actions:
Click the final backup.
Click the Edit description icon next to the Description field.
In the Describe this backup field, enter the updated description for the final backup.
Click Update . You're returned to the Cloud SQL Backups page.
gcloud
To get a list of all final backups that are associated with a Google Cloud project, use the gcloud sql backups list
command:
gcloud sql backups list \
--filter= "type=FINAL"
Note : By using this command, you can retrieve information about the final backups, including their IDs. You need a backup ID to update a final backup.
Also, you can filter and control the results of running this command by using standard list parameters. For a complete list, see the gcloud sql backups list command reference page.
To update the description and retention period of a final backup, use the gcloud sql backups patch
command:
gcloud sql backups patch \
BACKUP_NAME \
--description= DESCRIPTION /
--expiry-time= DATE-AND-TIME-STAMP | --ttl-days= NUMBER-OF-DAYS
You obtain the BACKUP_NAME from the output of running the gcloud sql backups list
command. The BACKUP_NAME has the following format: projects/PROJECT_ID /backups/BACKUP_ID
.
For the --expiry-time
and --ttl-days
flags, use the following guidelines:
For the --expiry-time
flag, specify a date-and-time stamp of when Cloud SQL deletes the final backup automatically.
For the --ttl-days
flag, specify the retention period of the final backup (from 1 to 365 days). This is known as time to live (TTL) . The retention period starts from the current date and time, and the maximum retention period that Cloud SQL allows is 1 year (or 365 days).
Use either the --expiry-time
or the --ttl-days
flag, not both flags.
REST v1
Get a list of final backups
Use this example to get a list of all final backups that are associated with a Google Cloud project. For a complete list of parameters for this call, see the
backupRuns.list
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID
INSTANCE_ID : the instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups?filter=type=FINAL
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Execute the following command:
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups?filter=type=FINAL"
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method GET ` -Headers $headers ` -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups?filter=type=FINAL" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"name": "projects/PROJECT_ID /backups/BACKUP_ID ",
"kind": "sql#backup",
"status": "SUCCESSFUL",
"backupInterval": {
"startTime": "2020-01-21T11:25:33.858Z",
"endTime": "2020-01-21T11:26:18.663Z",
}
"type": "FINAL",
"instance": "INSTANCE_ID ",
"selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ",
"location": "us"
"description": "final backup",
"backupKind": "SNAPSHOT",
"dataDiskSizeGB": "10",
"expiryTime": "2020-01-30T11:26:18.663Z",
"backup_run": "projects/PROJECT_ID /instances/INSTANCE_ID /backupRuns/BACKUP_RUN_ID ",
"satisfies_pzs": false,
"satisfies_pzi": false
}
Update the retention period
You can update the retention period of a final backup in one of the following ways:
Retention days : Modify the number of days that Cloud SQL retains the backup.
Expiration time : Provide an updated date-and-time stamp for when Cloud SQL deletes the backup automatically.
Update a final backup by either modifying the retention days or by providing a updated expiration time. Don't use both ways.
Update the retention days
Use this example to update the number of days that Cloud SQL retains the final backup. For a complete list of parameters for this call, see the
backupRuns.update
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID.
BACKUP_ID : the backup ID. You obtain this ID from the output of running the previous call.
TTL_DAYS : the retention period of the final backup (from 1 to 365 days). This is known as time to live (TTL) . The retention period starts from the current date and time, and the maximum retention period that Cloud SQL allows is 1 year (or 365 days).
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=ttl_days
Request JSON body:
{
"backup": {
expiration: {
"ttl_days": TTL_DAYS ,
}
},
}
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Save the request body in a file named request.json
,
and execute the following command:
curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d @request.json \ "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=ttl_days"
PowerShell (Windows)
Save the request body in a file named request.json
,
and execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method PATCH ` -Headers $headers ` -ContentType: "application/json; charset=utf-8" ` -InFile request.json ` -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=ttl_days" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"kind": "sql#operation",
"targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ",
"status": "DONE",
"user": "user@example.com",
"insertTime": "2024-02-15T00:10:22.078Z",
"operationType": "UPDATE_BACKUP",
"name": "OPERATION_ID ",
"targetId": "BACKUP_ID ",
"selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /operations/OPERATION_ID ",
"targetProject": "PROJECT_ID "
}
Update the expiration time
Use this example to provide an updated date-and-time stamp for when Cloud SQL deletes the backup. For a complete list of parameters for this call, see the
backupRuns.update
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID.
BACKUP_ID : the backup ID. You obtain this ID from the output of running the previous call.
DATE_AND_TIME_STAMP : a date-and-time stamp of when Cloud SQL deletes the final backup automatically.
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=expiry_time
Request JSON body:
{
"backup": {
expiration: {
"expiry_time": DATE_AND_TIME_STAMP ,
}
},
}
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Save the request body in a file named request.json
,
and execute the following command:
curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d @request.json \ "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=expiry_time"
PowerShell (Windows)
Save the request body in a file named request.json
,
and execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method PATCH ` -Headers $headers ` -ContentType: "application/json; charset=utf-8" ` -InFile request.json ` -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=expiry_time" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"kind": "sql#operation",
"targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ",
"status": "DONE",
"user": "user@example.com",
"insertTime": "2024-02-15T00:10:22.078Z",
"operationType": "UPDATE_BACKUP",
"name": "OPERATION_ID ",
"targetId": "BACKUP_ID ",
"selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /operations/OPERATION_ID ",
"targetProject": "PROJECT_ID "
}
Update the description
Use this example to update the description of the final backup. For a complete list of parameters for this call, see the
backupRuns.update
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID.
BACKUP_ID : the backup ID. You obtain this ID from the output of running the previous call.
DESCRIPTION : the updated description for the final backup.
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=description
Request JSON body:
{
"backup": {
"description": DESCRIPTION ,
},
}
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Save the request body in a file named request.json
,
and execute the following command:
curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d @request.json \ "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=description"
PowerShell (Windows)
Save the request body in a file named request.json
,
and execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method PATCH ` -Headers $headers ` -ContentType: "application/json; charset=utf-8" ` -InFile request.json ` -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=description" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"kind": "sql#operation",
"targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ",
"status": "DONE",
"user": "user@example.com",
"insertTime": "2024-02-15T00:10:22.078Z",
"operationType": "UPDATE_BACKUP",
"name": "OPERATION_ID ",
"targetId": "BACKUP_ID ",
"selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /operations/OPERATION_ID ",
"targetProject": "PROJECT_ID "
}
REST v1beta4
Get a list of final backups
Use this example to get a list of all final backups that are associated with a Google Cloud project. For a complete list of parameters for this call, see the
backupRuns.list
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID
INSTANCE_ID : the instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups?filter=type=FINAL
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Execute the following command:
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups?filter=type=FINAL"
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method GET ` -Headers $headers ` -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups?filter=type=FINAL" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"name": "projects/PROJECT_ID /backups/BACKUP_ID ",
"kind": "sql#backup",
"status": "SUCCESSFUL",
"backupInterval": {
"startTime": "2020-01-21T11:25:33.858Z",
"endTime": "2020-01-21T11:26:18.663Z",
}
"type": "FINAL",
"instance": "INSTANCE_ID ",
"selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ",
"location": "us"
"description": "final backup",
"backupKind": "SNAPSHOT",
"dataDiskSizeGB": "10",
"expiryTime": "2020-01-30T11:26:18.663Z",
"backup_run": "projects/PROJECT_ID /instances/INSTANCE_ID /backupRuns/BACKUP_RUN_ID ",
"satisfies_pzs": false,
"satisfies_pzi": false
}
Update the retention period
You can update the retention period of a final backup in one of the following ways:
Retention days : Modify the number of days that Cloud SQL retains the backup
Expiration time : Provide an updated date-and-time stamp for when Cloud SQL deletes the backup automatically.
Update a final backup by either modifying the retention days or by providing a updated expiration time. Don't use both ways.
Update the retention days
Use this example to update the number of days that Cloud SQL retains the final backup. For a complete list of parameters for this call, see the
backupRuns.update
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID.
BACKUP_ID : the backup ID. You obtain this ID from the output of running the previous call.
TTL_DAYS : the retention period of the final backup (from 1 to 365 days). This is known as time to live (TTL) . The retention period starts from the current date and time, and the maximum retention period that Cloud SQL allows is 1 year (or 365 days).
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=ttl_days
Request JSON body:
{
"backup": {
expiration: {
"ttl_days": TTL_DAYS ,
}
},
}
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Save the request body in a file named request.json
,
and execute the following command:
curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d @request.json \ "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=ttl_days"
PowerShell (Windows)
Save the request body in a file named request.json
,
and execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method PATCH ` -Headers $headers ` -ContentType: "application/json; charset=utf-8" ` -InFile request.json ` -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=ttl_days" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"kind": "sql#operation",
"targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ",
"status": "DONE",
"user": "user@example.com",
"insertTime": "2024-02-15T00:10:22.078Z",
"operationType": "UPDATE_BACKUP",
"name": "OPERATION_ID ",
"targetId": "BACKUP_ID ",
"selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /operations/OPERATION_ID ",
"targetProject": "PROJECT_ID "
}
Update the expiration time
Use this example to provide an updated date-and-time stamp for when Cloud SQL deletes the backup. For a complete list of parameters for this call, see the
backupRuns.update
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID.
BACKUP_ID : the backup ID. You obtain this ID from the output of running the previous call.
DATE_AND_TIME_STAMP : a date-and-time stamp of when Cloud SQL deletes the final backup automatically.
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=expiry_time
Request JSON body:
{
"backup": {
expiration: {
"expiry_time": DATE_AND_TIME_STAMP ,
}
},
}
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Save the request body in a file named request.json
,
and execute the following command:
curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d @request.json \ "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=expiry_time"
PowerShell (Windows)
Save the request body in a file named request.json
,
and execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method PATCH ` -Headers $headers ` -ContentType: "application/json; charset=utf-8" ` -InFile request.json ` -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=expiry_time" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"kind": "sql#operation",
"targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ",
"status": "DONE",
"user": "user@example.com",
"insertTime": "2024-02-15T00:10:22.078Z",
"operationType": "UPDATE_BACKUP",
"name": "OPERATION_ID ",
"targetId": "BACKUP_ID ",
"selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /operations/OPERATION_ID ",
"targetProject": "PROJECT_ID "
}
Update the description
Use this example to update the description of the final backup. For a complete list of parameters for this call, see the
backupRuns.update
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID.
BACKUP_ID : the backup ID. You obtain this ID from the output of running the previous call.
DESCRIPTION : the updated description for the final backup.
HTTP method and URL:
PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=description
Request JSON body:
{
"backup": {
"description": DESCRIPTION ,
},
}
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Save the request body in a file named request.json
,
and execute the following command:
curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d @request.json \ "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=description"
PowerShell (Windows)
Save the request body in a file named request.json
,
and execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method PATCH ` -Headers $headers ` -ContentType: "application/json; charset=utf-8" ` -InFile request.json ` -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ?update_mask=description" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"kind": "sql#operation",
"targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ",
"status": "DONE",
"user": "user@example.com",
"insertTime": "2024-02-15T00:10:22.078Z",
"operationType": "UPDATE_BACKUP",
"name": "OPERATION_ID ",
"targetId": "BACKUP_ID ",
"selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /operations/OPERATION_ID ",
"targetProject": "PROJECT_ID "
}
Delete a final backup
You can delete a final backup by using the Google Cloud console, gcloud CLI , or the Cloud SQL API.
Deleting a backup might not
free up as much space as the size of the backup. This is because backups are
incremental, so deleting an older backup might transfer some of its contents
to a more recent backup to preserve the integrity of the newer backup.
Console
In the Google Cloud console, go to the Cloud SQL Backups page.
Go to Cloud SQL Backups
This page lists all backups, including final backups, that are associated with a Google Cloud project.
For the final backup that you want to delete, click more actions , and then select Delete .
In the Delete final backup? window, enter the name of the instance that you used to create the final backup, and then click Delete .
gcloud
To get a list of all final backups that are associated with a Google Cloud project, use the gcloud sql backups list
command:
gcloud sql backups list \
--filter= "type=FINAL"
Note : By using this command, you can retrieve information about the backups, including their IDs. You need a backup ID to delete a final backup.
Also, you can filter and control the results of running this command by using standard list parameters. For a complete list, see the gcloud sql backups list command reference page.
To delete a final backup, use the gcloud sql backups delete
command:
gcloud sql backups delete \
BACKUP_NAME
You obtain the BACKUP_NAME from the output of running the gcloud sql backups list
command. The BACKUP_NAME has the following format: projects/PROJECT_ID /backups/BACKUP_ID
.
REST v1
Get a list of final backups
Use this example to get a list of all final backups that are associated with a Google Cloud project. For a complete list of parameters for this call, see the
backupRuns.list
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID
INSTANCE_ID : the instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups?filter=type=FINAL
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Execute the following command:
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups?filter=type=FINAL"
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method GET ` -Headers $headers ` -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups?filter=type=FINAL" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"name": "projects/PROJECT_ID /backups/BACKUP_ID ",
"kind": "sql#backup",
"status": "SUCCESSFUL",
"backupInterval": {
"startTime": "2020-01-21T11:25:33.858Z",
"endTime": "2020-01-21T11:26:18.663Z",
}
"type": "FINAL",
"instance": "INSTANCE_ID ",
"selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ",
"location": "us"
"description": "final backup",
"backupKind": "SNAPSHOT",
"dataDiskSizeGB": "10",
"expiryTime": "2020-01-30T11:26:18.663Z",
"backup_run": "projects/PROJECT_ID /instances/INSTANCE_ID /backupRuns/BACKUP_RUN_ID ",
"satisfies_pzs": false,
"satisfies_pzi": false
}
Delete a final backup
Use this example to delete a final backup. For a complete list of parameters for this call, see the
backupRuns.delete
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID.
BACKUP_ID : the backup ID. You obtain this ID from the output of running the previous call.
HTTP method and URL:
DELETE https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Execute the following command:
curl -X DELETE \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID "
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method DELETE ` -Headers $headers ` -Uri "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID " | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"kind": "sql#operation",
"targetLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /backups/BACKUP_ID ",
"status": "PENDING",
"user": "user@example.com",
"insertTime": "2020-01-21T22:43:37.981Z",
"operationType": "DELETE_BACKUP",
"name": "OPERATION_ID ",
"targetId": "BACKUP_ID ",
"selfLink": "https://sqladmin.googleapis.com/v1/projects/PROJECT_ID /operations/OPERATION_ID ",
"targetProject": "PROJECT_ID "
}
REST v1beta4
Get a list of final backups
Use this example to get a list of all final backups that are associated with a Google Cloud project. For a complete list of parameters for this call, see the
backupRuns.list
page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID
INSTANCE_ID : the instance ID
HTTP method and URL:
GET https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups?filter=type=FINAL
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Execute the following command:
curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups?filter=type=FINAL"
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method GET ` -Headers $headers ` -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups?filter=type=FINAL" | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"name": "projects/PROJECT_ID /backups/BACKUP_ID ",
"kind": "sql#backup",
"status": "SUCCESSFUL",
"backupInterval": {
"startTime": "2020-01-21T11:25:33.858Z",
"endTime": "2020-01-21T11:26:18.663Z",
}
"type": "FINAL",
"instance": "INSTANCE_ID ",
"selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ",
"location": "us"
"description": "final backup",
"backupKind": "SNAPSHOT",
"dataDiskSizeGB": "10",
"expiryTime": "2020-01-30T11:26:18.663Z",
"backup_run": "projects/PROJECT_ID /instances/INSTANCE_ID /backupRuns/BACKUP_RUN_ID ",
"satisfies_pzs": false,
"satisfies_pzi": false
}
Delete a final backup
Use this example to delete a final backup. For a complete list of parameters for this call, see the
backupRuns.delete page.
Before using any of the request data,
make the following replacements:
PROJECT_ID : the project ID.
BACKUP_ID : the backup ID. You obtain this ID from the output of running the previous call.
HTTP method and URL:
DELETE https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID
To send your request, expand one of these options:
curl (Linux, macOS, or Cloud Shell)
Note:
The following command assumes that you have logged in to
the gcloud
CLI with your user account by running
gcloud init
or
gcloud auth login
, or by using Cloud Shell ,
which automatically logs you into the gcloud
CLI
.
You can check the currently active account by running
gcloud auth list
.
Execute the following command:
curl -X DELETE \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID "
PowerShell (Windows)
Execute the following command:
$cred = gcloud auth print-access-token $headers = @{ "Authorization" = "Bearer $cred" } Invoke-WebRequest ` -Method DELETE ` -Headers $headers ` -Uri "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID " | Select-Object -Expand Content
You should receive a JSON response similar to the following:
Response
{
"kind": "sql#operation",
"targetLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /backups/BACKUP_ID ",
"status": "PENDING",
"user": "user@example.com",
"insertTime": "2020-01-21T22:43:37.981Z",
"operationType": "DELETE_BACKUP",
"name": "OPERATION_ID ",
"targetId": "BACKUP_ID ",
"selfLink": "https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID /operations/OPERATION_ID ",
"targetProject": "PROJECT_ID "
}
What's next