emqx_mgmt_api_configs.hocon 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. emqx_mgmt_api_configs {
  2. get_configs.desc:
  3. """Get all the configurations of the specified keys, including hot and non-hot updatable items."""
  4. get_configs.label:
  5. """Get all the configurations."""
  6. update_configs.desc:
  7. """Update the configurations of the specified keys."""
  8. update_configs.label:
  9. """Update Configurations."""
  10. node_name.desc:
  11. """Node's name. Will deprecated in 5.2.0."""
  12. node_name.label:
  13. """Node's name (deprecated)."""
  14. rest_conf_query.desc:
  15. """Reset the config entry specified by the query string parameter `conf_path`.<br/>
  16. - For a config entry that has default value, this resets it to the default value;
  17. - For a config entry that has no default value, an error 400 will be returned"""
  18. rest_conf_query.label:
  19. """Reset the config entry with query"""
  20. get_global_zone_configs.desc:
  21. """Get the global zone configs"""
  22. get_global_zone_configs.label:
  23. """Get the global zone configs"""
  24. update_global_zone_configs.desc:
  25. """Update global zone configs"""
  26. update_global_zone_configs.label:
  27. """Update global zone configs"""
  28. get_node_level_limiter_configs.desc:
  29. """Get the node-level limiter configs"""
  30. get_node_level_limiter_configs.label:
  31. """Get the node-level limiter configs"""
  32. update_node_level_limiter_configs.desc:
  33. """Update the node-level limiter configs"""
  34. update_node_level_limiter_configs.label:
  35. """Update the node-level limiter configs"""
  36. }