HTTP API
Message Queue Topics
GET/api/v1/mq/topics
Authorization
bearer_token AuthorizationBearer <token>
In: header
Query Parameters
page?integer
Page number (1-indexed)
Format
int64Range
0 <= valuepage_size?integer
Page size (max 100)
Format
int64Range
0 <= valuesort_by?string
Sort by field (e.g., "name", "-created_at")
q?string
Search query for topic name
Response Body
application/json
curl -X GET "https://example.com/api/v1/mq/topics"{ "pagination": { "has_more": true, "page": 0, "page_size": 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 AuthorizationBearer <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 AuthorizationBearer <token>
In: header
Path Parameters
topic_name*string
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 AuthorizationBearer <token>
In: header
Path Parameters
topic_name*string
Response Body
application/json
curl -X DELETE "https://example.com/api/v1/mq/topics/string"{ "message": "string"}