Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-134680139.0 KB
projects

Creates new backup vault

post/v1/{+parent}/backupVaults

Path parameters

parentstring required

Required. The location to create the backup vaults, in the format projects/{project_id}/locations/{location}

Query parameters

backupVaultIdstring

Required. The ID to use for the backupVault. The ID must be unique within the specified location. Must contain only letters, numbers and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum.

Request body

backupRegionstring

Optional. Region where the backups are stored. Format: projects/{project_id}/locations/{location}

state'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'DELETING' | 'ERROR' | 'UPDATING'

Output only. The backup vault state.

backupsCryptoKeyVersionstring

Output only. The crypto key version used to encrypt the backup vault. Format: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}

backupVaultType'BACKUP_VAULT_TYPE_UNSPECIFIED' | 'IN_REGION' | 'CROSS_REGION'

Optional. Type of backup vault to be created. Default is IN_REGION.

createTimestring google-datetime

Output only. Create time of the backup vault.

kmsConfigstring

Optional. Specifies the Key Management System (KMS) configuration to be used for backup encryption. Format: projects/{project}/locations/{location}/kmsConfigs/{kms_config}

descriptionstring

Description of the backup vault.

sourceRegionstring

Output only. Region in which the backup vault is created. Format: projects/{project_id}/locations/{location}

namestring

Identifier. The resource name of the backup vault. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}.

sourceBackupVaultstring

Output only. Name of the Backup vault created in source region. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

destinationBackupVaultstring

Output only. Name of the Backup vault created in backup region. Format: projects/{project_id}/locations/{location}/backupVaults/{backup_vault_id}

encryptionState'ENCRYPTION_STATE_UNSPECIFIED' | 'ENCRYPTION_STATE_PENDING' | 'ENCRYPTION_STATE_COMPLETED' | 'ENCRYPTION_STATE_IN_PROGRESS' | 'ENCRYPTION_STATE_FAILED'

Output only. Field indicating encryption state of CMEK backups.

labelsobject

Resource labels to represent user provided metadata.

Response

Successful response