Loading

Alerting and action settings in Kibana

Alerting and actions are enabled by default in Kibana, but require you to configure the following:

  1. Set up Kibana to work with Elastic Stack security features.
  2. Set up TLS encryption between Kibana and Elasticsearch.
  3. If you are using an on-premises Elastic Stack deployment, specify a value for xpack.encryptedSavedObjects.encryptionKey.

General settings

xpack.encryptedSavedObjects.encryptionKey

Supported on:

A string of 32 or more characters used to encrypt sensitive properties on alerting rules and actions before they're stored in Elasticsearch. Third party credentials — such as the username and password used to connect to an SMTP service — are an example of encrypted properties.

Kibana offers a CLI tool to help generate this encryption key.

If not set, Kibana will generate a random key on startup, but all alerting and action functions will be blocked. Generated keys are not allowed for alerting and actions because when a new key is generated on restart, existing encrypted data becomes inaccessible. For the same reason, alerting and actions in high-availability deployments of Kibana will behave unexpectedly if the key isn't the same on all instances of Kibana.

Although the key can be specified in clear text in kibana.yml, it's recommended to store this key securely in the Kibana Keystore. Be sure to back up the encryption key value somewhere safe, as your alerting rules and actions will cease to function due to decryption failures should you lose it. If you want to rotate the encryption key, be sure to follow the instructions on encryption key rotation.

Datatype: string

Action settings

xpack.actions.allowedHosts

Supported on:

A list of hostnames that Kibana is allowed to connect to when built-in actions are triggered. It defaults to ["*"], allowing any host, but keep in mind the potential for SSRF attacks when hosts are not explicitly added to the allowed hosts. An empty list [] can be used to block built-in actions from making any external connections.

Note that hosts associated with built-in actions, such as Slack and PagerDuty, are not automatically added to allowed hosts. If you are not using the default ["*"] setting, you must ensure that the corresponding endpoints are added to the allowed hosts as well.

Datatype: string

xpack.actions.customHostSettings

Supported on:

A list of custom host settings to override existing global settings.

Each entry in the list must have a url property, to associate a connection type (mail or https), hostname and port with the remaining options in the entry.

The settings in xpack.actions.customHostSettings can be used to override the global option xpack.actions.ssl.verificationMode and provide customized TLS settings on a per-server basis. Set xpack.actions.ssl.verificationMode to the value to be used by default for all servers, then add an entry in xpack.actions.customHostSettings for every server that requires customized settings.

Datatype: string

Default: an empty list

In the following example, two custom host settings are defined. The first provides a custom host setting for mail server mail.example.com using port 465 that supplies server certificate authentication data from both a file and inline, and requires TLS for the connection. The second provides a custom host setting for https server webhook.example.com which turns off server certificate authentication, that will allow Kibana to connect to the server if it's using a self-signed certificate. The individual properties that can be used in the settings are documented below.

xpack.actions.customHostSettings:
    - url: smtp://mail.example.com:465
      ssl:
        verificationMode: 'full'
        certificateAuthoritiesFiles: [ 'one.crt' ]
        certificateAuthoritiesData: |
            -----BEGIN CERTIFICATE-----
            MIIDTD...
            CwUAMD...
            ... multiple lines of certificate data ...
            -----END CERTIFICATE-----
            -----BEGIN CERTIFICATE-----
            MIIDTD...
            CwUAMD...
            ... multiple lines of certificate data ...
            -----END CERTIFICATE-----
        smtp:
          requireTLS: true
    - url: <EXAMPLE_WEBHOOK_URL>
      ssl:
        verificationMode: 'none'
xpack.actions.customHostSettings[n].url

Supported on:

A URL associated with this custom host setting. Should be in the form of protocol://hostname:port, where protocol is https or smtp. If the port is not provided, 443 is used for https and 25 is used for smtp. The smtp URLs are used for the Email actions that use this server, and the https URLs are used for actions which use https to connect to services.

Entries with https URLs can use the ssl options, and entries with smtp URLs can use both the ssl and smtp options.

