--- title: "PATCH /v1/{+name}" method: PATCH path: "/v1/{+name}" tags: ["projects"] --- # PATCH /v1/{+name} `PATCH /v1/{+name}` Updates the settings of a Backup. ## Path parameters - `name` string, required ## Query parameters - `requestId` string - `updateMask` string - `updateMask` string - `updateMask` string - `validateOnly` boolean ## Request body - Backup — Message describing a Backup object. - `filestoreInstanceBackupProperties` FilestoreInstanceBackupProperties — FilestoreInstanceBackupProperties represents the properties of a Filestore instance that are backed up by the datasource. . - `sourceInstance` string — Output only. The source instance of the backup. - `labels` object — Optional. Resource labels to represent user provided metadata. No labels currently defined. - `backupApplianceBackupProperties` BackupApplianceBackupProperties — BackupApplianceBackupProperties represents BackupDR backup appliance's properties. - `recoveryRangeStartTime` string, google-datetime — Optional. The earliest timestamp of data available in this Backup. - `recoveryRangeEndTime` string, google-datetime — Optional. The latest timestamp of data available in this Backup. - `generationId` integer — Output only. The numeric generation ID of the backup (monotonically increasing). - `finalizeTime` string, google-datetime — Output only. The time when this backup object was finalized (if none, backup is not finalized). - `updateTime` string, google-datetime — Output only. The time when the instance was updated. - `backupRetentionInheritance` 'BACKUP_RETENTION_INHERITANCE_UNSPECIFIED' | 'INHERIT_VAULT_RETENTION' | 'MATCH_BACKUP_EXPIRE_TIME' — Output only. Setting for how the enforced retention end time is inherited. This value is copied from this backup's BackupVault. - `alloyDbBackupProperties` AlloyDbClusterBackupProperties — AlloyDbClusterBackupProperties represents AlloyDB cluster backup properties. . - `chainId` string — Output only. The chain id of this backup. Backups belonging to the same chain are sharing the same chain id. This property is calculated and maintained by BackupDR. - `databaseVersion` string — Output only. The PostgreSQL major version of the AlloyDB cluster when the backup was taken. - `description` string — An optional text description for the backup. - `storedBytes` string, int64 — Output only. Storage usage of this particular backup - `createTime` string, google-datetime — Output only. The time when the instance was created. - `satisfiesPzs` boolean — Optional. Output only. Reserved for future use. - `expireTime` string, google-datetime — Optional. When this backup is automatically expired. - `serviceLocks` BackupLock[] — Output only. The list of BackupLocks taken by the service to prevent the deletion of the backup. - `backupApplianceLockInfo` BackupApplianceLockInfo — BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. - `backupApplianceName` string — Required. The name of the backup/recovery appliance that created this lock. - `backupImage` string — The image name that depends on this Backup. - `backupApplianceId` string, int64 — Required. The ID of the backup/recovery appliance that created this lock. - `lockReason` string — Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service. - `jobName` string — The job name on the backup/recovery appliance that created this lock. - `slaId` string, int64 — The SLA on the backup/recovery appliance that owns the lock. - `serviceLockInfo` ServiceLockInfo — ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. - `operation` string — Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes. - `lockUntilTime` string, google-datetime — Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion. - `diskBackupProperties` DiskBackupProperties — DiskBackupProperties represents the properties of a Disk backup. - `architecture` 'ARCHITECTURE_UNSPECIFIED' | 'X86_64' | 'ARM64' — The architecture of the source disk. Valid values are ARM64 or X86_64. - `physicalBlockSizeBytes` string, int64 — The physical block size of the source disk. - `guestFlush` boolean — Optional. Defines if the guest flush is enabled for the source disk. Default value is false. - `sizeGb` string, int64 — Size(in GB) of the source disk. - `replicaZones` string[] — The URL of the Zones where the source disk should be replicated. - `provisionedIops` string, int64 — The number of IOPS provisioned for the source disk. - `enableConfidentialCompute` boolean — Indicates whether the source disk is using confidential compute mode. - `sourceDisk` string — The source disk used to create this backup. - `licenses` string[] — A list of publicly available licenses that are applicable to this backup. This is applicable if the original image had licenses attached, e.g. Windows image. - `region` string — Region and zone are mutually exclusive fields. The URL of the region of the source disk. - `accessMode` string — The access mode of the source disk. - `description` string — A description of the source disk. - `labels` object — The labels of the source disk. - `storagePool` string — The storage pool of the source disk. - `provisionedThroughput` string, int64 — The number of throughput provisioned for the source disk. - `type` string — The URL of the type of the disk. - `zone` string — The URL of the Zone where the source disk. - `guestOsFeature` GuestOsFeature[] — A list of guest OS features that are applicable to this backup. - `type` 'FEATURE_TYPE_UNSPECIFIED' | 'VIRTIO_SCSI_MULTIQUEUE' | 'WINDOWS' | 'MULTI_IP_SUBNET' | 'UEFI_COMPATIBLE' | 'SECURE_BOOT' | 'GVNIC' | 'SEV_CAPABLE' | 'BARE_METAL_LINUX_COMPATIBLE' | 'SUSPEND_RESUME_COMPATIBLE' | 'SEV_LIVE_MIGRATABLE' | 'SEV_SNP_CAPABLE' | 'TDX_CAPABLE' | 'IDPF' | 'SEV_LIVE_MIGRATABLE_V2' — The ID of a supported feature. - `gcpResource` BackupGcpResource — Minimum details to identify a Google Cloud resource for a backup. - `gcpResourcename` string — Name of the Google Cloud resource. - `type` string — Type of the resource. Use the Unified Resource Type, eg. compute.googleapis.com/Instance. - `location` string — Location of the resource: //"global"/"unspecified". - `state` 'STATE_UNSPECIFIED' | 'CREATING' | 'ACTIVE' | 'DELETING' | 'ERROR' | 'UPLOADING' — Output only. The Backup resource instance state. - `satisfiesPzi` boolean — Optional. Output only. Reserved for future use. - `description` string — Output only. The description of the Backup instance (2048 characters or less). - `backupApplianceLocks` BackupLock[] — Optional. The list of BackupLocks taken by the accessor Backup Appliance. - `backupApplianceLockInfo` BackupApplianceLockInfo — BackupApplianceLockInfo contains metadata about the backupappliance that created the lock. - `backupApplianceName` string — Required. The name of the backup/recovery appliance that created this lock. - `backupImage` string — The image name that depends on this Backup. - `backupApplianceId` string, int64 — Required. The ID of the backup/recovery appliance that created this lock. - `lockReason` string — Required. The reason for the lock: e.g. MOUNT/RESTORE/BACKUP/etc. The value of this string is only meaningful to the client and it is not interpreted by the BackupVault service. - `jobName` string — The job name on the backup/recovery appliance that created this lock. - `slaId` string, int64 — The SLA on the backup/recovery appliance that owns the lock. - `serviceLockInfo` ServiceLockInfo — ServiceLockInfo represents the details of a lock taken by the service on a Backup resource. - `operation` string — Output only. The name of the operation that created this lock. The lock will automatically be released when the operation completes. - `lockUntilTime` string, google-datetime — Required. The time after which this lock is not considered valid and will no longer protect the Backup from deletion. - `name` string — 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. - `resourceSizeBytes` string, int64 — Output only. source resource size in bytes at the time of the backup. - `backupType` 'BACKUP_TYPE_UNSPECIFIED' | 'SCHEDULED' | 'ON_DEMAND' | 'ON_DEMAND_OPERATIONAL' — Output only. Type of the backup, unspecified, scheduled or ondemand. - `kmsKeyVersions` string[] — Optional. Output only. The list of KMS key versions used to encrypt the backup. - `consistencyTime` string, google-datetime — Output only. The point in time when this backup was captured from the source. - `cloudSqlInstanceBackupProperties` CloudSqlInstanceBackupProperties — CloudSqlInstanceBackupProperties represents Cloud SQL Instance Backup properties. - `sourceInstance` string — Output only. The source instance of the backup. Format: projects/{project}/instances/{instance} - `instanceCreateTime` string, google-datetime — Output only. The instance creation timestamp. - `instanceTier` string — Output only. The tier (or machine type) for this instance. Example: `db-custom-1-3840` - `databaseInstalledVersion` string — Output only. The installed database version of the Cloud SQL instance when the backup was taken. - `finalBackup` boolean — Output only. Whether the backup is a final backup. - `instanceDeleteTime` string, google-datetime — Output only. The instance delete timestamp. - `computeInstanceBackupProperties` ComputeInstanceBackupProperties — ComputeInstanceBackupProperties represents Compute Engine instance backup properties. - `guestAccelerator` AcceleratorConfig[] — A list of guest accelerator cards' type and count to use for instances created from these properties. - `acceleratorType` string — Optional. Full or partial URL of the accelerator type resource to attach to this instance. - `acceleratorCount` integer — Optional. The number of the guest accelerator cards exposed to this instance. - `scheduling` Scheduling — Sets the scheduling options for an Instance. - `preemptible` boolean — Optional. Defines whether the instance is preemptible. - `automaticRestart` boolean — Optional. Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). - `minNodeCpus` integer — Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. - `provisioningModel` 'PROVISIONING_MODEL_UNSPECIFIED' | 'STANDARD' | 'SPOT' — Optional. Specifies the provisioning model of the instance. - `localSsdRecoveryTimeout` SchedulingDuration — A SchedulingDuration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. - `nanos` integer — Optional. Span of time that's a fraction of a second at nanosecond resolution. - `seconds` string, int64 — Optional. Span of time at a resolution of a second. - `onHostMaintenance` 'ON_HOST_MAINTENANCE_UNSPECIFIED' | 'TERMINATE' | 'MIGRATE' — Optional. Defines the maintenance behavior for this instance. - `nodeAffinities` NodeAffinity[] — Optional. A set of node affinity and anti-affinity configurations. Overrides reservationAffinity. - `values` string[] — Optional. Corresponds to the label values of Node resource. - `key` string — Optional. Corresponds to the label key of Node resource. - `operator` 'OPERATOR_UNSPECIFIED' | 'IN' | 'NOT_IN' — Optional. Defines the operation of node selection. - `instanceTerminationAction` 'INSTANCE_TERMINATION_ACTION_UNSPECIFIED' | 'DELETE' | 'STOP' — Optional. Specifies the termination action for the instance. - `guestFlush` boolean — Optional. Indicates whether to perform a guest flush operation before taking a compute backup. When set to false, the system will create crash-consistent backups. Default value is false. - `metadata` Metadata — A metadata key/value entry. - `items` Entry[] — Optional. Array of key/value pairs. The total size of all keys and values must be less than 512 KB. - `key` string — Optional. Key for the metadata entry. - `value` string — Optional. Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). - `minCpuPlatform` string — Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as `minCpuPlatform: Intel Haswell` or `minCpuPlatform: Intel Sandy Bridge`. For more information, read https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. - `machineType` string — The machine type to use for instances that are created from these properties. - `description` string — An optional text description for the instances that are created from these properties. - `keyRevocationActionType` 'KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED' | 'NONE' | 'STOP' — KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. - `labels` object — Labels to apply to instances that are created from these properties. - `disk` AttachedDisk[] — An array of disks that are associated with the instances that are created from these properties. - `deviceName` string — Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs) - `diskTypeDeprecated` 'DISK_TYPE_UNSPECIFIED' | 'SCRATCH' | 'PERSISTENT' — Specifies the type of the disk. - `type` 'DISK_TYPE_UNSPECIFIED' | 'SCRATCH' | 'PERSISTENT' — Optional. Specifies the type of the disk. - `diskSizeGb` string, int64 — Optional. The size of the disk in GB. - `license` string[] — Optional. Any valid publicly visible licenses. - `diskInterface` 'DISK_INTERFACE_UNSPECIFIED' | 'SCSI' | 'NVME' | 'NVDIMM' | 'ISCSI' — Optional. Specifies the disk interface to use for attaching this disk. - `savedState` 'DISK_SAVED_STATE_UNSPECIFIED' | 'PRESERVED' — Optional. Output only. The state of the disk. - `guestOsFeature` GuestOsFeature[] — Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. - `type` 'FEATURE_TYPE_UNSPECIFIED' | 'VIRTIO_SCSI_MULTIQUEUE' | 'WINDOWS' | 'MULTI_IP_SUBNET' | 'UEFI_COMPATIBLE' | 'SECURE_BOOT' | 'GVNIC' | 'SEV_CAPABLE' | 'BARE_METAL_LINUX_COMPATIBLE' | 'SUSPEND_RESUME_COMPATIBLE' | 'SEV_LIVE_MIGRATABLE' | 'SEV_SNP_CAPABLE' | 'TDX_CAPABLE' | 'IDPF' | 'SEV_LIVE_MIGRATABLE_V2' — The ID of a supported feature. - `diskType` string — Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd - `autoDelete` boolean — Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). - `source` string — Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource. - `index` string, int64 — Optional. A zero-based index to this disk, where 0 is reserved for the boot disk. - `boot` boolean — Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. - `kind` string — Optional. Type of the resource. - `initializeParams` InitializeParams — Specifies the parameters to initialize this disk. - `diskName` string — Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. - `replicaZones` string[] — Optional. URL of the zone where the disk should be created. Required for each regional disk associated with the instance. - `mode` 'DISK_MODE_UNSPECIFIED' | 'READ_WRITE' | 'READ_ONLY' | 'LOCKED' — Optional. The mode in which to attach this disk. - `diskEncryptionKey` CustomerEncryptionKey — A customer-supplied encryption key. - `rsaEncryptedKey` string — Optional. RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. - `rawKey` string — Optional. Specifies a 256-bit customer-supplied encryption key. - `kmsKeyName` string — Optional. The name of the encryption key that is stored in Google Cloud KMS. - `kmsKeyServiceAccount` string — Optional. The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. - `networkInterface` NetworkInterface[] — An array of network access configurations for this interface. - `ipv6Address` string — Optional. An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance's zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance's subnetwork. - `name` string — Output only. [Output Only] The name of the network interface, which is generated by the server. - `ipv6AccessConfigs` AccessConfig[] — Optional. An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access. - `setPublicPtr` boolean — Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. - `networkTier` 'NETWORK_TIER_UNSPECIFIED' | 'PREMIUM' | 'STANDARD' — Optional. This signifies the networking tier used for configuring this access - `type` 'ACCESS_TYPE_UNSPECIFIED' | 'ONE_TO_ONE_NAT' | 'DIRECT_IPV6' — Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6. - `name` string — Optional. The name of this access configuration. - `natIP` string — Optional. The external IP address of this access configuration. - `publicPtrDomainName` string — Optional. The DNS domain name for the public PTR record. - `externalIpv6` string — Optional. The external IPv6 address of this access configuration. - `externalIpv6PrefixLength` integer — Optional. The prefix length of the external IPv6 range. - `ipv6AccessType` 'UNSPECIFIED_IPV6_ACCESS_TYPE' | 'INTERNAL' | 'EXTERNAL' — Optional. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. - `networkAttachment` string — Optional. The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}. - `networkIP` string — Optional. An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. - `stackType` 'STACK_TYPE_UNSPECIFIED' | 'IPV4_ONLY' | 'IPV4_IPV6' — The stack type for this network interface. - `internalIpv6PrefixLength` integer — Optional. The prefix length of the primary internal IPv6 range. - `network` string — Optional. URL of the VPC network resource for this instance. - `nicType` 'NIC_TYPE_UNSPECIFIED' | 'VIRTIO_NET' | 'GVNIC' — Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet. - `subnetwork` string — Optional. The URL of the Subnetwork resource for this instance. - `accessConfigs` AccessConfig[] — Optional. An array of configurations for this interface. Currently, only one access config,ONE_TO_ONE_NAT is supported. If there are no accessConfigs specified, then this instance will have no external internet access. - `setPublicPtr` boolean — Optional. Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name. - `networkTier` 'NETWORK_TIER_UNSPECIFIED' | 'PREMIUM' | 'STANDARD' — Optional. This signifies the networking tier used for configuring this access - `type` 'ACCESS_TYPE_UNSPECIFIED' | 'ONE_TO_ONE_NAT' | 'DIRECT_IPV6' — Optional. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6. - `name` string — Optional. The name of this access configuration. - `natIP` string — Optional. The external IP address of this access configuration. - `publicPtrDomainName` string — Optional. The DNS domain name for the public PTR record. - `externalIpv6` string — Optional. The external IPv6 address of this access configuration. - `externalIpv6PrefixLength` integer — Optional. The prefix length of the external IPv6 range. - `queueCount` integer — Optional. The networking queue count that's specified by users for the network interface. Both Rx and Tx queues will be set to this number. It'll be empty if not specified by the users. - `aliasIpRanges` AliasIpRange[] — Optional. An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks. - `subnetworkRangeName` string — Optional. The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used. - `ipCidrRange` string — Optional. The IP alias ranges to allocate for this interface. - `sourceInstance` string — The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance - `serviceAccount` ServiceAccount[] — A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances. - `email` string — Optional. Email address of the service account. - `scopes` string[] — Optional. The list of scopes to be made available for this service account. - `tags` Tags — A set of instance tags. - `items` string[] — Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. - `canIpForward` boolean — Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify `true`. If unsure, leave this set to `false`. See the https://cloud.google.com/vpc/docs/using-routes#canipforward documentation for more information. - `etag` string — Optional. Server specified ETag to prevent updates from overwriting each other. - `gcpBackupPlanInfo` GCPBackupPlanInfo — GCPBackupPlanInfo captures the plan configuration details of Google Cloud resources at the time of backup. - `backupPlanRevisionName` string — Resource name of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId}/revisions/{revisionId} - `backupPlan` string — Resource name of backup plan by which workload is protected at the time of the backup. Format: projects/{project}/locations/{location}/backupPlans/{backupPlanId} - `backupPlanRuleId` string — The rule id of the backup plan which triggered this backup in case of scheduled backup or used for - `backupPlanRevisionId` string — The user friendly id of the backup plan revision which triggered this backup in case of scheduled backup or used for on demand backup. - `enforcedRetentionEndTime` string, google-datetime — Optional. The backup can not be deleted before this time. ## Response `200` Successful response --- [API](https://skmtc.dev/google/apis/backupdr.md) · [All operations](https://skmtc.dev/google/apis/backupdr/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/backupdr/revisions/b432f73f0b98/schema)