Method: projects.locations.bareMetalClusters.get

Gets details of a single bare metal Cluster.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required. Name of the bare metal user cluster to get. Format: "projects/{project}/locations/{location}/bareMetalClusters/{bareMetalCluster}"

Query parameters


enum (ClusterView)

View for bare metal user cluster. When BASIC is specified, only the cluster resource name and admin cluster membership are returned. The default/unset value CLUSTER_VIEW_UNSPECIFIED is the same as `FULL', which returns the complete cluster configuration details.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:


For more information, see the Authentication Overview.


A view for bare metal user cluster resource.

CLUSTER_VIEW_UNSPECIFIED If the value is not set, the default FULL view is used.
BASIC Includes basic information of a cluster resource including cluster resource name and admin cluster membership.
FULL Includes the complete configuration for bare metal cluster resource. This is the default value for GetBareMetalClusterRequest method.