Gateway Clients

Add Subscription for Client

Create a subscription membership

post/gateways/{name}/clients/{clientid}/subscriptions

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/gateways/{name}/clients/{clientid}/subscriptions
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Path parameters

clientidstring required

Client ID

namestring required

Gateway Name

Request body

topicstring

Topic Filter/Name

qosinteger

QoS level, enum: 0, 1, 2

nlinteger

No Local option, enum: 0, 1

rapinteger

Retain as Published option, enum: 0, 1

rhinteger

Retain Handling option, enum: 0, 1, 2

Response

topicstring

Topic Filter/Name

qosinteger

QoS level, enum: 0, 1, 2

nlinteger

No Local option, enum: 0, 1

rapinteger

Retain as Published option, enum: 0, 1

rhinteger

Retain Handling option, enum: 0, 1, 2

Changes

No recorded changes to this operation across all 1 revision of this API.