Message Queue Topics
GET/api/v1/mq/topics
Authorization
bearer_token In: header
Query Parameters
Conditions as filter[][]=. Conditions on different fields all apply. in (any of) and all (every one of, on fields holding several values) take a comma-separated list (\, for a literal comma). exists takes true or false. Datetimes are RFC 3339, now, or a time before now such as -30m, -6h or -7d.
Comma-separated sort keys, - for descending, at most 1. Keys: name, message_count, subscription_count, updated_at, created_at. Default: -created_at.
Rows per page, 1 to 100 (default 25).
1 <= value <= 100The page.next_cursor of the previous page. Cannot be combined with page.
A 1-based page number, for jumping. Cannot be combined with cursor.
1 <= valueSet to true to include the number of matching rows in page.total.
Response Body
application/json
curl -X GET "https://example.com/api/v1/mq/topics"{ "page": { "has_more": true, "next_cursor": "string", "page": 0, "total": 0 }, "topics": [ { "created_at": "2019-08-24T14:15:22Z", "message_count": 0, "name": "string", "subscription_count": 0, "topic_id": "string" } ]}POST/api/v1/mq/topics
Authorization
bearer_token In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request to create a new topic
Response Body
application/json
curl -X POST "https://example.com/api/v1/mq/topics" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "created_at": "2019-08-24T14:15:22Z", "max_message_size_bytes": 0, "name": "string", "retention_minutes": 0, "tags": { "property1": "string", "property2": "string" }, "topic_id": "string"}GET/api/v1/mq/topics/{topic_name}
Authorization
bearer_token In: header
Path Parameters
Response Body
application/json
curl -X GET "https://example.com/api/v1/mq/topics/string"{ "created_at": "2019-08-24T14:15:22Z", "max_message_size_bytes": 0, "message_count": 0, "name": "string", "retention_minutes": 0, "subscription_count": 0, "tags": { "property1": "string", "property2": "string" }, "topic_id": "string", "updated_at": "2019-08-24T14:15:22Z"}DELETE/api/v1/mq/topics/{topic_name}
Authorization
bearer_token In: header
Path Parameters
Response Body
application/json
curl -X DELETE "https://example.com/api/v1/mq/topics/string"{ "message": "string"}