POST /devices/me/passive

Set the client to passive mode. In passive mode, the client will not receive messages but can still send them. Useful for reducing bandwidth.

application/json

Body Required

  • passive boolean

    Whether to enable passive mode

    Default value is true.

Responses

  • 200 application/json

    Passive mode set

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • data object
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
POST /devices/me/passive
curl \
 --request POST 'http://localhost:7001/devices/me/passive' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"passive":true}'
Request examples
{
  "passive": true
}
Response examples (200)
{
  "status": true,
  "code": 200,
  "message": "Success",
  "data": {}
}
Response examples (401)
{
  "status": false,
  "code": 400,
  "message": "Bad request",
  "error": "Bad request"
}
Response examples (500)
{
  "status": false,
  "code": 400,
  "message": "Bad request",
  "error": "Bad request"
}