{ "uuid": "1b86a456-5d6d-455f-ad30-24d6fc1bafd7", "lastMigration": 29, "name": "Pub/Sub Lite API", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "10001b9e-240c-414a-9aed-d9be77aeccc9", "documentation": "Deletes the specified topic.", "method": "delete", "endpoint": "v1/admin/:name", "responses": [ { "uuid": "d252ac18-fb5d-4e9c-b468-1295338e348d", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8cdb7f71-b175-4c07-ab9d-290ac230995f", "documentation": "Returns the topic configuration.", "method": "get", "endpoint": "v1/admin/:name", "responses": [ { "uuid": "eeb2a2ac-a697-464e-8dd6-7803815f0fd4", "body": "{\n \"name\": \"\",\n \"partitionConfig\": {\n \"capacity\": {\n \"publishMibPerSec\": {{faker 'number.int' max=99999}},\n \"subscribeMibPerSec\": {{faker 'number.int' max=99999}}\n },\n \"count\": \"\",\n \"scale\": {{faker 'number.int' max=99999}}\n },\n \"reservationConfig\": {\n \"throughputReservation\": \"\"\n },\n \"retentionConfig\": {\n \"perPartitionBytes\": \"\",\n \"period\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "040bc0e7-fcbb-4b51-9787-d0f192fa7528", "documentation": "Updates properties of the specified topic.", "method": "patch", "endpoint": "v1/admin/:name", "responses": [ { "uuid": "5e88732c-907e-46b5-b1b0-33f8b9317492", "body": "{\n \"name\": \"\",\n \"partitionConfig\": {\n \"capacity\": {\n \"publishMibPerSec\": {{faker 'number.int' max=99999}},\n \"subscribeMibPerSec\": {{faker 'number.int' max=99999}}\n },\n \"count\": \"\",\n \"scale\": {{faker 'number.int' max=99999}}\n },\n \"reservationConfig\": {\n \"throughputReservation\": \"\"\n },\n \"retentionConfig\": {\n \"perPartitionBytes\": \"\",\n \"period\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "b49f4675-c135-4e32-9e16-78da570b835b", "documentation": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", "method": "get", "endpoint": "v1/admin/:name/operations", "responses": [ { "uuid": "9296e9d2-9a16-4399-9898-e3e7efdf7773", "body": "{\n \"nextPageToken\": \"\",\n \"operations\": [\n {\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "dd0afae2-4bdf-4013-a43d-a35e51ef1d09", "documentation": "Returns the partition information for the requested topic.", "method": "get", "endpoint": "v1/admin/:name/partitions", "responses": [ { "uuid": "e7d39ef4-64ce-42a7-b5cf-dbd74498d880", "body": "{\n \"partitionCount\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9ddd5c16-10a0-4965-9bed-9a062b33eef6", "documentation": "Lists the subscriptions attached to the specified topic.", "method": "get", "endpoint": "v1/admin/:name/subscriptions", "responses": [ { "uuid": "e487e3da-09b8-430e-b678-c5632317c907", "body": "{\n \"nextPageToken\": \"\",\n \"subscriptions\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "79cd0035-a20e-42a9-a995-f77b0791bcec", "documentation": "Lists the topics attached to the specified reservation.", "method": "get", "endpoint": "v1/admin/:name/topics", "responses": [ { "uuid": "67873b8f-c183-48ef-aced-6dc480f6f2ce", "body": "{\n \"nextPageToken\": \"\",\n \"topics\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "e8c028b1-ebb7-43b7-b751-542b4df115a3", "documentation": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "method": "post", "endpoint": "v1/admin/:name:cancel", "responses": [ { "uuid": "401b0987-d670-453b-aa53-e5f4328b9fc4", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2be1a152-54e7-41e4-b4fd-163e89323354", "documentation": "Performs 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 these targets to cursors for each partition and orchestrates subscribers to start consuming messages from these seek cursors. If an operation is returned, the seek has been registered and subscribers will eventually receive messages from the seek cursors (i.e. eventual consistency), as long as they are using a minimum supported client library version and not a system that tracks cursors independently of Pub/Sub Lite (e.g. Apache Beam, Dataflow, Spark). The seek operation will fail for unsupported clients. If clients would like to know when subscribers react to the seek (or not), they can poll the operation. The seek operation will succeed and complete once subscribers are ready to receive messages from the seek cursors for all partitions of the topic. This means that the seek operation will not complete until all subscribers come online. If the previous seek operation has not yet completed, it will be aborted and the new invocation of seek will supersede it.", "method": "post", "endpoint": "v1/admin/:name:seek", "responses": [ { "uuid": "b2b51014-eb95-474c-a7ca-42630c2fc952", "body": "{\n \"done\": {{faker 'datatype.boolean'}},\n \"error\": {\n \"code\": {{faker 'number.int' max=99999}},\n \"details\": [\n {}\n ],\n \"message\": \"\"\n },\n \"metadata\": {},\n \"name\": \"\",\n \"response\": {}\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fdf0001d-1b58-4753-997e-55aec3bc2a75", "documentation": "Returns the list of reservations for the given project.", "method": "get", "endpoint": "v1/admin/:parent/reservations", "responses": [ { "uuid": "645d4f22-53c4-4c78-989b-b5b565a2aeee", "body": "{\n \"nextPageToken\": \"\",\n \"reservations\": [\n {\n \"name\": \"\",\n \"throughputCapacity\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "2457ed94-3b38-4ab7-b3a2-4b79841a0e93", "documentation": "Creates a new reservation.", "method": "post", "endpoint": "v1/admin/:parent/reservations", "responses": [ { "uuid": "99c432a5-ec3a-4561-941d-72420690773c", "body": "{\n \"name\": \"\",\n \"throughputCapacity\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "fd7aeae9-2599-4f9c-b97b-6e10d743e343", "documentation": "Returns the list of subscriptions for the given project.", "method": "get", "endpoint": "v1/admin/:parent/subscriptions", "responses": [ { "uuid": "d774aacb-7156-445b-bbdf-1a2724d3f88a", "body": "{\n \"nextPageToken\": \"\",\n \"subscriptions\": [\n {\n \"deliveryConfig\": {\n \"deliveryRequirement\": \"{{oneOf (array 'DELIVERY_REQUIREMENT_UNSPECIFIED' 'DELIVER_IMMEDIATELY' 'DELIVER_AFTER_STORED')}}\"\n },\n \"name\": \"\",\n \"topic\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "5b8ac37d-8e07-46f9-9e59-94fc19d7a98a", "documentation": "Creates a new subscription.", "method": "post", "endpoint": "v1/admin/:parent/subscriptions", "responses": [ { "uuid": "c6989ca6-53ed-41f9-9d18-7feaeccbcf97", "body": "{\n \"deliveryConfig\": {\n \"deliveryRequirement\": \"{{oneOf (array 'DELIVERY_REQUIREMENT_UNSPECIFIED' 'DELIVER_IMMEDIATELY' 'DELIVER_AFTER_STORED')}}\"\n },\n \"name\": \"\",\n \"topic\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "eaacf597-2184-471e-ae11-93a2cba46331", "documentation": "Returns the list of topics for the given project.", "method": "get", "endpoint": "v1/admin/:parent/topics", "responses": [ { "uuid": "f5598f79-0648-44ea-9c7d-ead76a45e88e", "body": "{\n \"nextPageToken\": \"\",\n \"topics\": [\n {\n \"name\": \"\",\n \"partitionConfig\": {\n \"capacity\": {\n \"publishMibPerSec\": {{faker 'number.int' max=99999}},\n \"subscribeMibPerSec\": {{faker 'number.int' max=99999}}\n },\n \"count\": \"\",\n \"scale\": {{faker 'number.int' max=99999}}\n },\n \"reservationConfig\": {\n \"throughputReservation\": \"\"\n },\n \"retentionConfig\": {\n \"perPartitionBytes\": \"\",\n \"period\": \"\"\n }\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d0c9f449-baa4-4afd-aa9f-0584b3b0f010", "documentation": "Creates a new topic.", "method": "post", "endpoint": "v1/admin/:parent/topics", "responses": [ { "uuid": "ec49a91d-5baa-4ebf-919c-93b19284a53b", "body": "{\n \"name\": \"\",\n \"partitionConfig\": {\n \"capacity\": {\n \"publishMibPerSec\": {{faker 'number.int' max=99999}},\n \"subscribeMibPerSec\": {{faker 'number.int' max=99999}}\n },\n \"count\": \"\",\n \"scale\": {{faker 'number.int' max=99999}}\n },\n \"reservationConfig\": {\n \"throughputReservation\": \"\"\n },\n \"retentionConfig\": {\n \"perPartitionBytes\": \"\",\n \"period\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f659fe61-8a06-4add-8196-ec66817fa93e", "documentation": "Returns all committed cursor information for a subscription.", "method": "get", "endpoint": "v1/cursor/:parent/cursors", "responses": [ { "uuid": "1b55edbe-e2bc-444c-9dc4-19478ff2c70c", "body": "{\n \"nextPageToken\": \"\",\n \"partitionCursors\": [\n {\n \"cursor\": {\n \"offset\": \"\"\n },\n \"partition\": \"\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "be98c434-99b9-471d-afff-98c94043065f", "documentation": "Updates the committed cursor.", "method": "post", "endpoint": "v1/cursor/:subscription:commitCursor", "responses": [ { "uuid": "fc806303-72f2-421a-ac00-5cbb3f9084c6", "body": "{}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "04f02b8f-e740-4950-b869-d37a7dea966f", "documentation": "Compute 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 acknowledged as published, and greater than the offset of any message whose publish has already been acknowledged. It is zero if there have never been messages in the partition.", "method": "post", "endpoint": "v1/topicStats/:topic:computeHeadCursor", "responses": [ { "uuid": "02072873-33c8-4389-8dca-3579b746a3e9", "body": "{\n \"headCursor\": {\n \"offset\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "8ed7a053-facd-415d-8a87-381407ba4c82", "documentation": "Compute statistics about a range of messages in a given topic and partition.", "method": "post", "endpoint": "v1/topicStats/:topic:computeMessageStats", "responses": [ { "uuid": "130b23d8-cd6b-41fc-bb25-1b88c8b2a83b", "body": "{\n \"messageBytes\": \"\",\n \"messageCount\": \"\",\n \"minimumEventTime\": \"\",\n \"minimumPublishTime\": \"\"\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bc48b4e9-420a-4ede-9383-d0c07016b582", "documentation": "Compute the corresponding cursor for a publish or event time in a topic partition.", "method": "post", "endpoint": "v1/topicStats/:topic:computeTimeCursor", "responses": [ { "uuid": "414e3801-03df-4014-b773-fd2a1c9f720d", "body": "{\n \"cursor\": {\n \"offset\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful response", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "10001b9e-240c-414a-9aed-d9be77aeccc9" }, { "type": "route", "uuid": "8cdb7f71-b175-4c07-ab9d-290ac230995f" }, { "type": "route", "uuid": "040bc0e7-fcbb-4b51-9787-d0f192fa7528" }, { "type": "route", "uuid": "b49f4675-c135-4e32-9e16-78da570b835b" }, { "type": "route", "uuid": "dd0afae2-4bdf-4013-a43d-a35e51ef1d09" }, { "type": "route", "uuid": "9ddd5c16-10a0-4965-9bed-9a062b33eef6" }, { "type": "route", "uuid": "79cd0035-a20e-42a9-a995-f77b0791bcec" }, { "type": "route", "uuid": "e8c028b1-ebb7-43b7-b751-542b4df115a3" }, { "type": "route", "uuid": "2be1a152-54e7-41e4-b4fd-163e89323354" }, { "type": "route", "uuid": "fdf0001d-1b58-4753-997e-55aec3bc2a75" }, { "type": "route", "uuid": "2457ed94-3b38-4ab7-b3a2-4b79841a0e93" }, { "type": "route", "uuid": "fd7aeae9-2599-4f9c-b97b-6e10d743e343" }, { "type": "route", "uuid": "5b8ac37d-8e07-46f9-9e59-94fc19d7a98a" }, { "type": "route", "uuid": "eaacf597-2184-471e-ae11-93a2cba46331" }, { "type": "route", "uuid": "d0c9f449-baa4-4afd-aa9f-0584b3b0f010" }, { "type": "route", "uuid": "f659fe61-8a06-4add-8196-ec66817fa93e" }, { "type": "route", "uuid": "be98c434-99b9-471d-afff-98c94043065f" }, { "type": "route", "uuid": "04f02b8f-e740-4950-b869-d37a7dea966f" }, { "type": "route", "uuid": "8ed7a053-facd-415d-8a87-381407ba4c82" }, { "type": "route", "uuid": "bc48b4e9-420a-4ede-9383-d0c07016b582" } ] }