Authentication

Get authenticator status from global authentication chain.

get/authentication/{id}/status

Request

  • Base URL: https://docs.emqx.com/api/v5
  • URL: https://docs.emqx.com/api/v5/authentication/{id}/status
  • Auth: one of:
    • HTTP basic
    • bearerAuth (a scheme the document does not define)

Path parameters

idstring required

Authenticator ID.

Response

status'connected' | 'disconnected' | 'connecting' | 'inconsistent'

The status of the resource.

Example response

{
  "node_resource_metrics": {
    "node": "emqx@127.0.0.1"
  },
  "node_metrics": {
    "node": "emqx@127.0.0.1"
  },
  "node_status": {
    "node": "emqx@127.0.0.1"
  },
  "node_error": {
    "node": "emqx@127.0.0.1"
  }
}

Changes

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