2025-04-03
▼ ▲ gkebackup.projects.locations.backupChannels.create
Path : v1/{+parent}/backupChannels
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/backupChannels
HTTP Method : POST
Parameters :
parent
Description : Required. The location within which to create the BackupChannel. Format: `projects/*/locations/*`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
backupChannelId
Description : Optional. The client-provided short name for the BackupChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of BackupChannels in this location If the user does not provide a name, a uuid will be used as the name.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new BackupChannel in a given location.
▼ ▲ gkebackup.projects.locations.backupChannels.list
Path : v1/{+parent}/backupChannels
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/backupChannels
HTTP Method : GET
Parameters :
parent
Description : Required. The location that contains the BackupChannels to list. Format: `projects/*/locations/*`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The value of next_page_token received from a previous `ListBackupChannels` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupChannels` must match the call that provided the page token.
Location : query
Type : string
filter
Description : Optional. Field match expression used to filter the results.
Location : query
Type : string
orderBy
Description : Optional. Field by which to sort the results.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists BackupChannels in a given location.
▼ ▲ gkebackup.projects.locations.backupChannels.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}
HTTP Method : GET
Parameters :
name
Description : Required. Fully qualified BackupChannel name. Format: `projects/*/locations/*/backupChannels/*`
Pattern : ^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieve the details of a single BackupChannel.
▼ ▲ gkebackup.projects.locations.backupChannels.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The fully qualified name of the BackupChannel. `projects/*/locations/*/backupChannels/*`
Pattern : ^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. This is used to specify the fields to be overwritten in the BackupChannel targeted for update. The values for each of these updated fields will be taken from the `backup_channel` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `labels`, etc.) If no `update_mask` is provided, all fields in `backup_channel` will be written to the target BackupChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_channel` are ignored and are not used to update the target BackupChannel.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a BackupChannel.
▼ ▲ gkebackup.projects.locations.backupChannels.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Fully qualified BackupChannel name. Format: `projects/*/locations/*/backupChannels/*`
Pattern : ^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. If provided, this value must match the current value of the target BackupChannel's etag field or the request is rejected.
Location : query
Type : string
force
Description : Optional. If set to true, any BackupPlanAssociations below this BackupChannel will also be deleted. Otherwise, the request will only succeed if the BackupChannel has no BackupPlanAssociations.
Location : query
Type : boolean
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an existing BackupChannel.
▼ ▲ gkebackup.projects.locations.backupChannels.backupPlanBindings.list
Path : v1/{+parent}/backupPlanBindings
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}/backupPlanBindings
HTTP Method : GET
Parameters :
parent
Description : Required. The BackupChannel that contains the BackupPlanBindings to list. Format: `projects/*/locations/*/backupChannels/*`
Pattern : ^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The value of next_page_token received from a previous `ListBackupPlanBindings` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListBackupPlanBindings` must match the call that provided the page token.
Location : query
Type : string
filter
Description : Optional. Field match expression used to filter the results.
Location : query
Type : string
orderBy
Description : Optional. Field by which to sort the results.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists BackupPlanBindings in a given location.
▼ ▲ gkebackup.projects.locations.backupChannels.backupPlanBindings.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/backupChannels/{backupChannelsId}/backupPlanBindings/{backupPlanBindingsId}
HTTP Method : GET
Parameters :
name
Description : Required. Fully qualified BackupPlanBinding name. Format: `projects/*/locations/*/backupChannels/*/backupPlanBindings/*`
Pattern : ^projects/[^/]+/locations/[^/]+/backupChannels/[^/]+/backupPlanBindings/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieve the details of a single BackupPlanBinding.
▼ ▲ gkebackup.projects.locations.restoreChannels.create
Path : v1/{+parent}/restoreChannels
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreChannels
HTTP Method : POST
Parameters :
parent
Description : Required. The location within which to create the RestoreChannel. Format: `projects/*/locations/*`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
restoreChannelId
Description : Optional. The client-provided short name for the RestoreChannel resource. This name must: - be between 1 and 63 characters long (inclusive) - consist of only lower-case ASCII letters, numbers, and dashes - start with a lower-case letter - end with a lower-case letter or number - be unique within the set of RestoreChannels in this location If the user does not provide a name, a uuid will be used as the name.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Creates a new RestoreChannel in a given location.
▼ ▲ gkebackup.projects.locations.restoreChannels.list
Path : v1/{+parent}/restoreChannels
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreChannels
HTTP Method : GET
Parameters :
parent
Description : Required. The location that contains the RestoreChannels to list. Format: `projects/*/locations/*`
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The value of next_page_token received from a previous `ListRestoreChannels` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestoreChannels` must match the call that provided the page token.
Location : query
Type : string
filter
Description : Optional. Field match expression used to filter the results.
Location : query
Type : string
orderBy
Description : Optional. Field by which to sort the results.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists RestoreChannels in a given location.
▼ ▲ gkebackup.projects.locations.restoreChannels.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}
HTTP Method : GET
Parameters :
name
Description : Required. Fully qualified RestoreChannel name. Format: `projects/*/locations/*/restoreChannels/*`
Pattern : ^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieve the details of a single RestoreChannel.
▼ ▲ gkebackup.projects.locations.restoreChannels.patch
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}
HTTP Method : PATCH
Parameters :
name
Description : Identifier. The fully qualified name of the RestoreChannel. `projects/*/locations/*/restoreChannels/*`
Pattern : ^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$
Location : path
Required : Yes
Type : string
updateMask
Description : Optional. This is used to specify the fields to be overwritten in the RestoreChannel targeted for update. The values for each of these updated fields will be taken from the `restore_channel` provided with this request. Field names are relative to the root of the resource (e.g., `description`, `destination_project_id`, etc.) If no `update_mask` is provided, all fields in `restore_channel` will be written to the target RestoreChannel resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_channel` are ignored and are not used to update the target RestoreChannel.
Location : query
Type : string
Format : google-fieldmask
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Update a RestoreChannel.
▼ ▲ gkebackup.projects.locations.restoreChannels.delete
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}
HTTP Method : DELETE
Parameters :
name
Description : Required. Fully qualified RestoreChannel name. Format: `projects/*/locations/*/restoreChannels/*`
Pattern : ^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$
Location : path
Required : Yes
Type : string
etag
Description : Optional. If provided, this value must match the current value of the target RestoreChannel's etag field or the request is rejected.
Location : query
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Deletes an existing RestoreChannel.
▼ ▲ gkebackup.projects.locations.restoreChannels.restorePlanBindings.list
Path : v1/{+parent}/restorePlanBindings
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}/restorePlanBindings
HTTP Method : GET
Parameters :
parent
Description : Required. The RestoreChannel that contains the ListRestorePlanBindings to list. Format: `projects/*/locations/*/restoreChannels/*`
Pattern : ^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+$
Location : path
Required : Yes
Type : string
pageSize
Description : Optional. The target number of results to return in a single response. If not specified, a default value will be chosen by the service. Note that the response may include a partial list and a caller should only rely on the response's next_page_token to determine if there are more instances left to be queried.
Location : query
Type : integer
Format : int32
pageToken
Description : Optional. The value of next_page_token received from a previous `ListRestorePlanBindings` call. Provide this to retrieve the subsequent page in a multi-page list of results. When paginating, all other parameters provided to `ListRestorePlanBindings` must match the call that provided the page token.
Location : query
Type : string
filter
Description : Optional. Field match expression used to filter the results.
Location : query
Type : string
orderBy
Description : Optional. Field by which to sort the results.
Location : query
Type : string
Parameter Order : parent
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Lists RestorePlanBindings in a given location.
▼ ▲ gkebackup.projects.locations.restoreChannels.restorePlanBindings.get
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/restoreChannels/{restoreChannelsId}/restorePlanBindings/{restorePlanBindingsId}
HTTP Method : GET
Parameters :
name
Description : Required. Fully qualified RestorePlanBinding name. Format: `projects/*/locations/*/restoreChannels/*/restorePlanBindings/*`
Pattern : ^projects/[^/]+/locations/[^/]+/restoreChannels/[^/]+/restorePlanBindings/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Scopes : https://www.googleapis.com/auth/cloud-platform
Description : Retrieve the details of a single RestorePlanBinding.