Method: projects.locations.workstationClusters.delete

Deletes the specified workstation cluster.

HTTP request

DELETE https://workstations.googleapis.com/v1/{name=projects/*/locations/*/workstationClusters/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Name of the workstation cluster to delete.

Query parameters

Parameters
validateOnly

boolean

Optional. If set, validate the request and preview the review, but do not apply it.
etag

string

Optional. If set, the request will be rejected if the latest version of the workstation cluster on the server does not have this ETag.
force

boolean

Optional. If set, any workstation configurations and workstations in the workstation cluster are also deleted. Otherwise, the request only works if the workstation cluster has no configurations or workstations.

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.