POST

/topics/{topic}

http://data-ats.iot.{region}.amazonaws.com/topics/{topic}

Publishes an MQTT message. Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">Publish</a> action. For more information about MQTT messages, see <a href="http://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html">MQTT Protocol</a> in the IoT Developer Guide. For more information about messaging costs, see <a href="http://aws.amazon.com/iot-core/pricing/#Messaging">Amazon Web Services IoT Core pricing - Messaging</a>.

Access Token Required: API Key

Path Parameters

topicstringrequired

The name of the MQTT topic.

Query Params

qosinteger

The Quality of Service (QoS) level. The default QoS level is 0.

retainboolean

A Boolean value that determines whether to set the RETAIN flag when the message is published. Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic. Valid values: <code>true</code> | <code>false</code> Default value: <code>false</code>

contentTypestring

A UTF-8 encoded string that describes the content of the publishing message.

responseTopicstring

A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.

messageExpiryinteger

A user-defined integer value that represents the message expiry interval in seconds. If absent, the message doesn't expire. For more information about the limits of <code>messageExpiry</code>, see <a href="https://docs.aws.amazon.com/general/latest/gr/iot-core.html#message-broker-limits">Amazon Web Services IoT Core message broker and protocol limits and quotas </a> from the Amazon Web Services Reference Guide.

Body Params

payloadstring

The message body. MQTT accepts text, binary, and empty (null) message payloads. Publishing an empty (null) payload with retain = <code>true</code> deletes the retained message identified by topic from Amazon Web Services IoT Core.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://data-ats.iot.{region}.amazonaws.com/topics/{topic}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}