Method: projects.locations.workerPools.delete

Deletes a WorkerPool.

HTTP request

DELETE https://cloudbuild.googleapis.com/v1/{name=projects/*/locations/*/workerPools/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the WorkerPool to delete. Format: projects/{project}/locations/{workerPool}/workerPools/{workerPool}.

Authorization requires the following IAM permission on the specified resource name:

  • cloudbuild.workerpools.delete

Query parameters

Parameters
etag

string

Optional. If this is provided, it must match the server's etag on the workerpool for the request to be processed.

allowMissing

boolean

If set to true, and the WorkerPool is not found, the request will succeed but no action will be taken on the server.

validateOnly

boolean

If set, validate the request and preview the response, but do not actually post it.

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.