Skip to content

Message Queue Subscriptions

GET/api/v1/mq/topics/{topic_name}/subscriptions
GET
/api/v1/mq/topics/{topic_name}/subscriptions

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

topic_name*string

Query Parameters

filter?

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.

sort?string

Comma-separated sort keys, - for descending, at most 1. Keys: created_at. Default: -created_at.

limit?integer

Rows per page, 1 to 100 (default 25).

Range1 <= value <= 100
cursor?string

The page.next_cursor of the previous page. Cannot be combined with page.

page?integer

A 1-based page number, for jumping. Cannot be combined with cursor.

Range1 <= value
total?boolean

Set 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/string/subscriptions"
{  "page": {    "has_more": true,    "next_cursor": "string",    "page": 0,    "total": 0  },  "subscriptions": [    {      "created_at": "2019-08-24T14:15:22Z",      "filter_policy": null,      "queue_name": "string",      "subscription_id": "string"    }  ]}
POST/api/v1/mq/topics/{topic_name}/subscriptions
POST
/api/v1/mq/topics/{topic_name}/subscriptions

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

topic_name*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request to subscribe a queue to a topic

Response Body

application/json

curl -X POST "https://example.com/api/v1/mq/topics/string/subscriptions" \  -H "Content-Type: application/json" \  -d '{    "queue_name": "string"  }'
{  "created_at": "2019-08-24T14:15:22Z",  "filter_policy": null,  "queue_name": "string",  "raw_message_delivery": true,  "subscription_id": "string",  "topic_name": "string"}
DELETE/api/v1/mq/topics/{topic_name}/subscriptions/{queue_name}
DELETE
/api/v1/mq/topics/{topic_name}/subscriptions/{queue_name}

Authorization

bearer_token
AuthorizationBearer <token>

In: header

Path Parameters

topic_name*string
queue_name*string

Response Body

application/json

curl -X DELETE "https://example.com/api/v1/mq/topics/string/subscriptions/string"
{  "message": "string"}