Lists all the backups.
HTTP request
GET https://firestore.googleapis.com/v1/{parent=projects/*/locations/*}/backups
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
parent
|
Required. The location to list backups from. Format is |
Query 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 (
|
| Fields | |
|---|---|
backups[]
|
List of all backups for the project. |
unreachable[]
|
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/datastore -
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