No other URL values should be part of this URL, including paths, query strings, and authentication information. When an http or smtp request is made as part of running an action, only the protocol, hostname, and port of the URL for that request are used to look up these configuration values.

Datatype: string

xpack.actions.customHostSettings[n].smtp.ignoreTLS

Supported on:

A boolean value indicating that TLS must not be used for this connection. The options smtp.ignoreTLS and smtp.requireTLS can not both be set to true.

Datatype: bool

Default: false

xpack.actions.customHostSettings[n].smtp.requireTLS

Supported on:

A boolean value indicating that TLS must be used for this connection. The options smtp.ignoreTLS and smtp.requireTLS can not both be set to true.

Datatype: bool

Default: false

xpack.actions.customHostSettings[n].ssl.verificationMode

Supported on:

Controls the verification of the server certificate that Kibana receives when making an outbound SSL/TLS connection to the host server. Valid values are full, certificate, and none. Use full to perform hostname verification, certificate to skip hostname verification, and none to skip verification. Default: full. Equivalent Kibana setting. Overrides the general xpack.actions.ssl.verificationMode configuration for requests made for this hostname/port.

Datatype: enum

Default: full

Options:

  • full
  • certificate
  • none
xpack.actions.customHostSettings[n].ssl.certificateAuthoritiesFiles

Supported on:

A file name or list of file names of PEM-encoded certificate files to use to validate the server.

Datatype: string

xpack.actions.customHostSettings[n].ssl.certificateAuthoritiesData

Supported on:

The contents of one or more PEM-encoded certificate files in multiline format. This configuration can be used for environments where the files cannot be made available.

Datatype: string

xpack.actions.email.domain_allowlist

Supported on:

A list of allowed email domains which can be used with the email connector. When this setting is not used, all email domains are allowed. When this setting is used, if any email is attempted to be sent that (a) includes an addressee with an email domain that is not in the allowlist, or (b) includes a from address domain that is not in the allowlist, it will fail with a message indicating the email is not allowed.

Datatype: string

Warning

This feature is available in Kibana 7.17.4 and 8.3.0 onwards but is not supported in Kibana 8.0, 8.1 or 8.2. As such, this setting should be removed before upgrading from 7.17 to 8.0, 8.1 or 8.2. It is possible to configure the settings in 7.17.4 and then upgrade to 8.3.0 directly.

xpack.actions.email.recipient_allowlist

Supported on:

A list of allowed email recipient patterns (to, cc, or bcc) that can be used with email connectors. If you attempt to send an email to a recipient that does not match the allowed patterns, the action will fail. The failure message indicates that the email is not allowed.

Datatype: string

Warning

This setting cannot be used with xpack.actions.email.domain_allowlist.

For example:

xpack.actions.email.recipient_allowlist: ["admin-*@company.org", "sales-*@example.com"]

Only "to", "cc", or "bcc" email addresses that match the listed patterns will be accepted. For example, "admin-network@company.org" or "sales-north@example.com".

xpack.actions.email.maximum_body_length

Supported on:

The maximum length of an email body in bytes. Values longer than this length will be truncated. The default is 25MB, the maximum is 25MB.

Datatype: int

Default: 25000000 (25MB)

xpack.actions.email.services.ses.host

Supported on:

The SMTP endpoint for an Amazon Simple Email Service (SES) service provider that can be used by email connectors.

Datatype: string

Default: email-smtp.us-east-1.amazonaws.com

Warning

This setting alone is insufficient for overriding system defaults for the SES SMTP endpoint. You must also configure the xpack.actions.email.services.ses.port setting.

xpack.actions.email.services.ses.port

Supported on:

The port number for an Amazon Simple Email Service (SES) service provider that can be used by email connectors.

Datatype: int

Default: 465

xpack.actions.email.services.enabled

Supported on:

An array of strings indicating all email services that are enabled. Available options are elastic-cloud, google-mail, microsoft-outlook, amazon-ses, microsoft-exchange, and other. If the array is empty, no email services are enabled. The default value is ["*"], which enables all email services.

Datatype: string

Default: ["*"]

xpack.actions.enableFooterInEmail

Supported on:

A boolean value indicating that a footer with a relevant link should be added to emails sent as alerting actions.

Datatype: bool

Default: true

xpack.actions.enabledActionTypes

Supported on:

A list of action types that are enabled. It defaults to ["*"], enabling all types. The names for built-in Kibana action types are prefixed with a . and include: .email, .index, .jira, .opsgenie, .pagerduty, .resilient, .server-log, .servicenow, .servicenow-itom, .servicenow-sir, .slack, .swimlane, .teams, .tines, .torq, .xmatters, .gen-ai, .bedrock, .gemini, .d3security, and .webhook. An empty list [] will disable all action types.

Disabled action types will not appear as an option when creating new connectors, but existing connectors and actions of that type will remain in Kibana and will not function.

Datatype: string

Default: ["*"]

Important

Preconfigured connectors are not affected by this setting.

xpack.actions.microsoftExchangeUrl

Supported on:

The URL for the Microsoft Azure Active Directory endpoint to use for MS Exchange email authentication.

Datatype: string

Default: https://login.microsoftonline.com

xpack.actions.microsoftGraphApiUrl

Supported on:

The URL for the Microsoft Graph API endpoint to use for MS Exchange email authentication.

Datatype: string

Default: https://graph.microsoft.com/v1.0

xpack.actions.microsoftGraphApiScope

Supported on:

The URL for the Microsoft Graph API scope endpoint to use for MS Exchange email authentication.

Datatype: string

Default: https://graph.microsoft.com/.default

xpack.actions.proxyUrl

Supported on:

Specifies the proxy URL to use, if using a proxy for actions. By default, no proxy is used.

Proxies may be used to proxy http or https requests through a proxy using the http or https protocol. Kibana only uses proxies in "CONNECT" mode (sometimes referred to as "tunneling" TCP mode, compared to HTTP mode). That is, Kibana will always make requests through a proxy using the HTTP CONNECT method.

If your proxy is using the https protocol (vs the http protocol), the setting xpack.actions.ssl.proxyVerificationMode: none will likely be needed, unless your proxy's certificates are signed using a publicly available certificate authority.

There is currently no support for using basic authentication with a proxy (authentication for the proxy itself, not the URL being requested through the proxy).

Datatype: string

To help diagnose problems using a proxy, you can use the curl command with options to use your proxy, and log debug information, with the following command, replacing the proxy and target URLs as appropriate. This will force the request to be made to the proxy in tunneling mode, and display some of the interaction between the client and the proxy.

curl --verbose --proxytunnel --proxy http://localhost:8080 <EXAMPLE_URL>
xpack.actions.proxyBypassHosts

Supported on:

Specifies hostnames which should not use the proxy, if using a proxy for actions. The value is an array of hostnames as strings.

By default, all hosts will use the proxy, but if an action's hostname is in this list, the proxy will not be used. The settings xpack.actions.proxyBypassHosts and xpack.actions.proxyOnlyHosts cannot be used at the same time.

Datatype: string

For example:

xpack.actions.proxyBypassHosts: [ "events.pagerduty.com" ]

If applicable, include the subdomain in the hostname.

xpack.actions.proxyOnlyHosts

Supported on:

Specifies hostnames which should only use the proxy, if using a proxy for actions. The value is an array of hostnames as strings.

By default, no hosts will use the proxy, but if an action's hostname is in this list, the proxy will be used. The settings xpack.actions.proxyBypassHosts and xpack.actions.proxyOnlyHosts cannot be used at the same time.

Datatype: string

For example:

xpack.actions.proxyOnlyHosts: [ "events.pagerduty.com" ]

If applicable, include the subdomain in the hostname.

xpack.actions.proxyHeaders

Supported on:

Specifies HTTP headers for the proxy, if using a proxy for actions.

Datatype: string

Default: {}

xpack.actions.ssl.proxyVerificationMode

Supported on:

