Status

Serves as a health check for the node. Returns a plain text response describing the status of the node. This endpoint requires no authentication.<br/><br/>Returns status code 200 if the EMQX application is up and running, 503 otherwise.<br/>This API was introduced in v5.0.10.<br/>The GET /status endpoint (without the /api/... prefix) is also an alias to this endpoint and works in the same way. This alias has been available since v5.0.0.

get/status

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/status
  • Auth: none required

Response

Node emqx@127.0.0.1 is started<br/>emqx is running

Changes

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