Format isprojects/{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 theBackupare eligible for filtering:
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-19 UTC."],[[["\u003cp\u003eThis API endpoint lists all backups for a specified project and location, or all locations within a project.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eparent\u003c/code\u003e parameter is required to define the project and location, allowing for listing backups from a specific location or all locations within a project.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003efilter\u003c/code\u003e query parameter can be used to refine the backup list based on the \u003ccode\u003edatabaseUid\u003c/code\u003e field.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of \u003ccode\u003ebackups\u003c/code\u003e, along with an \u003ccode\u003eunreachable\u003c/code\u003e list that displays the locations for which backups could not be retrieved, indicating a potential partial response.\u003c/p\u003e\n"],["\u003cp\u003eTo use this API, requests require appropriate authorization scopes such as \u003ccode\u003ehttps://www.googleapis.com/auth/datastore\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e.\u003c/p\u003e\n"]]],[],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### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response for [FirestoreAdmin.ListBackups](/firestore/docs/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### 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 [Authentication Overview](/docs/authentication#authorization-gcp)."]]
