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.

Headers

• kbn-xsrf string Required

  A required header to protect against CSRF attacks

Path parameters

• id string Required

  The identifier for the rule.

Responses

• 204

  Indicates a successful call.

• 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.

Query parameters

• per_page number

  The number of rules to return per page.

  Minimum value is 0. Default value is 10.

• page number

  The page number to return.

  Minimum value is 1. Default value is 1.

• search string

  An Elasticsearch simple_query_string query that filters the objects in the response.

• default_search_operator string

  The default operator to use for the simple_query_string.

  Values are OR or AND. Default value is OR.

• search_fields array[string] | string

  The fields to perform the simple_query_string parsed query against.

• sort_field string

  Determines which field is used to sort the results. The field must exist in the attributes key of the response.

• sort_order string

  Determines the sort order.

  Values are asc or desc.

• has_reference object | null

  Filters the rules that have a relation with the reference objects with a specific type and identifier.

  Additional properties are NOT allowed.

  Hide has_reference attributes Show has_reference attributes object | null

  • id string Required
  • type string Required
• fields array[string]

  The fields to return in the attributes key of the response.

• filter string

  A KQL string that you filter with an attribute from your saved object. It should look like savedObjectType.attributes.title: "myTitle". However, if you used a direct attribute of a saved object, such as updatedAt, you must define your filter, for example, savedObjectType.updatedAt > 2018-12-22.

• filter_consumers array[string]

  List of consumers to filter.

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.

Headers

• elastic-api-version string Required

  The version of the API to use

  Value is 2023-10-31. Default value is 2023-10-31.

• kbn-xsrf string Required

  A required header to protect against CSRF attacks

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • _id string

    Identifier

  • _index string

    Index

  • _score number

    Score

  • _source object

    Agent configuration

    Additional properties are allowed.

    Hide _source attributes Show _source attributes object

    • @timestamp number Required

      Timestamp

    • agent_name string

      Agent name

    • applied_by_agent boolean

      Applied by agent

    • etag string Required

      Etag

    • service object Required

      Service

      Additional properties are allowed.

      Hide service attributes Show service attributes object

      • environment string

        Environment

      • name string

        Name

    • settings object Required

      Agent configuration settings

      Hide settings attribute Show settings attribute object

      • * string Additional properties
• 400 application/json

  Bad Request response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

• 401 application/json

  Unauthorized response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

• 404 application/json

  Not found response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

Headers

• elastic-api-version string Required

  The version of the API to use

  Value is 2023-10-31. Default value is 2023-10-31.

• kbn-xsrf string Required

  A required header to protect against CSRF attacks

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • body string
  • compressionAlgorithm string

    Compression Algorithm

  • created string

    Created date

  • decodedSha256 string

    Decoded SHA-256

  • decodedSize number

    Decoded size

  • encodedSha256 string

    Encoded SHA-256

  • encodedSize number

    Encoded size

  • encryptionAlgorithm string

    Encryption Algorithm

  • id string

    Identifier

  • identifier string

    Identifier

  • packageName string

    Package name

  • relative_url string

    Relative URL

  • type string

    Type

• 400 application/json

  Bad Request response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

• 401 application/json

  Unauthorized response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

• 403 application/json

  Forbidden response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

• 500 application/json

  Internal Server Error response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

• 501 application/json

  Not Implemented response

  Hide response attributes Show response attributes object

  • error string

    Error type

  • message string

    Error message

  • statusCode number

    Error status code

Path parameters

• caseId string Required

  The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded.

Responses

