Cloud Tasks API
Manages the execution of large numbers of distributed requests.
Developer tools#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Manages the execution of large numbers of distributed requests.
Endpoints 18
projects.locations.queues.tasks
- GETGets a task
/v2/:name?responseView=VIEW_UNSPECIFIEDGets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A GetTask request for a deleted task returns a… - DELETEDeletes a task
/v2/:nameDeletes 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. - POSTCreates a batch of tasks and adds them to a queue
/v2/:parent/tasks:batchCreateCreates a batch of tasks and adds them to a queue. All tasks must be for the same queue. A maximum of 100 tasks can be created in a single batch. - POSTDeletes a batch of tasks
/v2/:parent/tasks:batchDeleteDeletes a batch of tasks. This is a non-atomic operation: if deletion fails for some tasks, it can still succeed for others. The metadata field of… - POSTCreates and buffers a new task without the need to explicitly define a Task message
/v2/:queue/tasks/:taskId:bufferCreates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use… - GETLists the tasks in a queue
/v2/:parent/tasks?pageSize=0&pageToken=string&responseView=VIEW_UNSPECIFIEDLists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information… - POSTCreates a task and adds it to a queue
/v2/:parent/tasksCreates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * The maximum task size is 100KB. - POSTForces a task to run now
/v2/:name:runForces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its…
projects.locations.queues
- PATCHUpdates a queue
/v2/:name?updateMask=stringUpdates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to… - GETLists queues
/v2/:parent/queues?filter=string&pageSize=0&pageToken=stringLists queues. Queues are returned in lexicographical order. - POSTCreates a queue
/v2/:parent/queuesCreates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted… - POSTGets the access control policy for a Queue
/v2/:resource:getIamPolicyGets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set. Authorization requires the… - POSTPauses the queue
/v2/:name:pausePauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when… - POSTPurges a queue by deleting all of its tasks
/v2/:name:purgePurges 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… - POSTResume a queue
/v2/:name:resumeResume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this… - POSTSets the access control policy for a Queue
/v2/:resource:setIamPolicySets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet.… - POSTReturns permissions that a caller has on a Queue
/v2/:resource:testIamPermissionsReturns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note:…
projects.locations
- GETLists information about the supported locations for this service
/v2/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…
API details
- Base URL
https://cloudtasks.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 18 operations on 14 pathsPOST 12GET 4PATCH 1DELETE 1
- Main resources
- projects.locations.queues 9projects.locations.queues.tasks 8projects.locations 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v2 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud Tasks API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloud Tasks API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets a task” (GET /v2/:name?responseView=VIEW_UNSPECIFIED), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud Tasks API?
Manages the execution of large numbers of distributed requests. It is listed under Developer tools and has 18 endpoints.
Who publishes the Cloud Tasks API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloud Tasks API?
Requests go to https://cloudtasks.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud Tasks API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Cloud Tasks API have?
18 operations on 14 paths (12 POST, 4 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.queues, projects.locations.queues.tasks, projects.locations.
Is forking the Cloud Tasks API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.