Method: projects.locations.backupVaults.list

Lists BackupVaults in a given project and location.

HTTP request

GET https://backupdr.googleapis.com/v1/{parent=projects/*/locations/*}/backupVaults

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{projectId}/locations/{location}'. In 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.

Query parameters

Parameters
pageSize

integer

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken

string

Optional. A token identifying a page of results the server should return.
filter

string

Optional. Filtering results.
orderBy

string

Optional. Hint for how to order the results.
view

enum (BackupVaultView)

Optional. Reserved for future use to provide a BASIC & FULL view of Backup Vault.

Request body

The request body must be empty.

Response body

Response message for listing BackupVaults.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "backupVaults": [
    {
      object (BackupVault)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Fields
backupVaults[]

object (BackupVault)

The list of BackupVault instances in the project for the specified location.

If the '{location}' value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return backup vaults in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.
nextPageToken

string

A token identifying a page of results the server should return.
unreachable[]

string

Locations that could not be reached.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • backupdr.backupVaults.list

For more information, see the IAM documentation.