Method: projects.locations.queues.purge

Purges a queue by deleting all of its tasks.

All tasks created before this method is called are permanently deleted.

Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible.

HTTP request

POST https://cloudtasks.googleapis.com/v2beta3/{name=projects/*/locations/*/queues/*}:purge

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

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

  • cloudtasks.queues.purge

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.