Responses

• 200 application/json

  Indicates a successful call.

  Hide response attributes Show response attributes object

  • alerting_framework_health object

    Three substates identify the health of the alerting framework: decryption_health, execution_health, and read_health.

    Hide alerting_framework_health attributes Show alerting_framework_health attributes object

    • decryption_health object

      The timestamp and status of the rule decryption.

      Hide decryption_health attributes Show decryption_health attributes object

      • status string

        Values are error, ok, or warn.

      • timestamp string(date-time)
    • execution_health object

      The timestamp and status of the rule run.

      Hide execution_health attributes Show execution_health attributes object

      • status string

        Values are error, ok, or warn.

      • timestamp string(date-time)
    • read_health object

      The timestamp and status of the rule reading events.

      Hide read_health attributes Show read_health attributes object

      • status string

        Values are error, ok, or warn.

      • timestamp string(date-time)
  • has_permanent_encryption_key boolean

    If false, the encrypted saved object plugin does not have a permanent encryption key.

  • is_sufficiently_secure boolean

    If false, security is enabled but TLS is not.

• 401 application/json

  Authorization information is missing or invalid.

  Hide response attributes Show response attributes object

  • error string

    Value is Unauthorized.

  • message string
  • statusCode integer

    Value is 401.

Responses

• 200 application/json

  Indicates a successful call.

  Hide response attributes Show response attributes object

  • action_groups array[object]

    An explicit list of groups for which the rule type can schedule actions, each with the action group's unique ID and human readable name. Rule actions validation uses this configuration to ensure that groups are valid.

    Hide action_groups attributes Show action_groups attributes object

    • id string
    • name string
  • action_variables object

    A list of action variables that the rule type makes available via context and state in action parameter templates, and a short human readable description. When you create a rule in Kibana, it uses this information to prompt you for these variables in action parameter editors.

    Hide action_variables attributes Show action_variables attributes object

    • context array[object]
      Hide context attributes Show context attributes object

      • description string
      • name string
      • useWithTripleBracesInTemplates boolean
    • params array[object]
      Hide params attributes Show params attributes object

      • description string
      • name string
    • state array[object]
      Hide state attributes Show state attributes object

      • description string
      • name string
  • alerts object

    Details for writing alerts as data documents for this rule type.

    Hide alerts attributes Show alerts attributes object

    • context string

      The namespace for this rule type.

      Values are ml.anomaly-detection, observability.apm, observability.logs, observability.metrics, observability.slo, observability.threshold, observability.uptime, security, or stack.

    • dynamic string

      Indicates whether new fields are added dynamically.

      Values are false, runtime, strict, or true.

    • isSpaceAware boolean

      Indicates whether the alerts are space-aware. If true, space-specific alert indices are used.

    • mappings object
      Hide mappings attribute Show mappings attribute object

      • fieldMap object

        Mapping information for each field supported in alerts as data documents for this rule type. For more information about mapping parameters, refer to the Elasticsearch documentation.

        Hide fieldMap attribute Show fieldMap attribute object

        • * object Additional properties
          Hide * attributes Show * attributes object

          • array boolean

            Indicates whether the field is an array.

          • dynamic boolean

            Indicates whether it is a dynamic field mapping.

          • format string

            Indicates the format of the field. For example, if the type is date_range, the format can be epoch_millis||strict_date_optional_time.

          • ignore_above integer

            Specifies the maximum length of a string field. Longer strings are not indexed or stored.

          • index boolean

            Indicates whether field values are indexed.

          • path string

            TBD

          • properties object

            Details about the object properties. This property is applicable when type is object.

            Hide properties attribute Show properties attribute object

            • * object Additional properties
              Hide * attribute Show * attribute object

              • type string

                The data type for each object property.

          • required boolean

            Indicates whether the field is required.

          • scaling_factor integer

            The scaling factor to use when encoding values. This property is applicable when type is scaled_float. Values will be multiplied by this factor at index time and rounded to the closest long value.

          • type string

            Specifies the data type for the field.

    • secondaryAlias string

      A secondary alias. It is typically used to support the signals alias for detection rules.

    • shouldWrite boolean

      Indicates whether the rule should write out alerts as data.

    • useEcs boolean

      Indicates whether to include the ECS component template for the alerts.

    • useLegacyAlerts boolean

      Indicates whether to include the legacy component template for the alerts.

      Default value is false.

  • authorized_consumers object

    The list of the plugins IDs that have access to the rule type.

    Hide authorized_consumers attributes Show authorized_consumers attributes object

    • alerts object
      Hide alerts attributes Show alerts attributes object

      • all boolean
      • read boolean
    • apm object
      Hide apm attributes Show apm attributes object

      • all boolean
      • read boolean
    • discover object
      Hide discover attributes Show discover attributes object

      • all boolean
      • read boolean
    • infrastructure object
      Hide infrastructure attributes Show infrastructure attributes object

      • all boolean
      • read boolean
    • logs object
      Hide logs attributes Show logs attributes object

      • all boolean
      • read boolean
    • ml object
      Hide ml attributes Show ml attributes object

      • all boolean
      • read boolean
    • monitoring object
      Hide monitoring attributes Show monitoring attributes object

      • all boolean
      • read boolean
    • siem object
      Hide siem attributes Show siem attributes object

      • all boolean
      • read boolean
    • slo object
      Hide slo attributes Show slo attributes object

      • all boolean
      • read boolean
    • stackAlerts object
      Hide stackAlerts attributes Show stackAlerts attributes object

      • all boolean
      • read boolean
    • uptime object
      Hide uptime attributes Show uptime attributes object

      • all boolean
      • read boolean
  • category string

    The rule category, which is used by features such as category-specific maintenance windows.

    Values are management, observability, or securitySolution.

  • default_action_group_id string

    The default identifier for the rule type group.

  • does_set_recovery_context boolean

    Indicates whether the rule passes context variables to its recovery action.

  • enabled_in_license boolean

    Indicates whether the rule type is enabled or disabled based on the subscription.

  • has_alerts_mappings boolean

    Indicates whether the rule type has custom mappings for the alert data.

  • has_fields_for_a_a_d boolean
  • id string

    The unique identifier for the rule type.

  • is_exportable boolean

    Indicates whether the rule type is exportable in Stack Management > Saved Objects.

  • minimum_license_required string

    The subscriptions required to use the rule type.

  • name string

    The descriptive name of the rule type.

  • producer string

    An identifier for the application that produces this rule type.

  • recovery_action_group object

    An action group to use when an alert goes from an active state to an inactive one.

    Hide recovery_action_group attributes Show recovery_action_group attributes object

    • id string
    • name string
  • rule_task_timeout string
