2026-11-04
▼ ▲ backupdr.projects.locations.restoreTemplates.executions.list
Scopes :
Parameter Order : parent
Parameters :
orderBy
Type : string
Location : query
Description : Optional. Hint for how to order the results.
parent
Location : path
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
Type : string
pageSize
Location : query
Format : int32
Type : integer
Description : Optional. Requested page size.
pageToken
Location : query
Description : Optional. A token identifying a page of results.
Type : string
filter
Description : Optional. Filtering results.
Type : string
Location : query
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}/executions
HTTP Method : GET
Description : Lists RestoreTemplateExecutions in a given project, location and restore template.
Path : v1/{+parent}/executions
▼ ▲ backupdr.projects.locations.restoreTemplates.executions.triggerRestoreCleanup
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}/executions/{executionsId}:triggerRestoreCleanup
Scopes :
Path : v1/{+name}:triggerRestoreCleanup
Description : Triggers cleanup of restored resources created during execution.
Parameter Order : name
HTTP Method : POST
Parameters :
name
Location : path
Description : Required. Name of the restore template execution. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}/executions/{execution_id}'
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+/executions/[^/]+$
Required : Yes
Type : string
▼ ▲ backupdr.projects.locations.restoreTemplates.executions.get
Description : Gets details of a RestoreTemplateExecution.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}/executions/{executionsId}
Parameter Order : name
Scopes :
Path : v1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+/executions/[^/]+$
Location : path
Type : string
Description : Required. The name of the restore template execution to retrieve. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}/executions/{execution_id}'
Required : Yes
HTTP Method : GET
▼ ▲ backupdr.projects.locations.restoreTemplates.list
Description : Lists RestoreTemplates in a given project and location.
Scopes :
Path : v1/{+parent}/restoreTemplates
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreTemplates
Parameters :
filter
Location : query
Type : string
Description : Optional. Field match expression used to filter the results.
parent
Location : path
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The project and location from which to list the restore templates. Format: `projects/{project}/locations/{location}`.
pageSize
Location : query
Type : integer
Description : Optional. The maximum number of items to return.
Format : int32
orderBy
Description : Optional. Field by which to sort the results.
Location : query
Type : string
pageToken
Type : string
Description : Optional. A page token, received from a previous `ListRestoreTemplates` call.
Location : query
HTTP Method : GET
▼ ▲ backupdr.projects.locations.restoreTemplates.run
Parameters :
name
Location : path
Description : Required. The name of the restore template to run. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+$
Required : Yes
Type : string
HTTP Method : POST
Scopes :
Description : Runs a RestoreTemplate.
Path : v1/{+name}:run
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}:run
▼ ▲ backupdr.projects.locations.restoreTemplates.patch
Parameter Order : name
Description : Updates the settings of a RestoreTemplate.
HTTP Method : PATCH
Parameters :
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
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is 'false'.
Location : query
Type : boolean
updateMask
Location : query
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.
Type : string
Format : google-fieldmask
name
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+$
Description : Identifier. The resource name of the RestoreTemplate.
Location : path
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}
Path : v1/{+name}
▼ ▲ backupdr.projects.locations.restoreTemplates.get
HTTP Method : GET
Path : v1/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+$
Description : Required. The name of the restore template to retrieve. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'
Location : path
Required : Yes
Type : string
Scopes :
Parameter Order : name
Description : Gets details of a RestoreTemplate.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}
▼ ▲ backupdr.projects.locations.restoreTemplates.create
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreTemplates
Path : v1/{+parent}/restoreTemplates
Parameter Order : parent
Description : Creates a new RestoreTemplate in a given project and location.
Parameters :
restoreTemplateId
Description : Required. The ID of the restore template to create. The ID must be unique for the specified project and location.
Type : string
Location : query
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 request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Type : string
Location : query
parent
Location : path
Required : Yes
Description : Required. The restore template project and location in the format 'projects/{project_id}/locations/{location}'.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
HTTP Method : POST
▼ ▲ backupdr.projects.locations.restoreTemplates.delete
Description : Deletes a RestoreTemplate.
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreTemplates/{restoreTemplatesId}
Scopes :
Parameter Order : name
HTTP Method : DELETE
Parameters :
force
Location : query
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.
Type : boolean
name
Location : path
Description : Required. The name of the restore template to delete. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/restoreTemplates/[^/]+$
Required : Yes
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 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
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.associations.triggerRestoreVerification
Parameters :
name
Description : Required. The resource name of the RestoreVerificationPlanAssociation to trigger. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}`
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+/associations/[^/]+$
Location : path
HTTP Method : POST
Description : Triggers a new Restore Verification for the association in a given RestoreVerificationPlan.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}/associations/{associationsId}:triggerRestoreVerification
Path : v1/{+name}:triggerRestoreVerification
Scopes :
Parameter Order : name
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.associations.get
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}/associations/{associationsId}
Description : Gets details of a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.
HTTP Method : GET
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Required : Yes
Type : string
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/[^/]+$
Location : path
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.associations.delete
Path : v1/{+name}
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/[^/]+$
Location : path
Type : string
Required : Yes
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 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).
Type : string
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}/associations/{associationsId}
Description : Deletes a single RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.
HTTP Method : DELETE
Parameter Order : name
Scopes :
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.associations.create
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}/associations
Parameter Order : parent
Path : v1/{+parent}/associations
Parameters :
restoreVerificationPlanAssociationId
Type : string
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_-]/.
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+$
Location : path
Type : string
Description : Required. The parent resource where this association will be created. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}`
Required : Yes
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 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).
Type : string
Location : query
HTTP Method : POST
Description : Creates a new RestoreVerificationPlanAssociation in a given RestoreVerificationPlan.
Scopes :
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.associations.list
Parameter Order : parent
Description : Lists RestoreVerificationPlanAssociations in a given RestoreVerificationPlan.
Path : v1/{+parent}/associations
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}/associations
Parameters :
parent
Description : Required. The parent RestoreVerificationPlan name. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}`
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+$
Type : string
orderBy
Type : string
Location : query
Description : Optional. Hint for how to order the results.
pageSize
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.
Location : query
Type : integer
Format : int32
filter
Description : Optional. Filtering results.
Location : query
Type : string
pageToken
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
Type : string
Scopes :
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.get
Path : v1/{+name}
Parameters :
name
Location : path
Description : Required. The resource name of the `RestoreVerificationPlan` to retrieve. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+$
Type : string
Description : Gets details of a single RestoreVerificationPlan. Returns the requested RestoreVerificationPlan.
HTTP Method : GET
Parameter Order : name
Scopes :
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.delete
Scopes :
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans/{restoreVerificationPlansId}
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 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).
Type : string
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/restoreVerificationPlans/[^/]+$
Required : Yes
Description : Required. The resource name of the `RestoreVerificationPlan` to delete. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}`
Type : string
force
Type : boolean
Description : Optional. If set to true, any RestoreVerificationPlanAssociations linked to this RestoreVerificationPlan will also be deleted.
Location : query
Parameter Order : name
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
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.list
HTTP Method : GET
Parameters :
orderBy
Location : query
Description : Optional. Field by which to sort the results.
Type : string
pageToken
Type : string
Location : query
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.
filter
Description : Optional. Field match expression used to filter the results.
Location : query
Type : string
pageSize
Location : query
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.
Type : integer
Format : int32
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
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
Scopes :
Path : v1/{+parent}/restoreVerificationPlans
Parameter Order : parent
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans
Description : Lists RestoreVerificationPlans in a given project and location.
▼ ▲ backupdr.projects.locations.restoreVerificationPlans.create
Scopes :
Parameter Order : parent
Description : Creates a new RestoreVerificationPlan in a given project and location.
Path : v1/{+parent}/restoreVerificationPlans
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreVerificationPlans
Parameters :
parent
Required : Yes
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**.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
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 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).
Type : string
Location : query
restoreVerificationPlanId
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])?$`.
Location : query
Type : string
HTTP Method : POST