• 200 application/json

  Indicates a successful call.

  Hide response attributes Show response attributes object

  • assignees array[object] | null

    An array containing users that are assigned to the case.

    Not more than 10 elements.

    Hide assignees attribute Show assignees attribute object

    • uid string Required

      A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.

  • category string | null

    The case category.

  • closed_at string(date-time) | null Required
  • closed_by object | null Required

    Additional properties are allowed.

    Hide closed_by attributes Show closed_by attributes object | null

    • email string | null Required
    • full_name string | null Required
    • profile_uid string
    • username string | null Required
  • comments array[object] Required

    An array of comment objects for the case.

    Not more than 10000 elements.

    One of:

    Cases_alert_comment_response_properties object Cases_user_comment_response_properties object

    Hide attributes Show attributes

    • alertId array[string]
    • created_at string(date-time)
    • created_by object

      Additional properties are allowed.

      Hide created_by attributes Show created_by attributes object

      • email string | null Required
      • full_name string | null Required
      • profile_uid string
      • username string | null Required
    • id string
    • index array[string]
    • owner string

      The application that owns the cases: Stack Management, Observability, or Elastic Security.

      Values are cases, observability, or securitySolution.

    • pushed_at string(date-time) | null
    • pushed_by object | null

      Additional properties are allowed.

      Hide pushed_by attributes Show pushed_by attributes object | null

      • email string | null Required
      • full_name string | null Required
      • profile_uid string
      • username string | null Required
    • rule object

      Additional properties are allowed.

      Hide rule attributes Show rule attributes object

      • id string

        The rule identifier.

      • name string

        The rule name.

    • type string Required Discriminator

      Value is alert.

    • updated_at string(date-time) | null
    • updated_by object | null

      Additional properties are allowed.

      Hide updated_by attributes Show updated_by attributes object | null

      • email string | null Required
      • full_name string | null Required
      • profile_uid string
      • username string | null Required
    • version string

    Hide attributes Show attributes

    • comment string
    • created_at string(date-time)
    • created_by object

      Additional properties are allowed.

      Hide created_by attributes Show created_by attributes object

      • email string | null Required
      • full_name string | null Required
      • profile_uid string
      • username string | null Required
    • id string
    • owner string

      The application that owns the cases: Stack Management, Observability, or Elastic Security.

      Values are cases, observability, or securitySolution.

    • pushed_at string(date-time) | null
    • pushed_by object | null

      Additional properties are allowed.

      Hide pushed_by attributes Show pushed_by attributes object | null

      • email string | null Required
      • full_name string | null Required
      • profile_uid string
      • username string | null Required
    • type string Required Discriminator

      Value is user.

    • updated_at string(date-time) | null
    • updated_by object | null

      Additional properties are allowed.

      Hide updated_by attributes Show updated_by attributes object | null

      • email string | null Required
      • full_name string | null Required
      • profile_uid string
      • username string | null Required
    • version string

  • connector object Required

    One of:

    Cases_connector_properties_none object Cases_connector_properties_cases_webhook object Cases_connector_properties_jira object Cases_connector_properties_resilient object Cases_connector_properties_servicenow object Cases_connector_properties_servicenow_sir object Cases_connector_properties_swimlane object

    Defines properties for connectors when type is .none.

    Hide attributes Show attributes

    • fields string | null Required

      An object containing the connector fields. To create a case without a connector, specify null. To update a case to remove the connector, specify null.

    • id string Required

      The identifier for the connector. To create a case without a connector, use none. To update a case to remove the connector, specify none.

    • name string Required

      The name of the connector. To create a case without a connector, use none. To update a case to remove the connector, specify none.

    • type string Required Discriminator

      The type of connector. To create a case without a connector, use .none. To update a case to remove the connector, specify .none.

      Value is .none.

    Defines properties for connectors when type is .cases-webhook.

    Hide attributes Show attributes

    • fields string | null Required
    • id string Required

      The identifier for the connector. To retrieve connector IDs, use the find connectors API.

    • name string Required

      The name of the connector.

    • type string Required Discriminator

      The type of connector.

      Value is .cases-webhook.

    Defines properties for connectors when type is .jira.

    Hide attributes Show attributes

    • fields object Required

      An object containing the connector fields. If you want to omit any individual field, specify null as its value.

      Additional properties are allowed.

      Hide fields attributes Show fields attributes object

      • issueType string | null Required

        The type of issue.

      • parent string | null Required

        The key of the parent issue, when the issue type is sub-task.

      • priority string | null Required

        The priority of the issue.

    • id string Required

      The identifier for the connector. To retrieve connector IDs, use the find connectors API.

    • name string Required

      The name of the connector.

    • type string Required Discriminator

      The type of connector.

      Value is .jira.

    Defines properties for connectors when type is .resilient.

    Hide attributes Show attributes

    • fields object | null Required

      An object containing the connector fields. If you want to omit any individual field, specify null as its value.

      Additional properties are allowed.

      Hide fields attributes Show fields attributes object | null

      • issueTypes array[string] Required

        The type of incident.

      • severityCode string Required

        The severity code of the incident.

    • id string Required

      The identifier for the connector.

    • name string Required

      The name of the connector.

    • type string Required Discriminator

      The type of connector.

      Value is .resilient.

    Defines properties for connectors when type is .servicenow.

    Hide attributes Show attributes

    • fields object Required

      An object containing the connector fields. If you want to omit any individual field, specify null as its value.

      Additional properties are allowed.

      Hide fields attributes Show fields attributes object

      • category string | null Required

        The category of the incident.

      • impact string | null Required

        The effect an incident had on business.

      • severity string | null Required

        The severity of the incident.

      • subcategory string | null Required

        The subcategory of the incident.

      • urgency string | null Required

        The extent to which the incident resolution can be delayed.

    • id string Required

      The identifier for the connector. To retrieve connector IDs, use the find connectors API.

    • name string Required

      The name of the connector.

    • type string Required Discriminator

      The type of connector.

      Value is .servicenow.

    Defines properties for connectors when type is .servicenow-sir.

    Hide attributes Show attributes

    • fields object Required

      An object containing the connector fields. If you want to omit any individual field, specify null as its value.

      Additional properties are allowed.

      Hide fields attributes Show fields attributes object

      • category string | null Required

        The category of the incident.

      • destIp boolean | null Required

        Indicates whether cases will send a comma-separated list of destination IPs.

      • malwareHash boolean | null Required

        Indicates whether cases will send a comma-separated list of malware hashes.

      • malwareUrl boolean | null Required

        Indicates whether cases will send a comma-separated list of malware URLs.

      • priority string | null Required

        The priority of the issue.

      • sourceIp boolean | null Required

        Indicates whether cases will send a comma-separated list of source IPs.

      • subcategory string | null Required

        The subcategory of the incident.

    • id string Required

      The identifier for the connector. To retrieve connector IDs, use the find connectors API.

    • name string Required

      The name of the connector.

    • type string Required Discriminator

      The type of connector.

      Value is .servicenow-sir.

    Defines properties for connectors when type is .swimlane.

    Hide attributes Show attributes

    • fields object Required

      An object containing the connector fields. If you want to omit any individual field, specify null as its value.

      Additional properties are allowed.

      Hide fields attribute Show fields attribute object

      • caseId string | null Required

        The case identifier for Swimlane connectors.

    • id string Required

      The identifier for the connector. To retrieve connector IDs, use the find connectors API.

    • name string Required

      The name of the connector.

    • type string Required Discriminator

      The type of connector.

      Value is .swimlane.

  • created_at string(date-time) Required
  • created_by object Required

    Additional properties are allowed.

    Hide created_by attributes Show created_by attributes object

    • email string | null Required
    • full_name string | null Required
    • profile_uid string
    • username string | null Required
  • customFields array[object]

    Custom field values for the case.

    Hide customFields attributes Show customFields attributes object

    • key string

      The unique identifier for the custom field. The key value must exist in the case configuration settings.

    • type string

      The custom field type. It must match the type specified in the case configuration settings.

      Values are text or toggle.

    • value string | null | boolean

      The custom field value. If the custom field is required, it cannot be explicitly set to null. However, for cases that existed when the required custom field was added, the default value stored in Elasticsearch is undefined. The value returned in the API and user interface in this case is null.

      One of:

      string-1 string | null boolean-2 boolean

      Minimum length is 1, maximum length is 160.
  • description string Required
  • duration integer | null Required

    The elapsed time from the creation of the case to its closure (in seconds). If the case has not been closed, the duration is set to null. If the case was closed after less than half a second, the duration is rounded down to zero.

  • external_service object | null Required

    Additional properties are allowed.

    Hide external_service attributes Show external_service attributes object | null

    • connector_id string
    • connector_name string
    • external_id string
    • external_title string
    • external_url string
    • pushed_at string(date-time)
    • pushed_by object | null

      Additional properties are allowed.

      Hide pushed_by attributes Show pushed_by attributes object | null

      • email string | null
      • full_name string | null
      • profile_uid string
      • username string | null
  • id string Required
  • owner string Required

    The application that owns the cases: Stack Management, Observability, or Elastic Security.

    Values are cases, observability, or securitySolution.

  • settings object Required

    An object that contains the case settings.

    Additional properties are allowed.

    Hide settings attribute Show settings attribute object

    • syncAlerts boolean Required

      Turns alert syncing on or off.

  • severity string Required

    The severity of the case.

    Values are critical, high, low, or medium. Default value is low.

  • status string Required

    The status of the case.

    Values are closed, in-progress, or open.

  • tags array[string] Required
  • title string Required
  • totalAlerts integer Required
  • totalComment integer Required
  • updated_at string(date-time) | null Required
  • updated_by object | null Required

    Additional properties are allowed.

    Hide updated_by attributes Show updated_by attributes object | null

    • email string | null Required
    • full_name string | null Required
    • profile_uid string
    • username string | null Required
  • version string Required
