Method: projects.locations.queues.tasks.delete

Deletes a task.

A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed.

HTTP request

DELETE https://cloudtasks.googleapis.com/v2/{name=projects/*/locations/*/queues/*/tasks/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

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

  • cloudtasks.tasks.delete

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

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.