API Reference

This API reference is organized by resource type. Each resource type has one or more data representations and one or more methods.

Alpha, new version and documentation available

A new v2 version of the Task Queue REST API is now available. Although Google will continue to support the older v1 version until the end of 2017, we recommend that you use the new v2 version, which is renamed to Cloud Tasks API. Cloud Tasks will be the new name for Task Queue. The v2 version is still in alpha. To use the new v2 version, apply to be whitelisted for the Cloud Tasks API. There are some differences, such as URL changes: see the v1 to v2 migration documentation for details. After you are whitelisted, you can use the new Cloud Tasks API documentation.

Resource types

1. Taskqueues
2. Tasks

Taskqueues

For Taskqueues Resource details, see the resource representation page.

Method	HTTP request	Description
URIs relative to https://www.googleapis.com/taskqueue/v1beta2/projects, unless otherwise noted
get	GET  /project/taskqueues/taskqueue	Get detailed information about a TaskQueue.

Tasks

For Tasks Resource details, see the resource representation page.

Method	HTTP request	Description
URIs relative to https://www.googleapis.com/taskqueue/v1beta2/projects, unless otherwise noted
delete	DELETE  /project/taskqueues/taskqueue/tasks/task	Deletes a task from a TaskQueue.
get	GET  /project/taskqueues/taskqueue/tasks/task	Gets the named task in a TaskQueue.
insert	POST  /project/taskqueues/taskqueue/tasks	Insert a task into an existing queue.
lease	POST  /project/taskqueues/taskqueue/tasks/lease	Acquires a lease on the topmost N unowned tasks in the specified queue. Required query parameters: leaseSecs, numTasks
list	GET  /project/taskqueues/taskqueue/tasks	Lists all non-deleted Tasks in a TaskQueue, whether or not they are currently leased, up to a maximum of 100.
patch	PATCH  /project/taskqueues/taskqueue/tasks/task	Update tasks that are leased out of a TaskQueue. Required query parameters: newLeaseSeconds
update	POST  /project/taskqueues/taskqueue/tasks/task	Update the duration of a task lease. Required query parameters: newLeaseSeconds