Controls the verification for the proxy server certificate that Kibana receives when making an outbound SSL/TLS connection to the proxy server.

Use full to perform hostname verification, certificate to skip hostname verification, and none to skip verification.

Equivalent Kibana setting

Datatype: enum

Default: full

Options:

  • full
  • certificate
  • none
xpack.actions.ssl.verificationMode

Supported on:

Controls the verification for the server certificate that Elastic Maps Server receives when making an outbound SSL/TLS connection for actions. Valid values are full, certificate, and none. Use full to perform hostname verification, certificate to skip hostname verification, and none to skip verification.

Equivalent Kibana setting

This setting can be overridden for specific URLs by using the setting xpack.actions.customHostSettings[n].ssl.verificationMode (described above) to a different value.

Datatype: enum

Default: full

Options:

  • full
  • certificate
  • none
xpack.actions.maxResponseContentLength

Supported on:

Specifies the max number of bytes of the http response for requests to external resources.

Datatype: int

Default: 1000000 (1MB)

xpack.actions.responseTimeout

Supported on:

Specifies the time allowed for requests to external resources. Requests that take longer are canceled. The time is formatted as a number and a time unit (ms, s, m, h, d, w, M, or Y). For example, 20m, 24h, 7d, 1w. Default: 60s.

Datatype: string

xpack.actions.run.maxAttempts

Supported on:

Specifies the maximum number of times an action can be attempted to run.

Datatype: int

Options:

  • minimum 1 and maximum 10
xpack.actions.run.connectorTypeOverrides

Supported on:

Overrides the configs under xpack.actions.run for the connector type with the given ID. List the connector type identifier and its settings in an array of objects.

Datatype: string

For example:

xpack.actions.run:
    maxAttempts: 1
    connectorTypeOverrides:
        - id: '.server-log'
          maxAttempts: 5
xpack.actions.queued.max

Supported on:

Specifies the maximum number of actions that can be queued. It is available in Elastic Cloud 8.11.0 and later versions.

Datatype: int

Default: 1000000

Preconfigured connector settings

These settings vary depending on which type of preconfigured connector you're adding.

For example:

xpack.actions.preconfigured:
  my-server-log:
    name: preconfigured-server-log-connector-type
    actionTypeId: .server-log

For more examples, go to Preconfigured connectors.

xpack.actions.preconfiguredAlertHistoryEsIndex

Supported on:

Enables a preconfigured alert history Elasticsearch Index connector.

Datatype: bool

Default: false

xpack.actions.preconfigured

Supported on:

Specifies configuration details that are specific to the type of preconfigured connector.

Datatype: string

xpack.actions.preconfigured.<connector-id>.actionTypeId

Supported on:

The type of preconfigured connector.

Datatype: enum

Options:

  • .email
  • .index
  • .opsgenie
  • .server-log
  • .resilient
  • .slack
  • .webhook
xpack.actions.preconfigured.<connector-id>.config

Supported on:

The configuration details, which are specific to the type of preconfigured connector.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.apiProvider

Supported on:

For a OpenAI connector, specifies the OpenAI API provider.

Datatype: enum

Options:

  • OpenAI
  • Azure OpenAI
xpack.actions.preconfigured.<connector-id>.config.apiUrl

Supported on:

A configuration URL that varies by connector:

Datatype: string

Note

If you are using the xpack.actions.allowedHosts setting, make sure the hostname in the URL is added to the allowed hosts.

xpack.actions.preconfigured.<connector-id>.config.appId

Supported on:

An application ID that varies by connector:

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.clientId

Supported on:

A client identifier that varies by connector:

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.configUrl

Supported on:

For an xMatters connector with basic authentication, specifies the request URL for the Elastic Alerts trigger in xMatters.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.createCommentJson

Supported on:

For a Webhook - Case Management connector, specifies a stringified JSON payload with Mustache variables that is sent to the create comment URL to create a case comment. The required variable is case.description.

Datatype: string

Note