• 401 application/json

  Authorization information is missing or invalid.

  Hide response attributes Show response attributes object

  • error string

    Value is Unauthorized.

  • message string
  • statusCode integer

    Value is 401.

Path parameters

• id string Required

  The identifier for the rule.

Responses

• 200 application/json

  Indicates a successful call.

  Hide response attributes Show response attributes object

  • actions array[object] Required
    Hide actions attributes Show actions attributes object

    • alerts_filter object

      Defines a period that limits whether the action runs.

      Additional properties are NOT allowed.

      Hide alerts_filter attributes Show alerts_filter attributes object

      • query object

        Additional properties are NOT allowed.

        Hide query attributes Show query attributes object

        • dsl string

          A filter written in Elasticsearch Query Domain Specific Language (DSL).

        • filters array[object] Required

          A filter written in Elasticsearch Query Domain Specific Language (DSL) as defined in the kbn-es-query package.

          Hide filters attributes Show filters attributes object

          • $state object

            Additional properties are NOT allowed.

            Hide $state attribute Show $state attribute object

            • store string Required

              A filter can be either specific to an application context or applied globally.

              Values are appState or globalState.

          • meta object Required

            Additional properties are allowed.

          • query object

            Additional properties are allowed.

        • kql string Required

          A filter written in Kibana Query Language (KQL).

      • timeframe object

        Additional properties are NOT allowed.

        Hide timeframe attributes Show timeframe attributes object

        • days array[integer] Required

          Defines the days of the week that the action can run, represented as an array of numbers. For example, 1 represents Monday. An empty array is equivalent to specifying all the days of the week.

          Values are 1, 2, 3, 4, 5, 6, or 7.

        • hours object Required

          Additional properties are NOT allowed.

          Hide hours attributes Show hours attributes object

          • end string Required

            The end of the time frame in 24-hour notation (hh:mm).

          • start string Required

            The start of the time frame in 24-hour notation (hh:mm).

        • timezone string Required

          The ISO time zone for the hours values. Values such as UTC and UTC+1 also work but lack built-in daylight savings time support and are not recommended.

    • connector_type_id string Required

      The type of connector. This property appears in responses but cannot be set in requests.

    • frequency object

      Additional properties are NOT allowed.

      Hide frequency attributes Show frequency attributes object

      • notify_when string Required

        Indicates how often alerts generate actions. Valid values include: onActionGroupChange: Actions run when the alert status changes; onActiveAlert: Actions run when the alert becomes active and at each check interval while the rule conditions are met; onThrottleInterval: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. NOTE: You cannot specify notify_when at both the rule and action level. The recommended method is to set it for each action. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values.

        Values are onActionGroupChange, onActiveAlert, or onThrottleInterval.

      • summary boolean Required

        Indicates whether the action is a summary.

      • throttle string | null Required

        The throttle interval, which defines how often an alert generates repeated actions. It is specified in seconds, minutes, hours, or days and is applicable only if 'notify_when' is set to 'onThrottleInterval'. NOTE: You cannot specify the throttle interval at both the rule and action level. The recommended method is to set it for each action. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values.

    • group string

      The group name, which affects when the action runs (for example, when the threshold is met or when the alert is recovered). Each rule type has a list of valid action group names. If you don't need to group actions, set to default.

    • id string Required

      The identifier for the connector saved object.

    • params object Required

      The parameters for the action, which are sent to the connector. The params are handled as Mustache templates and passed a default set of context.

      Additional properties are allowed.

    • use_alert_data_for_template boolean

      Indicates whether to use alert data as a template.

    • uuid string

      A universally unique identifier (UUID) for the action.

  • active_snoozes array[string]

    List of active snoozes for the rule.

  • alert_delay object

    Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.

    Additional properties are NOT allowed.

    Hide alert_delay attribute Show alert_delay attribute object

    • active number Required

      The number of consecutive runs that must meet the rule conditions.

  • api_key_created_by_user boolean | null

    Indicates whether the API key that is associated with the rule was created by the user.

  • api_key_owner string | null Required

    The owner of the API key that is associated with the rule and used to run background tasks.

  • consumer string Required

    The name of the application or feature that owns the rule. For example: alerts, apm, discover, infrastructure, logs, metrics, ml, monitoring, securitySolution, siem, stackAlerts, or uptime.

  • created_at string Required

    The date and time that the rule was created.

  • created_by string | null Required

    The identifier for the user that created the rule.

  • enabled boolean Required

    Indicates whether you want to run the rule on an interval basis after it is created.

  • execution_status object Required

    Additional properties are NOT allowed.

    Hide execution_status attributes Show execution_status attributes object

    • error object

      Additional properties are NOT allowed.

      Hide error attributes Show error attributes object

      • message string Required

        Error message.

      • reason string Required

        Reason for error.

        Values are read, decrypt, execute, unknown, license, timeout, disabled, or validate.

    • last_duration number

      Duration of last execution of the rule.

    • last_execution_date string Required

      The date and time when rule was executed last.

    • status string Required

      Status of rule execution.

      Values are ok, active, error, warning, pending, or unknown.

    • warning object

      Additional properties are NOT allowed.

      Hide warning attributes Show warning attributes object

      • message string Required

        Warning message.

      • reason string Required

        Reason for warning.

        Values are maxExecutableActions, maxAlerts, maxQueuedActions, or ruleExecution.

  • flapping object | null

    When flapping detection is turned on, alerts that switch quickly between active and recovered states are identified as “flapping” and notifications are reduced.

    Additional properties are NOT allowed.

    Hide flapping attributes Show flapping attributes object | null

    • look_back_window number Required

      The minimum number of runs in which the threshold must be met.

      Minimum value is 2, maximum value is 20.

    • status_change_threshold number Required

      The minimum number of times an alert must switch states in the look back window.

      Minimum value is 2, maximum value is 20.

  • id string Required

    The identifier for the rule.

  • is_snoozed_until string | null

    The date when the rule will no longer be snoozed.

  • last_run object | null

    Additional properties are NOT allowed.

    Hide last_run attributes Show last_run attributes object | null

    • alerts_count object Required

      Additional properties are NOT allowed.

      Hide alerts_count attributes Show alerts_count attributes object

      • active number | null

        Number of active alerts during last run.

      • ignored number | null

        Number of ignored alerts during last run.

      • new number | null

        Number of new alerts during last run.

      • recovered number | null

        Number of recovered alerts during last run.

    • outcome string Required

      Outcome of last run of the rule. Value could be succeeded, warning or failed.

      Values are succeeded, warning, or failed.

    • outcome_msg array[string] | null

      Outcome message generated during last rule run.

    • outcome_order number

      Order of the outcome.

    • warning string | null

      Warning of last rule execution.

      Values are read, decrypt, execute, unknown, license, timeout, disabled, validate, maxExecutableActions, maxAlerts, maxQueuedActions, or ruleExecution.

  • mapped_params object

    Additional properties are allowed.

  • monitoring object

    Monitoring details of the rule.

    Additional properties are NOT allowed.

    Hide monitoring attribute Show monitoring attribute object

    • run object Required

      Rule run details.

      Additional properties are NOT allowed.

      Hide run attributes Show run attributes object

      • calculated_metrics object Required

        Calculation of different percentiles and success ratio.

        Additional properties are NOT allowed.

        Hide calculated_metrics attributes Show calculated_metrics attributes object

        • p50 number
        • p95 number
        • p99 number
        • success_ratio number Required
      • history array[object] Required

        History of the rule run.

        Hide history attributes Show history attributes object

        • duration number

          Duration of the rule run.

        • outcome string

          Outcome of last run of the rule. Value could be succeeded, warning or failed.

          Values are succeeded, warning, or failed.

        • success boolean Required

          Indicates whether the rule run was successful.

        • timestamp number Required

          Time of rule run.

      • last_run object Required

        Additional properties are NOT allowed.

        Hide last_run attributes Show last_run attributes object

        • metrics object Required

          Additional properties are NOT allowed.

          Hide metrics attributes Show metrics attributes object

          • duration number

            Duration of most recent rule run.

          • gap_duration_s number | null

            Duration in seconds of rule run gap.

          • gap_range object | null

            Additional properties are NOT allowed.

            Hide gap_range attributes Show gap_range attributes object | null

            • gte string Required

              End of the gap range.

            • lte string Required

              Start of the gap range.

          • total_alerts_created number | null

            Total number of alerts created during last rule run.

          • total_alerts_detected number | null

            Total number of alerts detected during last rule run.

          • total_indexing_duration_ms number | null

            Total time spent indexing documents during last rule run in milliseconds.

          • total_search_duration_ms number | null

            Total time spent performing Elasticsearch searches as measured by Kibana; includes network latency and time spent serializing or deserializing the request and response.

        • timestamp string Required

          Time of the most recent rule run.

  • mute_all boolean Required

    Indicates whether all alerts are muted.

  • muted_alert_ids array[string] Required

    List of identifiers of muted alerts.

  • name string Required

    The name of the rule.

  • next_run string | null

    Date and time of the next run of the rule.

  • notify_when string | null

    Indicates how often alerts generate actions. Valid values include: onActionGroupChange: Actions run when the alert status changes; onActiveAlert: Actions run when the alert becomes active and at each check interval while the rule conditions are met; onThrottleInterval: Actions run when the alert becomes active and at the interval specified in the throttle property while the rule conditions are met. NOTE: You cannot specify notify_when at both the rule and action level. The recommended method is to set it for each action. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values.

    Values are onActionGroupChange, onActiveAlert, or onThrottleInterval.

  • params object Required

    The parameters for the rule.

    Additional properties are allowed.

  • revision number Required

    The rule revision number.

  • rule_type_id string Required

    The rule type identifier.

  • running boolean | null

    Indicates whether the rule is running.

  • schedule object Required

    Additional properties are NOT allowed.

    Hide schedule attribute Show schedule attribute object

    • interval string Required

      The interval is specified in seconds, minutes, hours, or days.

  • scheduled_task_id string

    Identifier of the scheduled task.

  • snooze_schedule array[object]
    Hide snooze_schedule attributes Show snooze_schedule attributes object

    • duration number Required

      Duration of the rule snooze schedule.

    • id string

      Identifier of the rule snooze schedule.

    • rRule object Required

      Additional properties are NOT allowed.

      Hide rRule attributes Show rRule attributes object

      • byhour array[number] | null

        Indicates hours of the day to recur.

      • byminute array[number] | null

        Indicates minutes of the hour to recur.

      • bymonth array[number] | null

        Indicates months of the year that this rule should recur.

      • bymonthday array[number] | null

        Indicates the days of the month to recur.

      • bysecond array[number] | null

        Indicates seconds of the day to recur.

      • bysetpos array[number] | null

        A positive or negative integer affecting the nth day of the month. For example, -2 combined with byweekday of FR is 2nd to last Friday of the month. It is recommended to not set this manually and just use byweekday.

      • byweekday array[string | number] | null

        Indicates the days of the week to recur or else nth-day-of-month strings. For example, "+2TU" second Tuesday of month, "-1FR" last Friday of the month, which are internally converted to a byweekday/bysetpos combination.

      • byweekno array[number] | null

        Indicates number of the week hours to recur.

      • byyearday array[number] | null

        Indicates the days of the year that this rule should recur.

      • count number

        Number of times the rule should recur until it stops.

      • dtstart string Required

        Rule start date in Coordinated Universal Time (UTC).

      • freq integer

        Indicates frequency of the rule. Options are YEARLY, MONTHLY, WEEKLY, DAILY.

        Values are 0, 1, 2, 3, 4, 5, or 6.

      • interval number

        Indicates the interval of frequency. For example, 1 and YEARLY is every 1 year, 2 and WEEKLY is every 2 weeks.

      • tzid string Required

        Indicates timezone abbreviation.

      • until string

        Recur the rule until this date.

      • wkst string

        Indicates the start of week, defaults to Monday.

        Values are MO, TU, WE, TH, FR, SA, or SU.

    • skipRecurrences array[string]

      Skips recurrence of rule on this date.

  • tags array[string] Required

    The tags for the rule.

  • throttle string | null Deprecated

    Deprecated in 8.13.0. Use the throttle property in the action frequency object instead. The throttle interval, which defines how often an alert generates repeated actions. NOTE: You cannot specify the throttle interval at both the rule and action level. If you set it at the rule level then update the rule in Kibana, it is automatically changed to use action-specific values.

  • updated_at string Required

    The date and time that the rule was updated most recently.

  • updated_by string | null Required

    The identifier for the user that updated this rule most recently.

  • view_in_app_relative_url string | null

    Relative URL to view rule in the app.

• 400

  Indicates an invalid schema or parameters.

• 403

  Indicates that this call is forbidden.

• 404

  Indicates a rule with the given ID does not exist.