REST API
Retained Messages API
List and delete retained messages on the broker
List Retained Messages
GET /v2/utilities/retainedReturns retained messages stored on the broker.
Parameters
| Parameter | Type | Description |
|---|---|---|
topic | string (optional) | Filter by topic pattern (supports MQTT wildcards) |
Example
curl "https://api.cloudsignal.app/v2/utilities/retained?topic=sensors/#" \
-H "X-Secret-Key: sk_your_secret_key"Response
{
"messages": [
{ "topic": "sensors/temp/floor-1", "payload_size": 42, "timestamp": "2026-03-27T09:30:00Z" },
{ "topic": "sensors/temp/floor-2", "payload_size": 38, "timestamp": "2026-03-27T09:31:00Z" }
],
"count": 2
}Delete Retained Message
DELETE /v2/utilities/retained/{topic}Deletes the retained message for a specific topic.
Example
curl -X DELETE "https://api.cloudsignal.app/v2/utilities/retained/sensors/temp/floor-1" \
-H "X-Secret-Key: sk_your_secret_key"Response
{ "deleted": true, "topic": "sensors/temp/floor-1" }