The JSON is validated after the Mustache variables have been placed when the REST method runs. You should manually ensure that the JSON is valid, disregarding the Mustache variables, so the later validation will pass.

xpack.actions.preconfigured.<connector-id>.config.createCommentMethod

Supported on:

For a Webhook - Case Management connector, specifies the REST API HTTP request method to create a case comment in the third-party system.

Datatype: string

Default: put

Options:

  • post
  • put
  • patch
xpack.actions.preconfigured.<connector-id>.config.createCommentUrl

Supported on:

For a Webhook - Case Management connector, specifies a REST API URL string to create a case comment by ID in the third-party system.

Datatype: string

Note

If you are using the xpack.actions.allowedHosts setting, make sure the hostname in the URL is added to the allowed hosts.

xpack.actions.preconfigured.<connector-id>.config.createIncidentJson

Supported on:

For a Webhook - Case Management connector, specifies a stringified JSON payload with Mustache variables that is sent to the create case URL to create a case. Required variables are case.title and case.description.

Datatype: string

Note

The JSON is validated after the Mustache variables have been placed when the REST method runs. You should manually ensure that the JSON is valid, disregarding the Mustache variables, so the later validation will pass.

xpack.actions.preconfigured.<connector-id>.config.createIncidentMethod

Supported on:

For a Webhook - Case Management connector, specifies the REST API HTTP request method to create a case in the third-party system.

Datatype: string

Default: post

Options:

  • post
  • put
  • patch
xpack.actions.preconfigured.<connector-id>.config.createIncidentUrl

Supported on:

For a Webhook - Case Management connector, specifies a REST API URL string to create a case in the third-party system.

Datatype: string

Note

If you are using the xpack.actions.allowedHosts setting, make sure the hostname in the URL is added to the allowed hosts.

xpack.actions.preconfigured.<connector-id>.config.createIncidentResponseKey

Supported on:

For a Webhook - Case Management connector, specifies a string from the response body of the create case method that corresponds to the external service identifier.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.defaultModel

Supported on:

The default model to use for requests, which varies by connector:

  • For an Amazon Bedrock connector, current support is for the Anthropic Claude models.
    • Defaults to us.anthropic.claude-sonnet-4-5-20250929-v1:0.
    • Defaults to us.anthropic.claude-sonnet-4-5-20250929-v1:0.
    • Defaults to us.anthropic.claude-3-7-sonnet-20250219-v1:0.
    • Defaults to anthropic.claude-3-5-sonnet-20240620-v1:0.
  • For a Google Gemini connector, current support is for the Gemini models.
    • Defaults to gemini-2.5-pro.
    • Defaults to gemini-2.5-pro.
    • Defaults to gemini-1.5-pro-002.
  • For a OpenAI connector, it is optional and applicable only when xpack.actions.preconfigured.<connector-id>.config.apiProvider is OpenAI.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.executionTimeField

Supported on:

For an index connector, a field that indicates when the document was indexed.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.from

Supported on:

For an email connector, specifies the from address for all emails sent by the connector. It must be specified in user@host-name format.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.getIncidentResponseExternalTitleKey

Supported on:

For a Webhook - Case Management connector, specifies a string from the response body of the get case method that corresponds to the external service title.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.getIncidentUrl

Supported on:

For a Webhook - Case Management connector, specifies a REST API URL string with an external service ID Mustache variable to get the case from the third-party system.

Datatype: string

Note

If you are using the xpack.actions.allowedHosts setting, make sure the hostname in the URL is added to the allowed hosts.

xpack.actions.preconfigured.<connector-id>.config.hasAuth

Supported on:

For an email, webhook, or Webhook - Case Management connector, specifies whether a user and password are required inside the secrets configuration.

Datatype: bool

Default: true

xpack.actions.preconfigured.<connector-id>.config.headers

Supported on:

For a webhook or Webhook - Case Management connector, specifies a set of key-value pairs sent as headers with the request.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.host

Supported on:

For an email connector, specifies the host name of the service provider.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.index

Supported on:

For an index connector, specifies the Elasticsearch index.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.isOAuth

Supported on:

