Pub/Sub Lite API
Pub/Sub Lite API endpoints from Google
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
Pub/Sub Lite API endpoints from Google
Endpoints 20
admin.projects.locations.operations
- POSTStarts asynchronous cancellation on a long-running operation
/v1/admin/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the… - GETLists operations that match the specified filter in the request
/v1/admin/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
admin.projects.locations.topics
- GETReturns the topic configuration.
/v1/admin/:nameReturns the topic configuration. - DELETEDeletes the specified topic.
/v1/admin/:nameDeletes the specified topic. - PATCHUpdates properties of the specified topic.
/v1/admin/:name?updateMask=stringUpdates properties of the specified topic. - GETReturns the list of topics for the given project.
/v1/admin/:parent/topics?pageSize=0&pageToken=stringReturns the list of topics for the given project. - POSTCreates a new topic.
/v1/admin/:parent/topics?topicId=stringCreates a new topic. - GETReturns the partition information for the requested topic.
/v1/admin/:name/partitionsReturns the partition information for the requested topic.
admin.projects.locations.reservations
- GETReturns the list of reservations for the given project.
/v1/admin/:parent/reservations?pageSize=0&pageToken=stringReturns the list of reservations for the given project. - POSTCreates a new reservation.
/v1/admin/:parent/reservations?reservationId=stringCreates a new reservation.
admin.projects.locations.reservations.topics
- GETLists the topics attached to the specified reservation.
/v1/admin/:name/topics?pageSize=0&pageToken=stringLists the topics attached to the specified reservation.
admin.projects.locations.subscriptions
- GETReturns the list of subscriptions for the given project.
/v1/admin/:parent/subscriptions?pageSize=0&pageToken=stringReturns the list of subscriptions for the given project. - POSTCreates a new subscription.
/v1/admin/:parent/subscriptions?skipBacklog=true&subscriptionId=stringCreates a new subscription. - POSTPerforms an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions…
/v1/admin/:name:seekPerforms an out-of-band seek for a subscription to a specified target, which may be timestamps or named positions within the message backlog. Seek translates…
admin.projects.locations.topics.subscriptions
- GETLists the subscriptions attached to the specified topic.
/v1/admin/:name/subscriptions?pageSize=0&pageToken=stringLists the subscriptions attached to the specified topic.
cursor.projects.locations.subscriptions
- POSTUpdates the committed cursor.
/v1/cursor/:subscription:commitCursorUpdates the committed cursor.
cursor.projects.locations.subscriptions.cursors
- GETReturns all committed cursor information for a subscription.
/v1/cursor/:parent/cursors?pageSize=0&pageToken=stringReturns all committed cursor information for a subscription.
topicStats.projects.locations.topics
- POSTCompute the head cursor for the partition
/v1/topicStats/:topic:computeHeadCursorCompute the head cursor for the partition. The head cursor's offset is guaranteed to be less than or equal to all messages which have not yet been… - POSTCompute statistics about a range of messages in a given topic and partition.
/v1/topicStats/:topic:computeMessageStatsCompute statistics about a range of messages in a given topic and partition. - POSTCompute the corresponding cursor for a publish or event time in a topic partition.
/v1/topicStats/:topic:computeTimeCursorCompute the corresponding cursor for a publish or event time in a topic partition.
API details
- Base URL
https://pubsublite.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 20 operations on 15 pathsGET 9POST 9PATCH 1DELETE 1
- Main resources
- admin.projects.locations.topics 6admin.projects.locations.subscriptions 3topicStats.projects.locations.topics 3admin.projects.locations.operations 2admin.projects.locations.reservations 2admin.projects.locations.reservations.topics 1admin.projects.locations.topics.subscriptions 1cursor.projects.locations.subscriptions 1cursor.projects.locations.subscriptions.cursors 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 Pub/Sub Lite 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 Pub/Sub Lite 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 “Starts asynchronous cancellation on a long-running operation” (POST /v1/admin/:name:cancel), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Pub/Sub Lite API?
Pub/Sub Lite API endpoints from Google It is listed under Developer tools and has 20 endpoints.
Who publishes the Pub/Sub Lite 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 Pub/Sub Lite API?
Requests go to https://pubsublite.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Pub/Sub Lite 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 Pub/Sub Lite API have?
20 operations on 15 paths (9 GET, 9 POST, 1 PATCH, 1 DELETE). The largest groups are admin.projects.locations.topics, admin.projects.locations.subscriptions, topicStats.projects.locations.topics, admin.projects.locations.operations.
Is forking the Pub/Sub Lite API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.