Method: projects.locations.bareMetalClusters.patch

Updates the parameters of a single bare metal Cluster.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Immutable. The bare metal user cluster resource name.

Query parameters


string (FieldMask format)

Required. Field mask is used to specify the fields to be overwritten in the BareMetalCluster resource by the update.

The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

If the user does not provide a mask then all populated fields in the BareMetalCluster message will be updated. Empty fields will be ignored unless a field mask is used.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".



If set to true, and the bare metal cluster is not found, the request will create a new bare metal cluster with the provided configuration. The user must have both create and update permission to call Update with allowMissing set to true.



Validate the request without actually doing any updates.

Request body

The request body contains an instance of BareMetalCluster.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.