For a ServiceNow ITSM, ServiceNow SecOps, or ServiceNow ITOM connector, specifies whether to use basic or OAuth authentication.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.jwtKeyId

Supported on:

For a ServiceNow ITSM, ServiceNow SecOps, or ServiceNow ITOM connector, specifies the key ID assigned to the JWT verifier map of your OAuth application. It is required when xpack.actions.preconfigured.<connector-id>.config.isOAuth is true.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.mappings

Supported on:

For a Swimlane connector, specifies field mappings.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.mappings.alertIdConfig

Supported on:

For a Swimlane connector, field mapping for the alert identifier. You must provide fieldtype, id, key, and name values.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.mappings.caseIdConfig

Supported on:

For a Swimlane connector, field mapping for the case identifier. You must provide fieldtype, id, key, and name values.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.mappings.caseNameConfig

Supported on:

For a Swimlane connector, field mapping for the case name. You must provide fieldtype, id, key, and name values.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.mappings.commentsConfig

Supported on:

For a Swimlane connector, field mapping for the case comments. You must provide fieldtype, id, key, and name values.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.mappings.descriptionConfig

Supported on:

For a Swimlane connector, field mapping for the case description. You must provide fieldtype, id, key, and name values.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.mappings.ruleNameConfig

Supported on:

For a Swimlane connector, field mapping for the rule name. You must provide fieldtype, id, key, and name values.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.mappings.severityConfig

Supported on:

For a Swimlane connector, specifies a field mapping for the severity. You must provide fieldtype, id, key, and name values.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.method

Supported on:

For a webhook connector, specifies the HTTP request method, either post or put. Defaults to post.

Datatype: enum

Default: post

Options:

  • post
  • put
xpack.actions.preconfigured.<connector-id>.config.orgId

Supported on:

For an IBM Resilient connector, specifies the IBM Resilient organization identifier.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.port

Supported on:

For an email connector, specifies the port to connect to on the service provider.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.projectKey

Supported on:

For a Jira connector, specifies the Jira project key.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.secure

Supported on:

For an email connector, specifies whether the connection will use TLS when connecting to the service provider. If not true, the connection will initially connect over TCP then attempt to switch to TLS via the SMTP STARTTLS command.

Datatype: bool

xpack.actions.preconfigured.<connector-id>.config.service

Supported on:

For an email connector, specifies the name of the email service. For example, elastic_cloud, exchange_server, gmail, other, outlook365, or ses.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.tenantId

Supported on:

For an email connector, specifies a GUID format value that corresponds to a tenant ID, which is a part of OAuth 2.0 client credentials authentication.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.updateIncidentJson

Supported on:

For a Webhook - Case Management connector, specifies a stringified JSON payload with Mustache variables that is sent to the update case URL to update a case. Required variables are case.title and case.description.

Datatype: string

Note

The JSON is validated after the Mustache variables have been placed when the REST method runs. You should manually ensure that the JSON is valid, disregarding the Mustache variables, so the later validation will pass.

xpack.actions.preconfigured.<connector-id>.config.updateIncidentMethod

Supported on:

For a Webhook - Case Management connector, specifies the REST API HTTP request method to update the case in the third-party system.

Datatype: enum

Default: put

Options:

  • post
  • put
  • patch
xpack.actions.preconfigured.<connector-id>.config.updateIncidentUrl

Supported on:

For a Webhook - Case Management connector, specifies the REST API URL to update the case by ID in the third-party system.

Datatype: string

Note

If you are using the xpack.actions.allowedHosts setting, make sure the hostname in the URL is added to the allowed hosts.

xpack.actions.preconfigured.<connector-id>.config.url

Supported on:

A configuration URL that varies by connector:

Datatype: string

Note

If you are using the xpack.actions.allowedHosts setting, make sure this hostname is added to the allowed hosts.

xpack.actions.preconfigured.<connector-id>.config.userIdentifierValue

Supported on:

For a ServiceNow ITSM, ServiceNow SecOps, or ServiceNow ITOM connector, specifies the user identifier. It is required when xpack.actions.preconfigured.<connector-id>.config.isOAuth is true.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.usesBasic

Supported on:

For an xMatters connector, specifies whether it uses HTTP basic authentication.

Datatype: bool

Default: true

xpack.actions.preconfigured.<connector-id>.config.usesTableApi

Supported on:

For a ServiceNow ITSM or ServiceNow SecOps connector, specifies whether the connector uses the Table API or the Import Set API. If set to false, the Elastic application should be installed in ServiceNow.

Datatype: bool

xpack.actions.preconfigured.<connector-id>.config.viewIncidentUrl

Supported on:

For a Webhook - Case Management connector, specifies a URL string with either the external service ID or external service title Mustache variable to view a case in the external system.

Datatype: string

xpack.actions.preconfigured.<connector-id>.config.webhookIntegrationUrl

Supported on:

For a Torq connector, specifies the endpoint URL of the Elastic Security integration in Torq.

Datatype: string

xpack.actions.preconfigured.<connector-id>.name

Supported on:

The name of the preconfigured connector.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets

Supported on:

Sensitive configuration details, such as username, password, and keys, which are specific to the connector type.

Datatype: string

Tip

Sensitive properties, such as passwords, should be stored in the Kibana keystore.

xpack.actions.preconfigured.<connector-id>.secrets.accessKey

Supported on:

For an Amazon Bedrock connector, specifies the AWS access key for authentication.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.apikey

Supported on:

An API key secret that varies by connector.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.credentialsJson

Supported on:

A credentials secret that varies by connector:

  • For a Google Gemini connector, specifies the GCP service account credentials JSON file for authentication.
  • For a OpenAI connector, specifies the OpenAI or Azure OpenAI API key for authentication.
  • For an Opsgenie connector, specifies the Opsgenie API authentication key for HTTP basic authentication.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.apiKeyId

Supported on:

For an IBM Resilient connector, specifies the authentication key ID for HTTP basic authentication.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.apiKeySecret

Supported on:

For an IBM Resilient connector, specifies the authentication key secret for HTTP basic authentication.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.apiToken

Supported on:

For a Jira or Swimlane connector, specifies the API authentication token for HTTP basic authentication.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.clientSecret

Supported on:

A client secret that varies by connector:

  • For an email connector, specifies the client secret that you generated for your app in the app registration portal. It is required when the email service is exchange_server, which uses OAuth 2.0 client credentials authentication.
  • For a ServiceNow ITSM, ServiceNow SecOps, or ServiceNow ITOM connector, specifies the client secret assigned to the OAuth application. It is required when xpack.actions.preconfigured.<connector-id>.config.isOAuth is true.

Datatype: string

Note

The client secret must be URL-encoded.

xpack.actions.preconfigured.<connector-id>.secrets.email

Supported on:

An email address that varies by connector:

  • For a Jira connector, specifies the account email for HTTP basic authentication.
  • For a Tines connector, specifies the email used to sign in to Tines.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.password

Supported on:

A password secret that varies by connector:

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.privateKey

Supported on:

For a ServiceNow ITSM, ServiceNow SecOps, or ServiceNow ITOM connector, specifies the RSA private key. It is required when xpack.actions.preconfigured.<connector-id>.config.isOAuth is true.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.privateKeyPassword

Supported on:

For a ServiceNow ITSM, ServiceNow SecOps, or ServiceNow ITOM connector, specifies the password for the RSA private key.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.routingKey

Supported on:

For a PagerDuty connector, specifies the 32 character PagerDuty Integration Key for an integration on a service, also referred to as the routing key.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.secret

Supported on:

For an Amazon Bedrock connector, specifies the AWS secret for authentication.

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.secretsUrl

Supported on:

For an xMatters connector with URL authentication, specifies the request URL for the Elastic Alerts trigger in xMatters with the API key included in the URL. It is used only when xpack.actions.preconfigured.<connector-id>.config.usesBasic is false.

Datatype: string

Note

