Required. The project and location for which to retrieve backup information, in the formatprojects/{projectNumber}/locations/{location}. In Filestore, backup locations map to Google Cloud regions, for exampleus-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 API endpoint lists all backups within a specified project and location, or across all locations if requested.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses the \u003ccode\u003eGET\u003c/code\u003e method with a URL structure that requires a project and location, with support for retrieving backups from all locations using "-" as the location value.\u003c/p\u003e\n"],["\u003cp\u003eThe request supports optional query parameters such as \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003eorderBy\u003c/code\u003e, and \u003ccode\u003efilter\u003c/code\u003e to control the size, pagination, sorting, and filtering of the results, respectively.\u003c/p\u003e\n"],["\u003cp\u003eThe response body, structured as \u003ccode\u003eListBackupsResponse\u003c/code\u003e, provides an array of \u003ccode\u003ebackups\u003c/code\u003e, a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination, and an \u003ccode\u003eunreachable\u003c/code\u003e list indicating any locations that couldn't be reached during the request.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization to use this API requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.backups.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListBackupsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all backups in a project for either a specified location or for all locations.\n\n### HTTP request\n\n`GET https://file.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\nListBackupsResponse is the result of ListBackupsRequest.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp)."]]
