2025-06-12
▼ ▲ backupdr.projects.locations.backupPlans.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}
HTTP Method : PATCH
Parameters :
name
Description : Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
Pattern : ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlan resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. Currently, these fields are supported in update: description, schedules, retention period, adding and removing Backup Rules.
Location : query
Type : string
Format : google-fieldmask
requestId
Description : Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a BackupPlan
▼ ▲ backupdr.projects.locations.backupPlans.revisions.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/revisions/{revisionsId}
HTTP Method : GET
Parameters :
name
Description : Required. The resource name of the `BackupPlanRevision` to retrieve. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision}`
Pattern : ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/revisions/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Gets details of a single BackupPlanRevision.
▼ ▲ backupdr.projects.locations.backupPlans.revisions.list
Path : v1/{+parent}/revisions
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/revisions
HTTP Method : GET
Parameters :
parent
Description : Required. The project and location for which to retrieve `BackupPlanRevisions` information. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`. In Cloud BackupDR, locations map to GCP regions, for e.g. **us-central1**.
Pattern : ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : 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 next_page_token to determine if there are more instances left to be queried.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The value of next_page_token received from a previous `ListBackupPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlans` must match the call that provided the page token.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists BackupPlanRevisions in a given project and location.