If you are using the xpack.actions.allowedHosts setting, make sure this hostname is added to the allowed hosts.

xpack.actions.preconfigured.<connector-id>.secrets.token

Supported on:

A token secret that varies by connector:

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.user

Supported on:

A user name secret that varies by connector:

Datatype: string

xpack.actions.preconfigured.<connector-id>.secrets.webhookUrl

Supported on:

A URL that varies by connector:

Datatype: string

Note

If you are using the xpack.actions.allowedHosts setting, make sure the hostname is added to the allowed hosts.

xpack.actions.preconfigured.<connector-id>.secrets.username

Supported on:

For a ServiceNow ITSM, ServiceNow SecOps, or ServiceNow ITOM connector, specifies a user name that is required when xpack.actions.preconfigured.<connector-id>.config.isOAuth is false.

Datatype: string

xpack.actions.webhook.ssl.pfx.enabled

Supported on:

Disable PFX file support for SSL client authentication. When set to false, the application will not accept PFX certificate files and will require separate certificate and private key files instead. Only applies to the Webhook connector.

Datatype: bool

Default: true

Alerting settings

xpack.alerting.cancelAlertsOnRuleTimeout

Supported on:

Specifies whether to skip writing alerts and scheduling actions if rule processing was cancelled due to a timeout. This setting can be overridden by individual rule types.

Datatype: bool

Default: true

xpack.alerting.rules.maxScheduledPerMinute

Supported on:

Specifies the maximum number of rules to run per minute.

Datatype: int

Default: 32000

Note

In Serverless, the maximum number of rules to run per minute is set to 800 for Elastic Security projects and 400 for other projects. This setting can't be configured.

xpack.alerting.rules.minimumScheduleInterval.value

Supported on:

Specifies the minimum schedule interval for rules. This minimum is applied to all rules created or updated after you set this value. The time is formatted as a number and a time unit (s, m, h, or d). For example, 20m, 24h, 7d. This duration cannot exceed 1d.

Datatype: string

Default: 1m

xpack.alerting.rules.minimumScheduleInterval.enforce

Supported on:

Specifies the behavior when a new or changed rule has a schedule interval less than the value defined in xpack.alerting.rules.minimumScheduleInterval.value. If false, rules with schedules less than the interval will be created but warnings will be logged. If true, rules with schedules less than the interval cannot be created.

Datatype: bool

Default: false

xpack.alerting.rules.run.actions.max

Supported on:

Specifies the maximum number of actions that a rule can generate each time detection checks run.

Datatype: int

xpack.alerting.rules.run.alerts.max

Supported on:

Specifies the maximum number of alerts that a rule can generate each time detection checks run.

Datatype: int

Default: 1000

Warning

The exact number of alerts your cluster can safely handle depends on your cluster configuration and workload. While it is technically possible to increase this value above 1000, doing so is not recommended and not supported. Increasing this limit can significantly affect Kibana and Elasticsearch performance and memory usage. Carefully evaluate the impact on your deployment before making this change.

xpack.alerting.rules.run.timeout

Supported on:

Specifies the default timeout for tasks associated with all types of rules. The time is formatted as a number and a time unit (ms, s, m, h, d, w, M, or Y). For example, 20m, 24h, 7d, 1w. Default: 5m.

Datatype: string

xpack.alerting.rules.run.ruleTypeOverrides

Supported on:

Overrides the configs under xpack.alerting.rules.run for the rule type with the given ID. List the rule identifier and its settings in an array of objects.

Datatype: string

For example:

xpack.alerting.rules.run:
    timeout: '5m'
    ruleTypeOverrides:
        - id: '.index-threshold'
          timeout: '15m'
xpack.alerting.rules.run.actions.connectorTypeOverrides

Supported on:

Overrides the configs under xpack.alerting.rules.run.actions for the connector type with the given ID. List the connector type identifier and its settings in an array of objects.

Datatype: string

For example:

xpack.alerting.rules.run:
    actions:
        max: 10
        connectorTypeOverrides:
            - id: '.server-log'
              max: 5