Sign in
Config

Get Configuration

Retrieves the full set of configuration settings and associated metadata. This response can be very large, particularly when the advanced parameter is set to 'true'.

get/connect/config/

Query parameters

advancedboolean

If true, all configuration settings will be retrieved, otherwise only the commonly adjusted settings are retrieved

Response

The configuration setting objects

advancedboolean

(metadata) Indicates whether this setting should only be shown when the 'Show advanced settings' option is enabled in the user interface.

defaultstring

(metadata) The default value for this configuration setting, if available

defaultAvailableboolean

(metadata) Indicates whether there is a default value available for this configuration setting

descriptionstring

(metadata) A description explaining the purpose of the configuration setting, if one is available.

duplicatesboolean

(metadata) Indicates whether this setting can be duplicated. Duplicating settings is a complex area that can lead to system or upgrade failures so this is used sparingly.

fileboolean

(metadata) Indicates whether the ID of this setting refers to a file on disk, in which case the changing the setting's value will replace the contents of the file on disk.

forcedTypestring

(metadata) The type that the value will be converted to internally before applied to the component that uses it.

globalboolean

(metadata) Indicates whether this setting only applies to the grid as a whole

helpLinkstring

(metadata) An HTML page, relative to the doc URL, that may assist the user in understanding the purpose of this setting.

idstring

The ID of the configuration setting. Each period represents a nested level.

jinjaEscapedboolean

(metadata) Indicates whether the setting value allows Jinja2 escape characters. By default these are prohibited as a security precaution.

multilineboolean

(metadata) Indicates whether this setting's user interface display should allow the user to enter values onto multiple lines

nodeboolean

(metadata) Indicates whether this setting can be applied differently per each node in the grid

nodeIdstring

The node ID to which this setting's value applies

optionSeparatorstring

(metadata) For multi-select options, the separator string used to store them into a single string

optionsstring[]

(metadata) List of static values for a setting

readonlyboolean

(metadata) Indicates whether this setting is read-only. Read-only settings should not be modified.

readonlyUiboolean

(metadata) Indicates whether this setting is read-only in the user interface only, but may be adjusted by the system itself.

regexstring

(metadata) An optional regular expression pattern that the value of this setting must match

regexFailureMessagestring

(metadata) The failure message to show on the user interface when the user enters a value that fails to match the regex.

requiredboolean

(metadata) If true this UI element must be specified by the user before it can be saved

sensitiveboolean

(metadata) Indicates whether this setting's value should be masked in the user interface to prevent obtaining the existing value, while still permitting new values to be applied.

syntaxstring

(metadata) An optional syntax designator for validating the given setting value.

titlestring

(metadata) The configuration setting more human-friendly title, if one is available.

uiElementsDeleteMessagestring

(metadata) Confirmation message to show when user clicks the delete button on a ui element. If omitted, no message will be shown.

valuestring

The value of this specific configuration setting. Note that a setting exist multiple times if different values are applied to specific nodes

Example response

[
  {
    "default": "some default value",
    "defaultAvailable": true,
    "description": "Optional configuration parameters made available as defaults for all rules and alerters",
    "forcedType": "[]string",
    "global": true,
    "helpLink": "elastalert.html",
    "id": "elastalert.alerter_parameters",
    "multiline": true,
    "nodeId": "chi-so-001_standalone",
    "regex": "^(true|false)$",
    "regexFailureMessage": "Only true or false values are accepted",
    "sensitive": true,
    "syntax": "yaml",
    "title": "Custom Configuration Parameters",
    "uiElements": [
      {
        "field": "some_key",
        "forcedType": "[]string",
        "label": "An Important Key",
        "multiline": true,
        "regex": "^(true|false)$",
        "regexFailureMessage": "Only true or false values are accepted"
      }
    ],
    "value": "some custom value"
  }
]

Changes

Changed in 5 of the 23 revisions of this API.716

  • 75a372f68ede13See the full diff
    • ○

      added the optional property items/optionSeparator to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/options to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/required to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/uiElements/items/default to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/uiElements/items/forcedType to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/uiElements/items/multiline to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/uiElements/items/optionSeparator to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/uiElements/items/options to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/uiElements/items/readonly to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/uiElements/items/regex to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/uiElements/items/regexFailureMessage to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/uiElements/items/required to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/uiElementsDeleteMessage to the response with the 200 status

      response-optional-property-added

    This revision also has 12 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d99c966f2c5e2See the full diff
    • ●

      removed the optional property items/uiElements/items/forcedType from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/uiElements/items/multiline from the response with the 200 status

      response-optional-property-removed

    This revision also has 12 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • db869f5cea772See the full diff
    • ○

      added the optional property items/uiElements/items/forcedType to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/uiElements/items/multiline to the response with the 200 status

      response-optional-property-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0600bede2a741See the full diff
    • ○

      added the optional property items/uiElements to the response with the 200 status

      response-optional-property-added

  • ee1120fd1e205See the full diff
    • ●

      removed the optional property items/optionSeparator from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/options from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/required from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/uiElements from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property items/uiElementsDeleteMessage from the response with the 200 status

      response-optional-property-removed

    This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog