Configs

Get the sub-configurations under dashboard

get/configs/dashboard

Request

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

Response

default_usernamestring required

The default username of the automatically created dashboard user.

default_passwordstring required

The initial default password for dashboard 'admin' user.<br/>For safety, it should be changed as soon as possible.<br/>This value is not valid when you log in to Dashboard for the first time via the web<br/>and change to a complex password as prompted.<br/>

sample_intervalstring

How often to update metrics displayed in the dashboard.<br/>Note: sample_interval should be a divisor of 60, default is 10s.

token_expired_timestring

JWT token expiration time. Default is 60 minutes

corsboolean

Support Cross-Origin Resource Sharing (CORS).<br/>Allows a server to indicate any origins (domain, scheme, or port) other than<br/>its own from which a browser should permit loading resources.

i18n_lang'en' | 'zh'

Internationalization language support.

bootstrap_users_filestring

Deprecated, use api_key.bootstrap_file.

Example response

{
  "listeners": {
    "http": {
      "bind": "127.0.0.1:80",
      "send_timeout": "12m"
    },
    "https": {
      "bind": "127.0.0.1:80",
      "send_timeout": "12m",
      "handshake_timeout": "12m"
    }
  },
  "sample_interval": "1h",
  "token_expired_time": "12m"
}

Changes

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