• 401 application/json

  Authorization information is missing or invalid.

  Hide response attributes Show response attributes object

  • error string
  • message string
  • statusCode integer

Path parameters

• caseId string Required

  The identifier for the case. To retrieve case IDs, use the find cases API. All non-ASCII characters must be URL encoded.

Query parameters

• page integer

  The page number to return.

  Default value is 1.

• perPage integer

  The number of items to return. Limited to 100 items.

  Maximum value is 100. Default value is 20.

• sortOrder string

  Determines the sort order.

  Values are asc or desc. Default value is desc.

• types array[string]

  Determines the types of user actions to return.

  Values are action, alert, assignees, attachment, comment, connector, create_case, description, pushed, settings, severity, status, tags, title, or user.

Responses

• 200 application/json

  Indicates a successful call.

  Hide response attributes Show response attributes object

  • page integer
  • perPage integer
  • total integer
  • userActions array[object]

    Not more than 10000 elements.

    Hide userActions attributes Show userActions attributes object

    • action string Required

      Values are add, create, delete, push_to_service, or update.

    • comment_id string | null Required
    • created_at string(date-time) Required
    • created_by object Required

      Additional properties are allowed.

      Hide created_by attributes Show created_by attributes object

      • email string | null Required
      • full_name string | null Required
      • profile_uid string
      • username string | null Required
    • id string Required
    • owner string Required

      The application that owns the cases: Stack Management, Observability, or Elastic Security.

      Values are cases, observability, or securitySolution.

    • payload object | null Required

      One of:

      Cases_payload_alert_comment object Cases_payload_assignees object Cases_payload_connector object Cases_payload_create_case object Cases_payload_delete object | null Cases_payload_description object Cases_payload_pushed object Cases_payload_settings object Cases_payload_severity object Cases_payload_status object Cases_payload_tags object Cases_payload_title object Cases_payload_user_comment object

      Hide attribute Show attribute

      • comment object

        Additional properties are allowed.

        Hide comment attributes Show comment attributes object

        • alertId string | array[string]

          One of:

          string-1 string array-2 array[string]

        • index string | array[string]

          One of:

          string-1 string array-2 array[string]
        • owner string

          The application that owns the cases: Stack Management, Observability, or Elastic Security.

          Values are cases, observability, or securitySolution.

        • rule object

          Additional properties are allowed.

          Hide rule attributes Show rule attributes object

          • id string

            The rule identifier.

          • name string

            The rule name.

        • type string

          Value is alert.

      Hide attribute Show attribute

      • assignees array[object] | null

        An array containing users that are assigned to the case.

        Not more than 10 elements.

        Hide assignees attribute Show assignees attribute object

        • uid string Required

          A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.

      Hide attribute Show attribute

      • connector object

        Additional properties are allowed.

        Hide connector attributes Show connector attributes object

        • fields object | null

          An object containing the connector fields. To create a case without a connector, specify null. If you want to omit any individual field, specify null as its value.

          Additional properties are allowed.

          Hide fields attributes Show fields attributes object | null

          • caseId string

            The case identifier for Swimlane connectors.

          • category string

            The category of the incident for ServiceNow ITSM and ServiceNow SecOps connectors.

          • destIp boolean | null

            Indicates whether cases will send a comma-separated list of destination IPs for ServiceNow SecOps connectors.

          • impact string

            The effect an incident had on business for ServiceNow ITSM connectors.

          • issueType string

            The type of issue for Jira connectors.

          • issueTypes array[string]

            The type of incident for IBM Resilient connectors.

          • malwareHash boolean | null

            Indicates whether cases will send a comma-separated list of malware hashes for ServiceNow SecOps connectors.

          • malwareUrl boolean | null

            Indicates whether cases will send a comma-separated list of malware URLs for ServiceNow SecOps connectors.

          • parent string

            The key of the parent issue, when the issue type is sub-task for Jira connectors.

          • priority string

            The priority of the issue for Jira and ServiceNow SecOps connectors.

          • severity string

            The severity of the incident for ServiceNow ITSM connectors.

          • severityCode string

            The severity code of the incident for IBM Resilient connectors.

          • sourceIp boolean | null

            Indicates whether cases will send a comma-separated list of source IPs for ServiceNow SecOps connectors.

          • subcategory string

            The subcategory of the incident for ServiceNow ITSM connectors.

          • urgency string

            The extent to which the incident resolution can be delayed for ServiceNow ITSM connectors.

        • id string

          The identifier for the connector. To create a case without a connector, use none.

        • name string

          The name of the connector. To create a case without a connector, use none.

        • type string

          The type of connector.

          Values are .cases-webhook, .jira, .none, .resilient, .servicenow, .servicenow-sir, or .swimlane.

      Hide attributes Show attributes

      • assignees array[object] | null

        An array containing users that are assigned to the case.

        Not more than 10 elements.

        Hide assignees attribute Show assignees attribute object

        • uid string Required

          A unique identifier for the user profile. These identifiers can be found by using the suggest user profile API.

      • connector object

        Additional properties are allowed.

        Hide connector attributes Show connector attributes object

        • fields object | null

          An object containing the connector fields. To create a case without a connector, specify null. If you want to omit any individual field, specify null as its value.

          Additional properties are allowed.

          Hide fields attributes Show fields attributes object | null

          • caseId string

            The case identifier for Swimlane connectors.

          • category string

            The category of the incident for ServiceNow ITSM and ServiceNow SecOps connectors.

          • destIp boolean | null

            Indicates whether cases will send a comma-separated list of destination IPs for ServiceNow SecOps connectors.

          • impact string

            The effect an incident had on business for ServiceNow ITSM connectors.

          • issueType string

            The type of issue for Jira connectors.

          • issueTypes array[string]

            The type of incident for IBM Resilient connectors.

          • malwareHash boolean | null

            Indicates whether cases will send a comma-separated list of malware hashes for ServiceNow SecOps connectors.

          • malwareUrl boolean | null

            Indicates whether cases will send a comma-separated list of malware URLs for ServiceNow SecOps connectors.

          • parent string

            The key of the parent issue, when the issue type is sub-task for Jira connectors.

          • priority string

            The priority of the issue for Jira and ServiceNow SecOps connectors.

          • severity string

            The severity of the incident for ServiceNow ITSM connectors.

          • severityCode string

            The severity code of the incident for IBM Resilient connectors.

          • sourceIp boolean | null

            Indicates whether cases will send a comma-separated list of source IPs for ServiceNow SecOps connectors.

          • subcategory string

            The subcategory of the incident for ServiceNow ITSM connectors.

          • urgency string

            The extent to which the incident resolution can be delayed for ServiceNow ITSM connectors.

        • id string

          The identifier for the connector. To create a case without a connector, use none.

        • name string

          The name of the connector. To create a case without a connector, use none.

        • type string

          The type of connector.

          Values are .cases-webhook, .jira, .none, .resilient, .servicenow, .servicenow-sir, or .swimlane.

      • description string
      • owner string

        The application that owns the cases: Stack Management, Observability, or Elastic Security.

        Values are cases, observability, or securitySolution.

      • settings object

        An object that contains the case settings.

        Additional properties are allowed.

        Hide settings attribute Show settings attribute object

        • syncAlerts boolean Required

          Turns alert syncing on or off.

      • severity string

        The severity of the case.

        Values are critical, high, low, or medium. Default value is low.

      • status string

        The status of the case.

        Values are closed, in-progress, or open.

      • tags array[string]
      • title string

      If the action is delete and the type is delete_case, the payload is nullable.

      Additional properties are allowed.

      Hide attribute Show attribute

      • description string

      Hide attribute Show attribute

      • externalService object | null

        Additional properties are allowed.

        Hide externalService attributes Show externalService attributes object | null

        • connector_id string
        • connector_name string
        • external_id string
        • external_title string
        • external_url string
        • pushed_at string(date-time)
        • pushed_by object | null

          Additional properties are allowed.

          Hide pushed_by attributes Show pushed_by attributes object | null

          • email string | null
          • full_name string | null
          • profile_uid string
          • username string | null

      Hide attribute Show attribute

      • settings object

        An object that contains the case settings.

        Additional properties are allowed.

        Hide settings attribute Show settings attribute object

        • syncAlerts boolean Required

          Turns alert syncing on or off.

      Hide attribute Show attribute

      • severity string

        The severity of the case.

        Values are critical, high, low, or medium. Default value is low.

      Hide attribute Show attribute

      • status string

        The status of the case.

        Values are closed, in-progress, or open.

      Hide attribute Show attribute

      • tags array[string]

      Hide attribute Show attribute

      • title string

      Hide attribute Show attribute

      • comment object

        Additional properties are allowed.

        Hide comment attributes Show comment attributes object

        • comment string
        • owner string

          The application that owns the cases: Stack Management, Observability, or Elastic Security.

          Values are cases, observability, or securitySolution.

        • type string

          Value is user.

    • type string Required

      The type of action.

      Values are assignees, create_case, comment, connector, description, pushed, tags, title, status, settings, or severity.

    • version string Required
• 401 application/json

  Authorization information is missing or invalid.

  Hide response attributes Show response attributes object

  • error string
  • message string
  • statusCode integer

Query parameters

• owner string | array[string]

  A filter to limit the response to a specific set of applications. If this parameter is omitted, the response contains information about all the cases that the user has access to read.

Responses

• 200 application/json

  Indicates a successful call.

  Not more than 10000 elements.

• 401 application/json

  Authorization information is missing or invalid.

  Hide response attributes Show response attributes object

  • error string
  • message string
  • statusCode integer

Query parameters

• feature_id string

  A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).