Required. The project and location for which to retrieve BackupPlans information. Format: projects/{project}/locations/{location}. In Cloud BackupDR, locations map to GCP regions, for e.g. us-central1. To retrieve backup plans for all locations, use "-" for the {location} value.
Query parameters
Parameters
pageSize
integer
Optional. The maximum number of BackupPlans to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's nextPageToken to determine if there are more instances left to be queried.
pageToken
string
Optional. The value of nextPageToken received from a previous backupPlans.list call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to backupPlans.list must match the call that provided the page token.
filter
string
Optional. Field match expression used to filter the results.
orderBy
string
Optional. Field by which to sort the results.
Request body
The request body must be empty.
Response body
The response message for getting a list of BackupPlan.
If successful, the response body contains data with the following structure:
The list of BackupPlans in the project for the specified location.
If the {location} value in the request is "-", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return backup plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. BackupPlan
nextPageToken
string
A token which may be sent as pageToken in a subsequent backupPlans.list call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return.
[[["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-07-08 UTC."],[[["\u003cp\u003eThis webpage details how to list BackupPlans within a specific project and location using a \u003ccode\u003eGET\u003c/code\u003e HTTP request.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires a \u003ccode\u003eparent\u003c/code\u003e path parameter, specifying the project and location, and accepts optional query parameters like \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e, and \u003ccode\u003eorderBy\u003c/code\u003e for managing the results.\u003c/p\u003e\n"],["\u003cp\u003eThe response body includes a list of \u003ccode\u003eBackupPlans\u003c/code\u003e, a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination, and an \u003ccode\u003eunreachable\u003c/code\u003e field indicating locations that could not be reached.\u003c/p\u003e\n"],["\u003cp\u003eNo request body is required for this operation, as all parameters are passed through the URL or query string.\u003c/p\u003e\n"],["\u003cp\u003eTo authorize this request, the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e is required.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.backupPlans.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.ListBackupPlansResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists BackupPlans in a given project and location.\n\n### HTTP request\n\n`GET https://backupdr.googleapis.com/v1/{parent=projects/*/locations/*}/backupPlans`\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 message for getting a list of `BackupPlan`.\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)."]]
