2026-09-09
▼ ▲ backupdr.projects.locations.get
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}
Description : Gets information about a location.
Path : v1beta/{+name}
HTTP Method : GET
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Resource name for the location.
Scopes :
Parameter Order : name
▼ ▲ backupdr.projects.locations.getTrial
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/trial
HTTP Method : GET
Description : Gets the Trial state for a given project
Parameter Order : name
Scopes :
Parameters :
name
Description : Required. The project for which trial details need to be retrieved. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia.
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/trial$
Location : path
Path : v1beta/{+name}
▼ ▲ backupdr.projects.locations.list
Parameter Order : name
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations
Description : Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Path : v1beta/{+name}/locations
Scopes :
Parameters :
pageSize
Description : The maximum number of results to return. If not set, the service selects a default.
Format : int32
Location : query
Type : integer
extraLocationTypes
Type : string
Description : Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
Location : query
Repeated : Yes
name
Required : Yes
Pattern : ^projects/[^/]+$
Description : The resource that owns the locations collection, if applicable.
Location : path
Type : string
filter
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Type : string
Location : query
pageToken
Type : string
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
▼ ▲ backupdr.projects.locations.trial.subscribe
Path : v1beta/{+parent}/trial:subscribe
Parameters :
parent
Description : Required. The project where this trial will be created. Format: projects/{project}/locations/{location} Supported Locations are - us, eu and asia.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Required : Yes
Location : path
Description : Subscribes to a trial for a project
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/trial:subscribe
HTTP Method : POST
Parameter Order : parent
▼ ▲ backupdr.projects.locations.trial.end
Description : Ends the trial for a project
Parameters :
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Required : Yes
Description : Required. The parent resource where the trial has been created. Format: projects/{project}/locations/{location}
Parameter Order : parent
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/trial:end
HTTP Method : POST
Scopes :
Path : v1beta/{+parent}/trial:end
▼ ▲ backupdr.projects.locations.appliedAutoProtectionPolicies.list
HTTP Method : GET
Path : v1beta/{+parent}/appliedAutoProtectionPolicies
Parameter Order : parent
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/appliedAutoProtectionPolicies
Description : Lists AppliedAutoProtectionPolicies in a given project and location.
Parameters :
pageSize
Description : Optional. The maximum number of applied policies to return in a single page.
Location : query
Type : integer
Format : int32
filter
Description : Optional. A filter expression that filters resources listed in the response.
Location : query
Type : string
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous `ListAppliedAutoProtectionPolicies` call.
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The project and location for which to retrieve the list of applied policies. Format: projects/{project}/locations/{location}
Required : Yes
Type : string
Location : path
orderBy
Description : Optional. An expression that sorts the results in the response.
Location : query
Type : string
Scopes :
▼ ▲ backupdr.projects.locations.autoProtectionPolicies.list
Path : v1beta/{+parent}/autoProtectionPolicies
Parameter Order : parent
Parameters :
pageToken
Type : string
Location : query
Description : Optional. A page token, received from a previous `ListAutoProtectionPolicies` call. Provide this to retrieve the subsequent page.
filter
Description : Optional. A filter expression that filters resources listed in the response. The following fields are filterable:
Location : query
Type : string
pageSize
Format : int32
Description : Optional. The maximum number of policies to return in a single page. If unspecified, a server-default value will be used.
Type : integer
Location : query
parent
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
Description : Required. The project and location for which to retrieve the list of policies. Format: projects/{project}/locations/{location}
orderBy
Description : Optional. An expression that sorts the results in the response. The following fields are sortable:
Location : query
Type : string
Description : Lists AutoProtectionPolicies for a given project and location.
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies
HTTP Method : GET
▼ ▲ backupdr.projects.locations.autoProtectionPolicies.patch
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}
Path : v1beta/{+name}
Parameters :
updateMask
Location : query
Type : string
Format : google-fieldmask
Description : Required. Field mask is used to specify the fields to be overwritten in the AutoProtectionPolicy 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 all fields will be overwritten.
name
Type : string
Required : Yes
Description : Identifier. The resource name of the AutoprotectionPolicy. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}`
Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$
Location : path
Description : Updates the parameters of a single AutoProtectionPolicy.
Scopes :
HTTP Method : PATCH
▼ ▲ backupdr.projects.locations.autoProtectionPolicies.create
Description : Creates a new AutoProtectionPolicy in a given project and location.
Path : v1beta/{+parent}/autoProtectionPolicies
Parameters :
parent
Description : Required. The parent resource where this policy will be created. Format: projects/{project}/locations/{location}
Type : string
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
autoProtectionPolicyId
Type : string
Description : Required. The ID to use for the policy. This will become the final component of the policy's resource name.
Location : query
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies
HTTP Method : POST
Parameter Order : parent
▼ ▲ backupdr.projects.locations.autoProtectionPolicies.get
Parameter Order : name
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$
Location : path
Type : string
Description : Required. The name of the policy to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}
Description : Gets details of a single AutoProtectionPolicy.
HTTP Method : GET
Scopes :
▼ ▲ backupdr.projects.locations.autoProtectionPolicies.delete
Description : Deletes a single AutoProtectionPolicy.
Path : v1beta/{+name}
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$
Required : Yes
Description : Required. The name of the policy to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}
Type : string
Location : path
etag
Location : query
Type : string
Description : The current etag of the AutoProtectionPolicy. If an etag is provided and does not match the current etag of the connection, the request will be rejected with an ABORTED error.
Parameter Order : name
HTTP Method : DELETE
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}
▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.initiateDelete
Path : v1beta/{+name}:initiateDelete
HTTP Method : POST
Description : InitiateDeleteAutoProtectionPolicyBinding initiates delete for AutoProtectionPolicy Binding
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}:initiateDelete
Parameters :
name
Description : Required. The name of the binding to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}
Required : Yes
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+$
Parameter Order : name
Scopes :
▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.list
Parameters :
orderBy
Type : string
Description : Optional. An expression that sorts the results in the response. The following fields are sortable:
Location : query
pageSize
Format : int32
Description : Optional. The maximum number of policies to return in a single page. If unspecified, a server-default value will be used.
Type : integer
Location : query
pageToken
Type : string
Location : query
Description : Optional. A page token, received from a previous `ListAutoProtectionPolicies` call. Provide this to retrieve the subsequent page.
filter
Type : string
Location : query
Description : Optional. A filter expression that filters resources listed in the response. The following fields are filterable:
parent
Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$
Description : Required. The project and location for which to retrieve the list of policies. Format: projects/{project}/locations/{location}
Required : Yes
Type : string
Location : path
Description : Returns the auto protection policy bindings read from the CCFE tables.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings
HTTP Method : GET
Scopes :
Parameter Order : parent
Path : v1beta/{+parent}/bindings
▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.create
Parameter Order : parent
Path : v1beta/{+parent}/bindings
HTTP Method : POST
Scopes :
Parameters :
autoProtectionPolicyBindingId
Description : Required. The ID to use for the binding. This will become the final component of the binding's resource name.
Type : string
Location : query
parent
Required : Yes
Type : string
Description : Required. The parent resource where this binding will be created. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}
Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+$
Location : path
Description : Creates a new AutoProtectionPolicyBinding in a given project and location.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings
▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.get
Scopes :
Path : v1beta/{+name}
Parameter Order : name
Parameters :
name
Description : Required. The name of the binding to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+$
Location : path
Description : Returns the auto protection policy binding read from the CCFE tables.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}
HTTP Method : GET
▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.matchingResources.get
HTTP Method : GET
Scopes :
Description : Gets details of a single Binding Matching Resource.
Path : v1beta/{+name}
Parameters :
name
Description : Required. The name of the matching resource to retrieve. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+/matchingResources/[^/]+$
Required : Yes
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}/matchingResources/{matchingResourcesId}
Parameter Order : name
▼ ▲ backupdr.projects.locations.autoProtectionPolicies.bindings.matchingResources.list
Description : Lists Binding Matching Resources for a given AutoProtectionPolicyBinding.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/autoProtectionPolicies/{autoProtectionPoliciesId}/bindings/{bindingsId}/matchingResources
Path : v1beta/{+parent}/matchingResources
Parameters :
orderBy
Type : string
Description : Optional. Field by which to sort the results.
Location : query
parent
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/autoProtectionPolicies/[^/]+/bindings/[^/]+$
Description : Required. The project, location, auto protection policy and binding for which to retrieve `BindingMatchingResources` information. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}`. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**.
Required : Yes
filter
Location : query
Description : Optional. Field match expression used to filter the results.
Type : string
pageToken
Type : string
Description : Optional. The value of next_page_token received from a previous `ListBindingMatchingResources` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBindingMatchingResources` must match the call that provided the page token.
Location : query
pageSize
Description : Optional. The maximum number of `BindingMatchingResources` to return in a single response. The default page size is 100 and maximum page size is 200. 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
Location : query
Parameter Order : parent
Scopes :
HTTP Method : GET
▼ ▲ backupdr.projects.locations.serviceConfig.initialize
Path : v1beta/{+name}:initialize
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/serviceConfig:initialize
Parameters :
name
Type : string
Location : path
Description : Required. The resource name of the serviceConfig used to initialize the service. The location must be the location of the BackupVault. Format: `projects/{project_id}/locations/{location}/serviceConfig`.
Pattern : ^projects/[^/]+/locations/[^/]+/serviceConfig$
Required : Yes
Scopes :
Description : Initializes the service related config for a project.
HTTP Method : POST
Parameter Order : name
▼ ▲ backupdr.projects.locations.managementServers.get
Scopes :
Parameter Order : name
Parameters :
name
Required : Yes
Description : Required. Name of the management server resource name, in the format 'projects/{project_id}/locations/{location}/managementServers/{resource_name}'
Pattern : ^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$
Type : string
Location : path
Description : Gets details of a single ManagementServer.
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}
HTTP Method : GET
▼ ▲ backupdr.projects.locations.managementServers.delete
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 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).
name
Required : Yes
Description : Required. Name of the resource
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}
Scopes :
Description : Deletes a single ManagementServer.
Path : v1beta/{+name}
HTTP Method : DELETE
Parameter Order : name
▼ ▲ backupdr.projects.locations.managementServers.getIamPolicy
Parameter Order : resource
Path : v1beta/{+resource}:getIamPolicy
HTTP Method : GET
Description : Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters :
resource
Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$
Type : string
options.requestedPolicyVersion
Format : int32
Location : query
Type : integer
Description : Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:getIamPolicy
▼ ▲ backupdr.projects.locations.managementServers.testIamPermissions
Scopes :
Parameters :
resource
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$
Type : string
Required : Yes
Description : Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Path : v1beta/{+resource}:testIamPermissions
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:testIamPermissions
HTTP Method : POST
Parameter Order : resource
▼ ▲ backupdr.projects.locations.managementServers.create
Parameter Order : parent
Path : v1beta/{+parent}/managementServers
HTTP Method : POST
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/managementServers
Description : Creates a new ManagementServer in a given project and location.
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 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).
Location : query
Type : string
managementServerId
Description : Required. The name of the management server to create. The name must be unique for the specified project and location.
Location : query
Type : string
parent
Location : path
Description : Required. The management server project and location in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR locations map to Google Cloud regions, for example **us-central1**.
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
▼ ▲ backupdr.projects.locations.managementServers.setIamPolicy
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$
Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Location : path
Required : Yes
Type : string
Path : v1beta/{+resource}:setIamPolicy
Scopes :
Parameter Order : resource
HTTP Method : POST
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:setIamPolicy
Description : Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
▼ ▲ backupdr.projects.locations.managementServers.list
Path : v1beta/{+parent}/managementServers
Scopes :
Parameter Order : parent
Description : Lists ManagementServers in a given project and location.
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/managementServers
Parameters :
filter
Description : Optional. Filtering results.
Location : query
Type : string
parent
Description : Required. The project and location for which to retrieve management servers information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve management servers for all locations, use "-" for the '{location}' value.
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
pageToken
Location : query
Type : string
Description : Optional. A token identifying a page of results the server should return.
pageSize
Format : int32
Type : integer
Location : query
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
orderBy
Type : string
Description : Optional. Hint for how to order the results.
Location : query
▼ ▲ backupdr.projects.locations.managementServers.msComplianceMetadata
Description : Returns the Assured Workloads compliance metadata for a given project.
HTTP Method : POST
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/managementServers:msComplianceMetadata
Parameter Order : parent
Scopes :
Parameters :
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/managementServers$
Type : string
Description : Required. The project and location to be used to check CSS metadata for target project information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**.
Required : Yes
Path : v1beta/{+parent}:msComplianceMetadata
▼ ▲ backupdr.projects.locations.operations.get
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameters :
name
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required : Yes
Description : The name of the operation resource.
Parameter Order : name
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Scopes :
HTTP Method : GET
▼ ▲ backupdr.projects.locations.operations.delete
Parameter Order : name
Parameters :
name
Location : path
Description : The name of the operation resource to be deleted.
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Required : Yes
Type : string
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : DELETE
Path : v1beta/{+name}
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Scopes :
▼ ▲ backupdr.projects.locations.operations.cancel
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Type : string
Description : The name of the operation resource to be cancelled.
Path : v1beta/{+name}:cancel
Scopes :
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
HTTP Method : POST
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
▼ ▲ backupdr.projects.locations.operations.list
Parameter Order : name
HTTP Method : GET
Path : v1beta/{+name}/operations
Parameters :
name
Type : string
Required : Yes
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
returnPartialSuccess
Type : boolean
Location : query
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
filter
Location : query
Type : string
Description : The standard list filter.
pageToken
Location : query
Type : string
Description : The standard list page token.
pageSize
Location : query
Description : The standard list page size.
Type : integer
Format : int32
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/operations
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Scopes :
▼ ▲ backupdr.projects.locations.backupPlanAssociations.fetchForResourceType
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations:fetchForResourceType
Path : v1beta/{+parent}/backupPlanAssociations:fetchForResourceType
Parameter Order : parent
Scopes :
Description : List BackupPlanAssociations for a given resource type.
Parameters :
parent
Description : Required. The parent resource name. Format: projects/{project}/locations/{location}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Type : string
orderBy
Location : query
Type : string
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * name
filter
Location : query
Description : Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * resource * backup_plan * state * data_source * cloud_sql_instance_backup_plan_association_properties.instance_create_time
Type : string
pageToken
Description : Optional. A page token, received from a previous call of `FetchBackupPlanAssociationsForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupPlanAssociationsForResourceType` must match the call that provided the page token.
Type : string
Location : query
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. The maximum number of BackupPlanAssociations to return. The service may return fewer than this value. If unspecified, at most 50 BackupPlanAssociations will be returned. The maximum value is 100; values above 100 will be coerced to 100.
resourceType
Type : string
Location : query
Description : Required. The type of the Google Cloud resource. Ex: sql.googleapis.com/Instance
▼ ▲ backupdr.projects.locations.backupPlanAssociations.delete
Description : Deletes a single BackupPlanAssociation.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}
HTTP Method : DELETE
Path : v1beta/{+name}
Parameter Order : name
Parameters :
name
Location : path
Description : Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$
autoProtectionPolicyBinding
Type : string
Description : Optional. This field is exclusively used by Backup and DR's auto-protection feature. The resource name of the `AutoProtectionPolicyBinding` that triggered the deletion of this association. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{policy}/bindings/{binding}`.
Location : query
requestId
Location : query
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 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).
Scopes :
▼ ▲ backupdr.projects.locations.backupPlanAssociations.create
Parameter Order : parent
Parameters :
backupPlanAssociationId
Location : query
Type : string
Description : Required. The name of the backup plan association to create. The name must be unique for the specified project and location.
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Required. The backup plan association project and location in the format `projects/{project_id}/locations/{location}`. In Backup and DR locations map to Google Cloud regions, for example **us-central1**.
Required : Yes
Type : string
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 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
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations
Path : v1beta/{+parent}/backupPlanAssociations
Scopes :
Description : Create a BackupPlanAssociation
HTTP Method : POST
▼ ▲ backupdr.projects.locations.backupPlanAssociations.get
Path : v1beta/{+name}
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}
HTTP Method : GET
Parameter Order : name
Description : Gets details of a single BackupPlanAssociation.
Scopes :
Parameters :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$
Description : Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`
Type : string
▼ ▲ backupdr.projects.locations.backupPlanAssociations.triggerBackup
HTTP Method : POST
Parameter Order : name
Scopes :
Path : v1beta/{+name}:triggerBackup
Parameters :
name
Description : Required. Name of the backup plan association resource, in the format `projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}`
Pattern : ^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$
Required : Yes
Location : path
Type : string
Description : Triggers a new Backup.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}:triggerBackup
▼ ▲ backupdr.projects.locations.backupPlanAssociations.patch
Path : v1beta/{+name}
Parameter Order : name
Parameters :
name
Type : string
Required : Yes
Description : Output only. Identifier. The resource name of BackupPlanAssociation in below format Format : projects/{project}/locations/{location}/backupPlanAssociations/{backupPlanAssociationId}
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/backupPlanAssociations/[^/]+$
updateMask
Type : string
Format : google-fieldmask
Description : Required. The list of fields to update. Field mask is used to specify the fields to be overwritten in the BackupPlanAssociation 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 backup_plan_association.backup_plan is the only supported field.
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 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).
Type : string
Location : query
Description : Update a BackupPlanAssociation.
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations/{backupPlanAssociationsId}
HTTP Method : PATCH
▼ ▲ backupdr.projects.locations.backupPlanAssociations.list
Path : v1beta/{+parent}/backupPlanAssociations
Parameter Order : parent
HTTP Method : GET
Description : Lists BackupPlanAssociations in a given project and location.
Scopes :
Parameters :
parent
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The project and location for which to retrieve backup Plan Associations information, in the format `projects/{project_id}/locations/{location}`. In Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backup plan associations for all locations, use "-" for the `{location}` value.
Location : path
pageToken
Location : query
Type : string
Description : Optional. A token identifying a page of results the server should return.
filter
Description : Optional. Filtering results
Location : query
Type : string
pageSize
Format : int32
Type : integer
Location : query
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlanAssociations
▼ ▲ backupdr.projects.locations.dataSourceReferences.get
HTTP Method : GET
Scopes :
Path : v1beta/{+name}
Description : Gets details of a single DataSourceReference.
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/dataSourceReferences/[^/]+$
Description : Required. The name of the DataSourceReference to retrieve. Format: projects/{project}/locations/{location}/dataSourceReferences/{data_source_reference}
Type : string
Required : Yes
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/dataSourceReferences/{dataSourceReferencesId}
Parameter Order : name
▼ ▲ backupdr.projects.locations.dataSourceReferences.fetchForResourceType
HTTP Method : GET
Scopes :
Description : Fetch DataSourceReferences for a given project, location and resource type.
Path : v1beta/{+parent}/dataSourceReferences:fetchForResourceType
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/dataSourceReferences:fetchForResourceType
Parameter Order : parent
Parameters :
filter
Type : string
Description : Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename * data_source_backup_config_state * data_source_backup_count * data_source_backup_config_info.last_backup_state * data_source_gcp_resource_info.gcp_resourcename * data_source_gcp_resource_info.type * data_source_gcp_resource_info.location * data_source_gcp_resource_info.cloud_sql_instance_properties.instance_create_time
Location : query
parent
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. The parent resource name. Format: projects/{project}/locations/{location}
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * name
Type : string
Location : query
pageSize
Location : query
Format : int32
Type : integer
Description : Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.
resourceType
Location : query
Description : Required. The type of the Google Cloud resource. Ex: sql.googleapis.com/Instance
Type : string
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous call of `FetchDataSourceReferencesForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchDataSourceReferencesForResourceType` must match the call that provided the page token.
▼ ▲ backupdr.projects.locations.dataSourceReferences.list
Path : v1beta/{+parent}/dataSourceReferences
Description : Lists DataSourceReferences for a given project and location.
HTTP Method : GET
Parameter Order : parent
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/dataSourceReferences
Parameters :
filter
Description : Optional. A filter expression that filters the results listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The following field and operator combinations are supported: * data_source_gcp_resource_info.gcp_resourcename with `=`, `!=` * data_source_gcp_resource_info.type with `=`, `!=`
Type : string
Location : query
parent
Description : Required. The parent resource name. Format: projects/{project}/locations/{location}
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Type : string
Required : Yes
orderBy
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * data_source * data_source_gcp_resource_info.gcp_resourcename
Location : query
Type : string
pageSize
Description : Optional. The maximum number of DataSourceReferences to return. The service may return fewer than this value. If unspecified, at most 50 DataSourceReferences will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Type : integer
Format : int32
Location : query
pageToken
Type : string
Location : query
Description : Optional. A page token, received from a previous `ListDataSourceReferences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataSourceReferences` must match the call that provided the page token.
▼ ▲ backupdr.projects.locations.backupVaults.patch
Path : v1beta/{+name}
Parameters :
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is 'false'.
Type : boolean
Location : query
forceUpdateAccessRestriction
Type : boolean
Location : query
Description : Optional. If set to true, we will force update access restriction even if some non compliant data sources are present. The default is 'false'.
requestId
Location : query
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 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).
name
Type : string
Description : Output only. Identifier. Name of the backup vault to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`. `{backupvault}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location.
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Location : path
updateMask
Description : Required. Field mask is used to specify the fields to be overwritten in the BackupVault 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.
Location : query
Format : google-fieldmask
Type : string
force
Location : query
Type : boolean
Description : Optional. If set to true, will not check plan duration against backup vault enforcement duration.
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}
HTTP Method : PATCH
Description : Updates the settings of a BackupVault.
Parameter Order : name
▼ ▲ backupdr.projects.locations.backupVaults.get
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Required : Yes
Location : path
Type : string
Description : Required. Name of the backupvault store resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}'
view
Location : query
Description : Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault
Enum :
Enum Descriptions :
Type : string
Path : v1beta/{+name}
Scopes :
Description : Gets details of a BackupVault.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}
Parameter Order : name
HTTP Method : GET
▼ ▲ backupdr.projects.locations.backupVaults.list
Parameters :
pageToken
Type : string
Location : query
Description : Optional. A token identifying a page of results the server should return.
orderBy
Type : string
Description : Optional. Hint for how to order the results.
Location : query
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location : query
Type : integer
Format : int32
view
Location : query
Description : Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault.
Enum :
Enum Descriptions :
Type : string
filter
Location : query
Description : Optional. Filtering results.
Type : string
parent
Required : Yes
Description : Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Lists BackupVaults in a given project and location.
HTTP Method : GET
Path : v1beta/{+parent}/backupVaults
Scopes :
Parameter Order : parent
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults
▼ ▲ backupdr.projects.locations.backupVaults.create
Description : Creates a new BackupVault in a given project and location.
HTTP Method : POST
Parameters :
backupVaultId
Description : Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC
Type : string
Location : query
parent
Required : Yes
Description : Required. Value for parent.
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
Location : path
validateOnly
Type : boolean
Location : query
Description : Optional. Only validate the request, but do not perform mutations. The default is 'false'.
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 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
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults
Parameter Order : parent
Scopes :
Path : v1beta/{+parent}/backupVaults
▼ ▲ backupdr.projects.locations.backupVaults.delete
Path : v1beta/{+name}
HTTP Method : DELETE
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}
Parameter Order : name
Scopes :
Parameters :
force
Type : boolean
Description : Optional. If set to true, any data source from this backup vault will also be deleted.
Location : query
allowMissing
Type : boolean
Description : Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.
Location : query
name
Location : path
Description : Required. Name of the resource.
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Required : Yes
Type : string
etag
Description : The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.
Location : query
Type : string
ignoreBackupPlanReferences
Type : boolean
Location : query
Description : Optional. If set to true, backupvault deletion will proceed even if there are backup plans referencing the backupvault. The default is 'false'.
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
validateOnly
Description : Optional. Only validate the request, but do not perform mutations. The default is 'false'.
Type : boolean
Location : query
Description : Deletes a BackupVault.
▼ ▲ backupdr.projects.locations.backupVaults.testIamPermissions
Description : Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request.
Scopes :
Path : v1beta/{+resource}:testIamPermissions
HTTP Method : POST
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}:testIamPermissions
Parameter Order : resource
Parameters :
resource
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Required : Yes
Location : path
Type : string
▼ ▲ backupdr.projects.locations.backupVaults.fetchUsable
Parameters :
pageToken
Type : string
Description : Optional. A token identifying a page of results the server should return.
Location : query
parent
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Description : Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
Required : Yes
orderBy
Type : string
Location : query
Description : Optional. Hint for how to order the results.
pageSize
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
Location : query
filter
Type : string
Description : Optional. Filtering results.
Location : query
Parameter Order : parent
Path : v1beta/{+parent}/backupVaults:fetchUsable
Description : FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults:fetchUsable
Scopes :
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.list
Description : Lists DataSources in a given project and location.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources
Parameter Order : parent
Scopes :
HTTP Method : GET
Path : v1beta/{+parent}/dataSources
Parameters :
pageSize
Location : query
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Format : int32
Type : integer
orderBy
Description : Optional. Hint for how to order the results.
Location : query
Type : string
filter
Location : query
Type : string
Description : Optional. Filtering results.
pageToken
Type : string
Description : Optional. A token identifying a page of results the server should return.
Location : query
parent
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Required : Yes
Type : string
Description : Required. The project and location for which to retrieve data sources information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location}' value.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.setInternalStatus
Description : Sets the internal status of a DataSource.
HTTP Method : POST
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:setInternalStatus
Path : v1beta/{+dataSource}:setInternalStatus
Parameter Order : dataSource
Parameters :
dataSource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Type : string
Required : Yes
Description : Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Scopes :
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.get
Parameters :
name
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Required : Yes
Description : Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}'
Location : path
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}
HTTP Method : GET
Path : v1beta/{+name}
Description : Gets details of a DataSource.
Parameter Order : name
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.fetchAccessToken
Description : Internal only. Fetch access token for a given data source.
HTTP Method : POST
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:fetchAccessToken
Parameters :
name
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location : path
Description : Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/*/locations/*/backupVaults/*/dataSources'.
Type : string
Required : Yes
Path : v1beta/{+name}:fetchAccessToken
Parameter Order : name
Scopes :
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.patch
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}
HTTP Method : PATCH
Description : Updates the settings of a DataSource.
Scopes :
Path : v1beta/{+name}
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 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
updateMask
Type : string
Location : query
Format : google-fieldmask
Description : Required. Field mask is used to specify the fields to be overwritten in the DataSource 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.
name
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Description : Output only. Identifier. Name of the datasource to create. It must have the format`"projects/{project}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}"`. `{datasource}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the backup vault.
Location : path
Type : string
Required : Yes
allowMissing
Description : Optional. Enable upsert.
Type : boolean
Location : query
Parameter Order : name
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.finalizeBackup
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:finalizeBackup
Parameters :
dataSource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Description : Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Type : string
Required : Yes
Parameter Order : dataSource
Path : v1beta/{+dataSource}:finalizeBackup
Scopes :
HTTP Method : POST
Description : Internal only. Finalize a backup that was started by a call to InitiateBackup.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.initiateBackup
Parameters :
dataSource
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Type : string
Description : Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Required : Yes
Path : v1beta/{+dataSource}:initiateBackup
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:initiateBackup
Parameter Order : dataSource
Description : Internal only. Initiates a backup.
HTTP Method : POST
Scopes :
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.abandonBackup
Parameters :
dataSource
Type : string
Location : path
Description : Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Required : Yes
Parameter Order : dataSource
Description : Internal only. Abandons a backup.
HTTP Method : POST
Path : v1beta/{+dataSource}:abandonBackup
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:abandonBackup
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.remove
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:remove
HTTP Method : POST
Description : Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances.
Scopes :
Parameters :
name
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Description : Required. Name of the resource.
Required : Yes
Path : v1beta/{+name}:remove
Parameter Order : name
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.patch
Path : v1beta/{+name}
Scopes :
Parameters :
updateMask
Type : string
Format : google-fieldmask
Location : query
Description : Required. Field mask is used to specify the fields to be overwritten in the Backup 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.
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
name
Required : Yes
Description : Output only. Identifier. Name of the backup to create. It must have the format`"projects//locations//backupVaults//dataSources/{datasource}/backups/{backup}"`. `{backup}` cannot be changed after creation. It must be between 3-63 characters long and must be unique within the datasource.
Type : string
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$
HTTP Method : PATCH
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}
Description : Updates the settings of a Backup.
Parameter Order : name
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.restore
HTTP Method : POST
Path : v1beta/{+name}:restore
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}:restore
Parameter Order : name
Parameters :
name
Type : string
Required : Yes
Description : Required. The resource name of the Backup instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'.
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$
Location : path
Description : Restore from a Backup
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.get
Path : v1beta/{+name}
HTTP Method : GET
Description : Gets details of a Backup.
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}
Scopes :
Parameter Order : name
Parameters :
name
Type : string
Description : Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}'
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$
view
Enum :
Description : Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.
Enum Descriptions :
Type : string
Location : query
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.fetchForResourceType
Parameter Order : parent
Description : Fetch Backups for a given resource type.
Parameters :
view
Enum :
Enum Descriptions :
Type : string
Description : Optional. This parameter is used to specify the view of the backup. If not specified, the default view is BASIC.
Location : query
resourceType
Location : query
Type : string
Description : Required. The type of the GCP resource. Ex: sqladmin.googleapis.com/Instance
orderBy
Location : query
Description : Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * name
Type : string
filter
Type : string
Location : query
Description : Optional. A filter expression that filters the results fetched in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. Supported fields: * name * state * backup_type * create_time * expire_time * enforced_retention_end_time * gcp_backup_plan_info.backup_plan * cloud_sql_instance_backup_properties.instance_tier * cloud_sql_instance_backup_properties.database_installed_version
pageToken
Type : string
Description : Optional. A page token, received from a previous call of `FetchBackupsForResourceType`. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `FetchBackupsForResourceType` must match the call that provided the page token.
Location : query
parent
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Description : Required. Datasources are the parent resource for the backups. Format: projects/{project}/locations/{location}/backupVaults/{backupVaultId}/dataSources/{datasourceId}
Required : Yes
pageSize
Location : query
Description : Optional. The maximum number of Backups to return. The service may return fewer than this value. If unspecified, at most 50 Backups will be returned. The maximum value is 100; values above 100 will be coerced to 100.
Format : int32
Type : integer
Scopes :
Path : v1beta/{+parent}/backups:fetchForResourceType
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups:fetchForResourceType
HTTP Method : GET
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.list
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups
Description : Lists Backups in a given project and location.
Path : v1beta/{+parent}/backups
Parameters :
view
Enum :
Description : Optional. Reserved for future use to provide a BASIC & FULL view of Backup resource.
Enum Descriptions :
Type : string
Location : query
pageToken
Description : Optional. A token identifying a page of results the server should return.
Type : string
Location : query
filter
Location : query
Type : string
Description : Optional. Filtering results.
parent
Location : path
Description : Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id}/locations/{location}'. In Google Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location}' value.
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Type : string
Required : Yes
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Format : int32
Location : query
Type : integer
orderBy
Type : string
Location : query
Description : Optional. Hint for how to order the results.
Parameter Order : parent
Scopes :
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.delete
Path : v1beta/{+name}
Parameter Order : name
Scopes :
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).
Type : string
Location : query
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$
Description : Required. Name of the resource.
Type : string
Required : Yes
HTTP Method : DELETE
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}
Description : Deletes a Backup.
▼ ▲ backupdr.projects.locations.resourceBackupConfigs.fetch
Parameters :
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.
Type : integer
Format : int32
Location : query
pageToken
Location : query
Type : string
Description : Optional. A token identifying a page of results the server should return.
filter
Description : Optional. Filtering results.
Type : string
Location : query
parent
Type : string
Location : path
Description : Required. The project, folder or organization and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}', 'folders/{folder_id}/locations/{location}', or 'organizations/{organization_id}/locations/{location}'.
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
orderBy
Location : query
Type : string
Description : Optional. Hint for how to order the results.
Description : Fetches ResourceBackupConfigs.
Path : v1beta/{+parent}/resourceBackupConfigs:fetch
Parameter Order : parent
HTTP Method : GET
Scopes :
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/resourceBackupConfigs:fetch
▼ ▲ backupdr.projects.locations.resourceBackupConfigs.list
Parameter Order : parent
Path : v1beta/{+parent}/resourceBackupConfigs
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/resourceBackupConfigs
HTTP Method : GET
Scopes :
Parameters :
pageToken
Type : string
Description : Optional. A token identifying a page of results the server should return.
Location : query
parent
Required : Yes
Description : Required. The project and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/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
orderBy
Description : Optional. Hint for how to order the results.
Location : query
Type : string
filter
Location : query
Description : Optional. Filtering results.
Type : string
pageSize
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.
Location : query
Format : int32
Type : integer
Description : Lists ResourceBackupConfigs.
▼ ▲ backupdr.projects.locations.backupPlans.list
Description : Lists BackupPlans in a given project and location.
Parameter Order : parent
HTTP Method : GET
Scopes :
Path : v1beta/{+parent}/backupPlans
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans
Parameters :
pageToken
Type : string
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
filter
Type : string
Description : Optional. Field match expression used to filter the results.
Location : query
parent
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Description : Required. The project and location for which to retrieve `BackupPlans` information. Format: `projects/{project}/locations/{location}`. In Google Cloud Backup and DR, locations map to Google Cloud regions, for e.g. **us-central1**. To retrieve backup plans for all locations, use "-" for the `{location}` value.
Required : Yes
Type : string
orderBy
Location : query
Type : string
Description : Optional. Field by which to sort the results.
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.
Format : int32
Location : query
Type : integer
▼ ▲ backupdr.projects.locations.backupPlans.create
Parameter Order : parent
Description : Create a BackupPlan
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 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).
backupPlanId
Description : Required. The name of the `BackupPlan` 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{,62}/.
Location : query
Type : string
parent
Location : path
Type : string
Required : Yes
Description : Required. The `BackupPlan` 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/[^/]+$
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans
Scopes :
Path : v1beta/{+parent}/backupPlans
HTTP Method : POST
▼ ▲ backupdr.projects.locations.backupPlans.delete
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}
HTTP Method : DELETE
Scopes :
Path : v1beta/{+name}
Parameter Order : name
Parameters :
name
Description : Required. The resource name of the `BackupPlan` to delete. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
Pattern : ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Location : path
Required : Yes
Type : string
requestId
Location : query
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 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).
Description : Deletes a single BackupPlan.
▼ ▲ backupdr.projects.locations.backupPlans.get
HTTP Method : GET
Parameter Order : name
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}
Path : v1beta/{+name}
Scopes :
Parameters :
name
Required : Yes
Description : Required. The resource name of the `BackupPlan` to retrieve. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
Pattern : ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Type : string
Location : path
Description : Gets details of a single BackupPlan.
▼ ▲ backupdr.projects.locations.backupPlans.patch
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}
HTTP Method : PATCH
Parameter Order : name
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 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).
Type : string
Location : query
updateMask
Location : query
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.
Format : google-fieldmask
Type : string
name
Pattern : ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Location : path
Description : Output only. Identifier. The resource name of the `BackupPlan`. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`
Required : Yes
Type : string
Description : Update a BackupPlan.
Scopes :
Path : v1beta/{+name}
▼ ▲ backupdr.projects.locations.backupPlans.revisions.get
Scopes :
HTTP Method : GET
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/revisions/{revisionsId}
Path : v1beta/{+name}
Description : Gets details of a single BackupPlanRevision.
Parameter Order : name
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
▼ ▲ backupdr.projects.locations.backupPlans.revisions.list
HTTP Method : GET
Description : Lists BackupPlanRevisions in a given project and location.
Parameters :
pageSize
Format : int32
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.
Type : integer
Location : query
pageToken
Type : string
Location : query
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.
parent
Location : path
Description : Required. The project and location for which to retrieve `BackupPlanRevisions` information. Format: `projects/{project}/locations/{location}/backupPlans/{backup_plan}`. In Google Cloud Backup and DR, locations map to Google Cloud regions, for e.g. **us-central1**.
Pattern : ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Type : string
Required : Yes
Path : v1beta/{+parent}/revisions
Scopes :
Parameter Order : parent
Flat Path : v1beta/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/revisions
▼ ▲ backupdr.folders.locations.resourceBackupConfigs.fetch
HTTP Method : GET
Flat Path : v1beta/folders/{foldersId}/locations/{locationsId}/resourceBackupConfigs:fetch
Description : Fetches ResourceBackupConfigs.
Parameter Order : parent
Parameters :
filter
Description : Optional. Filtering results.
Location : query
Type : string
pageToken
Location : query
Description : Optional. A token identifying a page of results the server should return.
Type : string
parent
Type : string
Required : Yes
Description : Required. The project, folder or organization and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}', 'folders/{folder_id}/locations/{location}', or 'organizations/{organization_id}/locations/{location}'.
Location : path
Pattern : ^folders/[^/]+/locations/[^/]+$
pageSize
Format : int32
Type : integer
Location : query
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.
orderBy
Location : query
Description : Optional. Hint for how to order the results.
Type : string
Path : v1beta/{+parent}/resourceBackupConfigs:fetch
Scopes :
▼ ▲ backupdr.organizations.locations.resourceBackupConfigs.fetch
Path : v1beta/{+parent}/resourceBackupConfigs:fetch
HTTP Method : GET
Flat Path : v1beta/organizations/{organizationsId}/locations/{locationsId}/resourceBackupConfigs:fetch
Parameter Order : parent
Description : Fetches ResourceBackupConfigs.
Parameters :
orderBy
Description : Optional. Hint for how to order the results.
Type : string
Location : query
pageSize
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will use 100 as default. Maximum value is 500 and values above 500 will be coerced to 500.
Location : query
Type : integer
pageToken
Location : query
Description : Optional. A token identifying a page of results the server should return.
Type : string
parent
Description : Required. The project, folder or organization and location for which to retrieve resource backup configs. Format: 'projects/{project_id}/locations/{location}', 'folders/{folder_id}/locations/{location}', or 'organizations/{organization_id}/locations/{location}'.
Location : path
Pattern : ^organizations/[^/]+/locations/[^/]+$
Type : string
Required : Yes
filter
Location : query
Type : string
Description : Optional. Filtering results.
Scopes :