Required. The project and location for which to retrieve backup information, in the format projects/{projectId}/locations/{location}. In Filestore, backup locations map to Google Cloud regions, for example us-west1. To retrieve backup information for all locations, use "-" for the {location} value.
Query parameters
Parameters
pageSize
integer
The maximum number of items to return.
pageToken
string
The nextPageToken value to use if there are additional results to retrieve for this list request.
orderBy
string
Sort results. Supported values are "name", "name desc" or "" (unsorted).
filter
string
List filter.
Request body
The request body must be empty.
Response body
ListBackupsResponse is the result of ListBackupsRequest.
If successful, the response body contains data with the following structure:
A list of backups in the project for the specified location.
If the {location} value in the request is "-", the response contains a list of backups from all locations. If any location is unreachable, the response will only return backups in reachable locations and the "unreachable" field will be populated with a list of unreachable locations.
nextPageToken
string
The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
unreachable[]
string
Unordered list. Locations that could not be reached.
[[["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-06-17 UTC."],[[["\u003cp\u003eThis endpoint retrieves a list of backups within a specified project and location, or across all locations if indicated.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL utilizes gRPC Transcoding syntax and requires a \u003ccode\u003eparent\u003c/code\u003e path parameter specifying the project and location.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters like \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003eorderBy\u003c/code\u003e, and \u003ccode\u003efilter\u003c/code\u003e allow for pagination, sorting, and filtering of backup results.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains a list of backup objects, a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination, and an \u003ccode\u003eunreachable\u003c/code\u003e list of any inaccessible locations.\u003c/p\u003e\n"],["\u003cp\u003eThe request must have an empty body and be authorized with the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,[]]
