Method: projects.locations.bareMetalClusters.delete

Deletes a single bare metal Cluster.

HTTP request

DELETE https://gkeonprem.googleapis.com/v1/{name=projects/*/locations/*/bareMetalClusters/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

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

Query parameters

Parameters
etag

string

The current etag of the bare metal Cluster. If an etag is provided and does not match the current etag of the cluster, deletion will be blocked and an ABORTED error will be returned.

allowMissing

boolean

If set to true, and the bare metal cluster is not found, the request will succeed but no action will be taken on the server and return a completed LRO.

validateOnly

boolean

Validate the request without actually doing any updates.

force

boolean

If set to true, any node pools from the cluster will also be deleted.

ignoreErrors

boolean

If set to true, the deletion of a bare metal user cluster resource will succeed even if errors occur during deletion.

This parameter can be used when you want to delete GCP's cluster resource and the on-prem admin cluster that hosts your user cluster is disconnected / unreachable or deleted.

WARNING: Using this parameter when your user cluster still exists may result in a deleted GCP user cluster but an existing on-prem user cluster.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.