Skip to content

Cloud Tasks API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Manages the execution of large numbers of distributed requests.

Cloud Tasks API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 16 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://cloudtasks.googleapis.com/
Version
v2beta3
Endpoints
16
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://cloudtasks.googleapis.com/v2beta3/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://cloudtasks.googleapis.com/v2beta3/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://cloudtasks.googleapis.com/v2beta3/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v2beta3/{name}Gets a task.
PATCH/v2beta3/{name}Updates 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 live
DELETE/v2beta3/{name}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.
GET/v2beta3/{name}/locationsLists information about the supported locations for this service.
POST/v2beta3/{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 the
POST/v2beta3/{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 minute
POST/v2beta3/{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 method
POST/v2beta3/{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 RateLim
GET/v2beta3/{parent}/queuesLists queues. Queues are returned in lexicographical order.
POST/v2beta3/{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 regardless
GET/v2beta3/{parent}/tasksLists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information whi
POST/v2beta3/{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.
POST/v2beta3/{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 t
POST/v2beta3/{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 following
POST/v2beta3/{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. Project-level
POST/v2beta3/{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: Thi

Questions

Does the Cloud Tasks API API need an API key?

Yes. The Cloud Tasks API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Cloud Tasks API API support HTTPS?

Yes, the Cloud Tasks API API is served over HTTPS.

How many endpoints does the Cloud Tasks API API have?

Its OpenAPI description lists 16 endpoints in version v2beta3. All of them are shown on this page.

What are alternatives to the Cloud Tasks API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).