Cloud Pub/Sub API
Provides reliable, many-to-many, asynchronous messaging between applications.
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
Provides reliable, many-to-many, asynchronous messaging between applications.
Endpoints 33
projects.schemas
- POSTCommits a new schema revision to an existing schema.
/v1/:name:commitCommits a new schema revision to an existing schema. - GETLists schemas in a project.
/v1/:parent/schemas?pageSize=0&pageToken=string&view=SCHEMA_VIEW_UNSPECIFIEDLists schemas in a project. - POSTCreates a schema.
/v1/:parent/schemas?schemaId=stringCreates a schema. - GETGets a schema.
/v1/:name?view=SCHEMA_VIEW_UNSPECIFIEDGets a schema. - DELETEDeletes a schema.
/v1/:nameDeletes a schema. - DELETEDeletes a specific schema revision.
/v1/:name:deleteRevision?revisionId=stringDeletes a specific schema revision. - GETLists all schema revisions for the named schema.
/v1/:name:listRevisions?pageSize=0&pageToken=string&view=SCHEMA_VIEW_UNSPECIFIEDLists all schema revisions for the named schema. - POSTCreates a new schema revision that is a copy of the provided revision_id.
/v1/:name:rollbackCreates a new schema revision that is a copy of the provided revision_id. - POSTValidates a schema.
/v1/:parent/schemas:validateValidates a schema. - POSTValidates a message against a schema.
/v1/:parent/schemas:validateMessageValidates a message against a schema.
projects.topics
- PUTCreates the given topic with the given name
/v1/:nameCreates the given topic with the given name. See the [resource name rules]( https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). - PATCHUpdates an existing topic by updating the fields specified in the update mask
/v1/:nameUpdates an existing topic by updating the fields specified in the update mask. Note that certain properties of a topic are not modifiable. - GETGets the access control policy for a resource
/v1/:resource:getIamPolicy?options.requestedPolicyVersion=0Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. - POSTSets the access control policy on the specified resource
/v1/:resource:setIamPolicySets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. - POSTReturns permissions that a caller has on the specified resource
/v1/: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… - GETGets the configuration of a topic.
/v1/:topicGets the configuration of a topic. - DELETEDeletes the topic with the given name
/v1/:topicDeletes 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;… - GETLists matching topics.
/v1/:project/topics?pageSize=0&pageToken=stringLists matching topics. - POSTAdds one or more messages to the topic
/v1/:topic:publishAdds one or more messages to the topic. Returns NOT_FOUND if the topic does not exist.
projects.snapshots
- GETGets the configuration details of a snapshot
/v1/:snapshotGets the configuration details of a snapshot. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you… - DELETERemoves an existing snapshot
/v1/:snapshotRemoves an existing snapshot. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage… - GETLists the existing snapshots
/v1/:project/snapshots?pageSize=0&pageToken=stringLists the existing snapshots. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage…
projects.subscriptions
- POSTAcknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`
/v1/:subscription:acknowledgeAcknowledges the messages associated with the ack_ids in the AcknowledgeRequest. The Pub/Sub system can remove the relevant messages from the subscription.… - GETGets the configuration details of a subscription.
/v1/:subscriptionGets the configuration details of a subscription. - DELETEDeletes an existing subscription
/v1/:subscriptionDeletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to Pull after deletion will return NOT_FOUND. After… - POSTDetaches a subscription from this topic
/v1/:subscription:detachDetaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent Pull and StreamingPull requests will return… - GETLists matching subscriptions.
/v1/:project/subscriptions?pageSize=0&pageToken=stringLists matching subscriptions. - POSTModifies the ack deadline for a specific message
/v1/: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… - POSTModifies the `PushConfig` for a specified subscription
/v1/: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 vice… - POSTPulls messages from the server.
/v1/:subscription:pullPulls messages from the server. - POSTSeeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request
/v1/:subscription:seekSeeks an existing subscription to a point in time or to a given snapshot, whichever is provided in the request. Snapshots are used in [Seek](…
projects.topics.snapshots
- GETLists the names of the snapshots on this topic
/v1/:topic/snapshots?pageSize=0&pageToken=stringLists the names of the snapshots on this topic. Snapshots are used in Seek operations, which allow you to manage message acknowledgments in bulk. That is, you…
projects.topics.subscriptions
- GETLists the names of the attached subscriptions on this topic.
/v1/:topic/subscriptions?pageSize=0&pageToken=stringLists the names of the attached subscriptions on this topic.
API details
- Base URL
https://pubsub.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter - Operations
- 33 operations on 26 pathsPOST 14GET 12DELETE 5PUT 1PATCH 1
- Main resources
- projects.schemas 10projects.subscriptions 9projects.topics 9projects.snapshots 3projects.topics.snapshots 1projects.topics.subscriptions 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Cloud Pub/Sub 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 Pub/Sub API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Commits a new schema revision to an existing schema.” (POST /v1/:name:commit), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloud Pub/Sub API?
Provides reliable, many-to-many, asynchronous messaging between applications. It is listed under Developer tools and has 33 endpoints.
Who publishes the Cloud Pub/Sub 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 Pub/Sub API?
Requests go to https://pubsub.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Cloud Pub/Sub API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.
How many endpoints does the Cloud Pub/Sub API have?
33 operations on 26 paths (14 POST, 12 GET, 5 DELETE, 1 PUT, 1 PATCH). The largest groups are projects.schemas, projects.subscriptions, projects.topics, projects.snapshots.
Is forking the Cloud Pub/Sub API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.