2026-11-04
▼ ▲ backupdr.projects.locations.restoreTemplates.executions.triggerRestoreCleanup
Scopes :
Description : Triggers cleanup of restored resources created during execution.
Parameter Order : name
Path : v1beta/{+name}:triggerRestoreCleanup
HTTP Method : POST
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+/executions/[^/]+$
Location : path
Description : Required. Name of the restore template execution. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}/executions/{execution_id}'
Required : Yes
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}/executions/{executionsId}:triggerRestoreCleanup
▼ ▲ backupdr.projects.locations.restoreTemplates.executions.get
Parameters :
name
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+/executions/[^/]+$
Description : Required. The name of the restore template execution to retrieve. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}/executions/{execution_id}'
Scopes :
HTTP Method : GET
Description : Gets details of a RestoreTemplateExecution.
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}/executions/{executionsId}
Path : v1beta/{+name}
▼ ▲ backupdr.projects.locations.restoreTemplates.executions.list
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}/executions
Parameters :
parent
Type : string
Description : Required. The project, location, and restore template for which to retrieve executions information. Format: `projects/{project}/locations/{location}/restoreTemplates/{restore_template}`.
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+$
Required : Yes
Location : path
filter
Description : Optional. Filtering results.
Type : string
Location : query
orderBy
Location : query
Type : string
Description : Optional. Hint for how to order the results.
pageToken
Description : Optional. A token identifying a page of results.
Location : query
Type : string
pageSize
Type : integer
Format : int32
Description : Optional. Requested page size.
Location : query
Parameter Order : parent
Scopes :
Path : v1beta/{+parent}/executions
Description : Lists RestoreTemplateExecutions in a given project, location and restore template.
▼ ▲ backupdr.projects.locations.restoreTemplates.get
Path : v1beta/{+name}
Scopes :
Description : Gets details of a RestoreTemplate.
Parameter Order : name
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}
Parameters :
name
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+$
Type : string
Description : Required. The name of the restore template to retrieve. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'
▼ ▲ backupdr.projects.locations.restoreTemplates.delete
Scopes :
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}
Parameters :
requestId
Location : query
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 request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+$
Type : string
Description : Required. The name of the restore template to delete. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'
Location : path
force
Location : query
Type : boolean
Description : Optional. If set to true, any child RestoreTemplateExecutions will also be deleted. If false and the RestoreTemplate has any child executions, the request will fail.
HTTP Method : DELETE
Description : Deletes a RestoreTemplate.
Parameter Order : name
▼ ▲ backupdr.projects.locations.restoreTemplates.create
Scopes :
Parameter Order : parent
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreTemplates
Parameters :
parent
Type : string
Location : path
Description : Required. The restore template project and location in the format 'projects/{project_id}/locations/{location}'.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
requestId
Location : query
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 request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
restoreTemplateId
Type : string
Description : Required. The ID of the restore template to create. The ID must be unique for the specified project and location.
Location : query
HTTP Method : POST
Description : Creates a new RestoreTemplate in a given project and location.
Path : v1beta/{+parent}/restoreTemplates
▼ ▲ backupdr.projects.locations.restoreTemplates.patch
Path : v1beta/{+name}
Description : Updates the settings of a RestoreTemplate.
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}
Parameters :
validateOnly
Type : boolean
Location : query
Description : Optional. Only validate the request, but do not perform mutations. The default is 'false'.
updateMask
Location : query
Format : google-fieldmask
Type : string
Description : Optional. The list of fields to update. Field mask is used to specify the fields to be overwritten in the RestoreTemplate 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.
requestId
Type : string
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 request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
name
Required : Yes
Description : Identifier. The resource name of the RestoreTemplate.
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+$
Type : string
Location : path
HTTP Method : PATCH
Scopes :
▼ ▲ backupdr.projects.locations.restoreTemplates.list
Parameter Order : parent
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreTemplates
HTTP Method : GET
Description : Lists RestoreTemplates in a given project and location.
Parameters :
filter
Type : string
Description : Optional. Field match expression used to filter the results.
Location : query
pageToken
Description : Optional. A page token, received from a previous `ListRestoreTemplates` call.
Type : string
Location : query
parent
Location : path
Description : Required. The project and location from which to list the restore templates. Format: `projects/{project}/locations/{location}`.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
pageSize
Location : query
Format : int32
Type : integer
Description : Optional. The maximum number of items to return.
orderBy
Location : query
Type : string
Description : Optional. Field by which to sort the results.
Scopes :
Path : v1beta/{+parent}/restoreTemplates
▼ ▲ backupdr.projects.locations.restoreTemplates.run
HTTP Method : POST
Scopes :
Parameters :
name
Type : string
Location : path
Description : Required. The name of the restore template to run. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+$
Parameter Order : name
Path : v1beta/{+name}:run
Description : Runs a RestoreTemplate.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}:run
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.delete
Path : v1beta/{+name}
Scopes :
Description : Deletes a single RestoreVerificationPlan. If the `force` flag is set to `true`, any RestoreVerificationPlanAssociations linked to this RestoreVerificationPlan will also be deleted.
HTTP Method : DELETE
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}
Parameters :
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 after the first request. For example, consider a situation where you make an initial request and the 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
force
Description : Optional. If set to true, any RestoreVerificationPlanAssociations linked to this RestoreVerificationPlan will also be deleted.
Type : boolean
Location : query
name
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+$
Description : Required. The resource name of the `RestoreVerificationPlan` to delete. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}`
Parameter Order : name
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.list
Parameters :
parent
Required : Yes
Description : Required. The project and location for which to retrieve `RestoreVerificationPlans` information. Format: `projects/{project}/locations/{location}`. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve restore verification plans for all locations, use "-" for the `{location}` value.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
orderBy
Description : Optional. Field by which to sort the results.
Type : string
Location : query
filter
Location : query
Type : string
Description : Optional. Field match expression used to filter the results.
pageToken
Description : Optional. The value of next_page_token received from a previous `ListRestoreVerificationPlans` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestoreVerificationPlans` must match the call that provided the page token.
Location : query
Type : string
pageSize
Format : int32
Location : query
Type : integer
Description : Optional. The maximum number of `RestoreVerificationPlans` 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.
Parameter Order : parent
HTTP Method : GET
Scopes :
Description : Lists RestoreVerificationPlans in a given project and location.
Path : v1beta/{+parent}/restoreVerificationPlans
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.create
Parameter Order : parent
HTTP Method : POST
Parameters :
requestId
Type : string
Location : query
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 the 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).
parent
Description : Required. The `RestoreVerificationPlan` project and location in the format `projects/{project}/locations/{location}`. In Google Cloud Backup and DR locations map to Google Cloud regions, for example **us-central1**.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Required : Yes
restoreVerificationPlanId
Location : query
Description : Required. The name of the `RestoreVerificationPlan` to create. The name must be unique for the specified project and location. The name must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens. Pattern, `^[a-z]([-a-z0-9]*[a-z0-9])?$`.
Type : string
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans
Scopes :
Path : v1beta/{+parent}/restoreVerificationPlans
Description : Creates a new RestoreVerificationPlan in a given project and location.
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.get
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}
Path : v1beta/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+$
Description : Required. The resource name of the `RestoreVerificationPlan` to retrieve. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}`
Type : string
Required : Yes
Location : path
HTTP Method : GET
Parameter Order : name
Description : Gets details of a single RestoreVerificationPlan. Returns the requested RestoreVerificationPlan.
Scopes :
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.associations.delete
Description : Deletes a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}/associations/{associationsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. The resource name of the RestoreVerificationPlanAssociation to delete. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}`
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+/associations/[^/]+$
Type : string
Location : path
Required : Yes
requestId
Type : string
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 that the server has already received the duplicate request and can avoid responding with an error. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location : query
Parameter Order : name
Path : v1beta/{+name}
Scopes :
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.associations.list
Parameter Order : parent
Path : v1beta/{+parent}/associations
Description : Lists RestoreVerificationPlanAssociations in a given RestoreVerificationPlan.
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}/associations
Parameters :
orderBy
Location : query
Type : string
Description : Optional. Hint for how to order the results.
pageSize
Type : integer
Format : int32
Location : query
Description : Optional. The maximum number of associations to return. The service may return fewer than this value. If unspecified, at most 500 associations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken
Type : string
Description : Optional. A page token, received from a previous `ListRestoreVerificationPlanAssociations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRestoreVerificationPlanAssociations` must match the call that provided the page token.
Location : query
parent
Description : Required. The parent RestoreVerificationPlan name. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}`
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+$
filter
Description : Optional. Filtering results.
Type : string
Location : query
HTTP Method : GET
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.associations.create
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}/associations
Parameters :
restoreVerificationPlanAssociationId
Type : string
Location : query
Description : Required. The ID to use for the association, which will become the final component of the association's resource name. This value should be 1-63 characters, and valid characters are /[a-z0-9_-]/.
parent
Required : Yes
Description : Required. The parent resource where this association will be created. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}`
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+$
Type : string
requestId
Type : string
Location : query
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 that the server has already received the duplicate request and can avoid responding with an error. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
HTTP Method : POST
Description : Creates a new RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.
Scopes :
Parameter Order : parent
Path : v1beta/{+parent}/associations
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.associations.get
Parameter Order : name
Description : Gets details of a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.
Parameters :
name
Location : path
Description : Required. The resource name of the RestoreVerificationPlanAssociation to retrieve. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}`
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+/associations/[^/]+$
Type : string
Required : Yes
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}/associations/{associationsId}
HTTP Method : GET
Path : v1beta/{+name}
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.associations.triggerRestoreVerification
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+/associations/[^/]+$
Type : string
Location : path
Description : Required. The resource name of the RestoreVerificationPlanAssociation to trigger. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}`
Required : Yes
Parameter Order : name
HTTP Method : POST
Scopes :
Path : v1beta/{+name}:triggerRestoreVerification
Description : Triggers a new Restore Verification for the association in a given RestoreVerificationPlan.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}/associations/{associationsId}:triggerRestoreVerification