Skip to content

Cloud Pub/Sub API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

Provides reliable, many-to-many, asynchronous messaging between applications.

Cloud Pub/Sub 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://pubsub.googleapis.com/
Version
v1beta2
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://pubsub.googleapis.com/v1beta2/PROJECT/subscriptions" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://pubsub.googleapis.com/v1beta2/PROJECT/subscriptions", {
  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://pubsub.googleapis.com/v1beta2/PROJECT/subscriptions",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
PUT/v1beta2/{name}Creates the given topic with the given name.
GET/v1beta2/{project}/subscriptionsLists matching subscriptions.
GET/v1beta2/{project}/topicsLists matching topics.
GET/v1beta2/{resource}:getIamPolicyGets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
POST/v1beta2/{resource}:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` erro
POST/v1beta2/{resource}:testIamPermissionsReturns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND`
GET/v1beta2/{subscription}Gets the configuration details of a subscription.
DELETE/v1beta2/{subscription}Deletes an existing subscription. All pending messages in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. Afte
POST/v1beta2/{subscription}:acknowledgeAcknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription.
POST/v1beta2/{subscription}:modifyAckDeadlineModifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make
POST/v1beta2/{subscription}:modifyPushConfigModifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vic
POST/v1beta2/{subscription}:pullPulls messages from the server. Returns an empty list if there are no messages available in the backlog. The server may return `UNAVAILABLE` if there are too ma
GET/v1beta2/{topic}Gets the configuration of a topic.
DELETE/v1beta2/{topic}Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name;
GET/v1beta2/{topic}/subscriptionsLists the name of the subscriptions for this topic.
POST/v1beta2/{topic}:publishAdds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. The message payload must not be empty; it must contain either a non-emp

Questions

Does the Cloud Pub/Sub API API need an API key?

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

Does the Cloud Pub/Sub API API support HTTPS?

Yes, the Cloud Pub/Sub API API is served over HTTPS.

How many endpoints does the Cloud Pub/Sub API API have?

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

What are alternatives to the Cloud Pub/Sub 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).