Sign in

v1

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

Creates a new BackupVault in a given project and location.

post/v1/{+parent}/backupVaults

Path parameters

parentstring required

Required. Value for parent.

Query parameters

backupVaultIdstring

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

requestIdstring

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).

validateOnlyboolean

Optional. Only validate the request, but do not perform mutations. The default is 'false'.

Request body

createTimestring google-datetime

Output only. The time when the instance was created.

effectiveTimestring google-datetime

Optional. Time after which the BackupVault resource is locked.

uidstring

Output only. Immutable after resource creation until resource deletion.

totalStoredBytesstring int64

Output only. Total size of the storage used by all backup resources.

serviceAccountstring

Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there.

namestring

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.

backupRetentionInheritance'BACKUP_RETENTION_INHERITANCE_UNSPECIFIED' | 'INHERIT_VAULT_RETENTION' | 'MATCH_BACKUP_EXPIRE_TIME'

Optional. Setting for how a backup's enforced retention end time is inherited.

updateTimestring google-datetime

Output only. The time when the instance was updated.

deletableboolean

Output only. Set to true when there are no backups nested under this resource.

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

Output only. The BackupVault resource instance state.

descriptionstring

Optional. The description of the BackupVault instance (2048 characters or less).

labelsobject

Optional. Resource labels to represent user provided metadata. No labels currently defined:

accessRestriction'ACCESS_RESTRICTION_UNSPECIFIED' | 'WITHIN_PROJECT' | 'WITHIN_ORGANIZATION' | 'UNRESTRICTED' | 'WITHIN_ORG_BUT_UNRESTRICTED_FOR_BA'

Optional. Note: This field is added for future use case and will not be supported in the current release. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation.

etagstring

Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other.

backupCountstring int64

Output only. The number of backups in this backup vault.

backupMinimumEnforcedRetentionDurationstring google-duration

Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Note: Longer minimum enforced retention period impacts potential storage costs post introductory trial. We recommend starting with a short duration of 3 days or less.

annotationsobject

Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data.

Response

Successful response