Method: projects.locations.backups.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://firestore.googleapis.com/v1/{parent=projects/*/locations/*}/backups
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The location to list backups from. Format is projects/{project}/locations/{location}. Use {location} = '-' to list backups from all locations for the given project. This allows listing backups from a single location or from all locations.
|
Query parameters
| Parameters |
filter |
string
An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering:
databaseUid (supports = only)
|
Request body
The request body must be empty.
Response body
The response for FirestoreAdmin.ListBackups.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"backups": [
{
object (Backup)
}
],
"unreachable": [
string
]
} |
| Fields |
backups[] |
object (Backup)
List of all backups for the project.
|
unreachable[] |
string
List of locations that existing backups were not able to be fetched from. Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-24 UTC.
[null,null,["Last updated 2025-01-24 UTC."],[],[],null,["# Method: projects.locations.backups.list\n\nLists all the backups.\n\n### HTTP request\n\n`GET https://firestore.googleapis.com/v1/{parent=projects/*/locations/*}/backups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The location to list backups from. Format is `projects/{project}/locations/{location}`. Use `{location} = '-'` to list backups from all locations for the given project. This allows listing backups from a single location or from all locations. |\n\n### Query parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `\u003c`, `\u003e`, `\u003c=`, `\u003e=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the [Backup](/docs/firestore/reference/rest/v1/projects.locations.backups#Backup) are eligible for filtering: - `databaseUid` (supports `=` only) |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response for [FirestoreAdmin.ListBackups](/docs/firestore/reference/rest/v1/projects.locations.backups/list#google.firestore.admin.v1.FirestoreAdmin.ListBackups).\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"backups\": [ { object (/docs/firestore/reference/rest/v1/projects.locations.backups#Backup) } ], \"unreachable\": [ string ] } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `backups[]` | `object (`[Backup](/docs/firestore/reference/rest/v1/projects.locations.backups#Backup)`)` List of all backups for the project. |\n| `unreachable[]` | `string` List of locations that existing backups were not able to be fetched from. Instead of failing the entire requests when a single location is unreachable, this response returns a partial result set and list of locations unable to be reached here. The request can be retried against a single location to get a concrete error. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/datastore`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
