API Keys

Return the specific api_key

get/api_key/{name}

Request

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

Path parameters

namestring required

^[A-Za-z]+[A-Za-z0-9-_]*$

Response

namestring

Unique and format by [a-zA-Z0-9-_]

api_keystring

TODO:uses HMAC-SHA256 for signing.

descstring
enableboolean

Enable/Disable

expiredboolean

Expired

Example response

{
  "name": "EMQX-API-KEY-1",
  "api_key": "a4697a5c75a769f6",
  "expired_at": 1640995200,
  "created_at": 1640995200,
  "desc": "Note"
}

Changes

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