List all detection rules

GET /api/detection_engine/rules/_find

Retrieve a paginated list of detection rules. By default, the first page is returned, with 20 results per page.

Query parameters

fields array[string]
filter string

Search query
sort_field string

Field to sort by

Values are created_at, createdAt, enabled, execution_summary.last_execution.date, execution_summary.last_execution.metrics.execution_gap_duration_s, execution_summary.last_execution.metrics.total_indexing_duration_ms, execution_summary.last_execution.metrics.total_search_duration_ms, execution_summary.last_execution.status, name, risk_score, riskScore, severity, updated_at, or updatedAt.
sort_order string

Sort order

Values are asc or desc.
page integer

Page number

Minimum value is 1. Default value is 1.
per_page integer

Rules per page

Minimum value is 0. Default value is 20.

Responses

200 application/json; Elastic-Api-Version=2023-10-31

Successful response
Hide response attributes Show response attributes object
- data array[object] Required
  
  Any of:
  Security_Solution_Detections_API_EqlRuleResponseFields object Security_Solution_Detections_API_QueryRuleResponseFields object Security_Solution_Detections_API_SavedQueryRuleResponseFields object Security_Solution_Detections_API_ThresholdRuleResponseFields object Security_Solution_Detections_API_ThreatMatchRuleResponseFields object Security_Solution_Detections_API_MachineLearningRuleResponseFields object Security_Solution_Detections_API_NewTermsRuleResponseFields object Security_Solution_Detections_API_EsqlRuleResponseFields object
  
  Hide attributes Show attributes
  
  actions array[object] Required
  
  Hide actions attributes Show actions attributes object
  
  action_type_id string Required
  
  The action type used for sending notifications.
  
  alerts_filter object
  
  Hide alerts_filter attribute Show alerts_filter attribute object
  
  Additional properties are allowed
  
  frequency object
  
  The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
  
  Hide frequency attributes Show frequency attributes object
  
  notifyWhen string Required
  
  The condition for throttling the notification: onActionGroupChange, onActiveAlert, or onThrottleInterval
  
  Values are onActiveAlert, onThrottleInterval, or onActionGroupChange.
  
  summary boolean Required
  
  Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
  
  throttle string | null Required
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  group string
  
  Optionally groups actions by use cases. Use default for alert notifications.
  
  id string Required
  
  The connector ID.
  
  params object Required
  
  Object containing the allowed connector fields, which varies according to the connector type.
  
  Hide params attribute Show params attribute object
  
  Additional properties are allowed
  
  uuid string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  alias_purpose string
  
  Values are savedObjectConversion or savedObjectImport.
  
  alias_target_id string
  
  author array[string] Required
  
  building_block_type string
  
  Determines if the rule acts as a building block. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. Its value must be default.
  
  description string Required
  
  Minimum length is 1.
  
  enabled boolean Required
  
  Determines whether the rule is enabled.
  
  exceptions_list array[object] Required
  
  Hide exceptions_list attributes Show exceptions_list attributes object
  
  id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  list_id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  namespace_type string Required
  
  Determines the exceptions validity in rule's Kibana space
  
  Values are agnostic or single.
  
  type string Required
  
  The exception type
  
  Values are detection, rule_default, endpoint, endpoint_trusted_apps, endpoint_events, endpoint_host_isolation_exceptions, or endpoint_blocklists.
  
  false_positives array[string] Required
  
  from string(date-math) Required
  
  Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
  
  interval string Required
  
  Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
  
  investigation_fields object
  
  Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert. Added in PR #163235 Right now we only have a single field but anticipate adding more related fields to store various configuration states such as override - where a user might say if they want only these fields to display, or if they want these fields + the fields we select. When expanding this field, it may look something like:
  
  const investigationFields = z.object({ field_names: NonEmptyArray(NonEmptyString), override: z.boolean().optional(), });
  
  Hide investigation_fields attribute Show investigation_fields attribute object
  
  field_names array[string] Required
  
  A string that is not empty and does not contain only whitespace
  
  At least 1 element. Minimum length of each is 1. Format of each should match the following pattern: ^(?! *$).+$.
  
  license string
  
  The rule's license.
  
  max_signals integer Required
  
  Minimum value is 1.
  
  meta object
  
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed
  
  name string Required
  
  Minimum length is 1.
  
  namespace string
  
  Has no effect.
  
  note string
  
  Notes to help investigate alerts produced by the rule.
  
  outcome string
  
  Values are exactMatch, aliasMatch, or conflict.
  
  output_index string Deprecated
  
  (deprecated) Has no effect.
  
  references array[string] Required
  
  related_integrations array[object] Required
  
  Hide related_integrations attributes Show related_integrations attributes object
  
  Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
  
  NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
  
  Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
  
  package: name of the package (required, unique id)
  
  version: version of the package (required, semver-compatible)
  
  integration: name of the integration of this package (optional, id within the package)
  
  There are Fleet packages like windows that contain only one integration; in this case, integration should be unspecified. There are also packages like aws and azure that contain several integrations; in this case, integration should be specified.
  
  @example const x: RelatedIntegration = { package: 'windows', version: '1.5.x', };
  
  @example const x: RelatedIntegration = { package: 'azure', version: '~1.1.6', integration: 'activitylogs', };
  
  integration string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  package string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  version string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  required_fields array[object] Required
  
  Hide required_fields attributes Show required_fields attributes object
  
  Describes an Elasticsearch field that is needed for the rule to function.
  
  Almost all types of Security rules check source event documents for a match to some kind of query or filter. If a document has certain field with certain values, then it's a match and the rule will generate an alert.
  
  Required field is an event field that must be present in the source indices of a given rule.
  
  @example const standardEcsField: RequiredField = { name: 'event.action', type: 'keyword', ecs: true, };
  
  @example const nonEcsField: RequiredField = { name: 'winlog.event_data.AttributeLDAPDisplayName', type: 'keyword', ecs: false, };
  
  ecs boolean Required
  
  Whether the field is an ECS field
  
  name string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  type string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  risk_score integer Required
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  risk_score_mapping array[object] Required
  
  Overrides generated alerts' risk_score with a value from the source event
  
  Hide risk_score_mapping attributes Show risk_score_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  risk_score integer
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  value string Required
  
  rule_name_override string
  
  Sets the source field for the alert's signal.rule.name value
  
  setup string Required
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  severity_mapping array[object] Required
  
  Overrides generated alerts' severity with values from the source event
  
  Hide severity_mapping attributes Show severity_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  value string Required
  
  tags array[string] Required
  
  String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
  
  threat array[object] Required
  
  Hide threat attributes Show threat attributes object
  
  framework string Required
  
  Relevant attack framework
  
  tactic object Required
  
  Hide tactic attributes Show tactic attributes object
  
  id string Required
  
  Tactic ID
  
  name string Required
  
  Tactic name
  
  reference string Required
  
  Tactic reference
  
  technique array[object]
  
  Array containing information on the attack techniques (optional)
  
  Hide technique attributes Show technique attributes object
  
  id string Required
  
  Technique ID
  
  name string Required
  
  Technique name
  
  reference string Required
  
  Technique reference
  
  subtechnique array[object]
  
  Array containing more specific information on the attack technique
  
  Hide subtechnique attributes Show subtechnique attributes object
  
  id string Required
  
  Subtechnique ID
  
  name string Required
  
  Subtechnique name
  
  reference string Required
  
  Subtechnique reference
  
  throttle string | null
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  timeline_id string
  
  Timeline template ID
  
  timeline_title string
  
  Timeline template title
  
  timestamp_override string
  
  Sets the time field used to query indices
  
  timestamp_override_fallback_disabled boolean
  
  Disables the fallback to the event's @timestamp field
  
  to string Required
  
  version integer Required
  
  The rule's version number.
  
  Minimum value is 1.
  
  created_at string(date-time) Required
  
  created_by string Required
  
  execution_summary object
  
  Hide execution_summary attribute Show execution_summary attribute object
  
  last_execution object Required
  
  Hide last_execution attributes Show last_execution attributes object
  
  date string(date-time) Required
  
  Date of the last execution
  
  message string Required
  
  metrics object Required
  
  Hide metrics attributes Show metrics attributes object
  
  execution_gap_duration_s integer
  
  Duration in seconds of execution gap
  
  Minimum value is 0.
  
  total_enrichment_duration_ms integer
  
  Total time spent enriching documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_indexing_duration_ms integer
  
  Total time spent indexing documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_search_duration_ms integer
  
  Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
  
  Minimum value is 0.
  
  status string Required
  
  Status of the last execution
  
  Values are going to run, running, partial failure, failed, or succeeded.
  
  status_order integer Required
  
  id string(uuid) Required
  
  A universally unique identifier
  
  immutable boolean Required Deprecated
  
  This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the rule_source field.
  
  revision integer Required
  
  Minimum value is 0.
  
  rule_id string Required
  
  Could be any string, not necessarily a UUID
  
  rule_source object
  
  Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
  
  One of:
  Security_Solution_Detections_API_ExternalRuleSource object Security_Solution_Detections_API_InternalRuleSource object
  
  Type of rule source for externally sourced rules, i.e. rules that have an external source, such as the Elastic Prebuilt rules repo.
  
  Hide attributes Show attributes
  
  is_customized boolean Required
  
  Determines whether an external/prebuilt rule has been customized by the user (i.e. any of its fields have been modified and diverged from the base value).
  
  type string Required Discriminator
  
  Value is external.
  
  updated_at string(date-time) Required
  
  updated_by string Required
  
  language string Required
  
  Query language to use
  
  Value is eql.
  
  query string Required
  
  EQL query to execute
  
  type string Required Discriminator
  
  Rule type
  
  Value is eql.
  
  alert_suppression object
  
  Hide alert_suppression attributes Show alert_suppression attributes object
  
  duration object
  
  Hide duration attributes Show duration attributes object
  
  unit string Required
  
  Values are s, m, or h.
  
  value integer Required
  
  Minimum value is 1.
  
  group_by array[string] Required
  
  At least 1 but not more than 3 elements.
  
  missing_fields_strategy string
  
  Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
  
  Values are doNotSuppress or suppress.
  
  data_view_id string
  
  event_category_override string
  
  filters array
  
  index array[string]
  
  tiebreaker_field string
  
  Sets a secondary field for sorting events
  
  timestamp_field string
  
  Contains the event timestamp used for sorting a sequence of events
  
  Hide attributes Show attributes
  
  actions array[object] Required
  
  Hide actions attributes Show actions attributes object
  
  action_type_id string Required
  
  The action type used for sending notifications.
  
  alerts_filter object
  
  Hide alerts_filter attribute Show alerts_filter attribute object
  
  Additional properties are allowed
  
  frequency object
  
  The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
  
  Hide frequency attributes Show frequency attributes object
  
  notifyWhen string Required
  
  The condition for throttling the notification: onActionGroupChange, onActiveAlert, or onThrottleInterval
  
  Values are onActiveAlert, onThrottleInterval, or onActionGroupChange.
  
  summary boolean Required
  
  Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
  
  throttle string | null Required
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  group string
  
  Optionally groups actions by use cases. Use default for alert notifications.
  
  id string Required
  
  The connector ID.
  
  params object Required
  
  Object containing the allowed connector fields, which varies according to the connector type.
  
  Hide params attribute Show params attribute object
  
  Additional properties are allowed
  
  uuid string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  alias_purpose string
  
  Values are savedObjectConversion or savedObjectImport.
  
  alias_target_id string
  
  author array[string] Required
  
  building_block_type string
  
  Determines if the rule acts as a building block. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. Its value must be default.
  
  description string Required
  
  Minimum length is 1.
  
  enabled boolean Required
  
  Determines whether the rule is enabled.
  
  exceptions_list array[object] Required
  
  Hide exceptions_list attributes Show exceptions_list attributes object
  
  id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  list_id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  namespace_type string Required
  
  Determines the exceptions validity in rule's Kibana space
  
  Values are agnostic or single.
  
  type string Required
  
  The exception type
  
  Values are detection, rule_default, endpoint, endpoint_trusted_apps, endpoint_events, endpoint_host_isolation_exceptions, or endpoint_blocklists.
  
  false_positives array[string] Required
  
  from string(date-math) Required
  
  Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
  
  interval string Required
  
  Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
  
  investigation_fields object
  
  Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert. Added in PR #163235 Right now we only have a single field but anticipate adding more related fields to store various configuration states such as override - where a user might say if they want only these fields to display, or if they want these fields + the fields we select. When expanding this field, it may look something like:
  
  const investigationFields = z.object({ field_names: NonEmptyArray(NonEmptyString), override: z.boolean().optional(), });
  
  Hide investigation_fields attribute Show investigation_fields attribute object
  
  field_names array[string] Required
  
  A string that is not empty and does not contain only whitespace
  
  At least 1 element. Minimum length of each is 1. Format of each should match the following pattern: ^(?! *$).+$.
  
  license string
  
  The rule's license.
  
  max_signals integer Required
  
  Minimum value is 1.
  
  meta object
  
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed
  
  name string Required
  
  Minimum length is 1.
  
  namespace string
  
  Has no effect.
  
  note string
  
  Notes to help investigate alerts produced by the rule.
  
  outcome string
  
  Values are exactMatch, aliasMatch, or conflict.
  
  output_index string Deprecated
  
  (deprecated) Has no effect.
  
  references array[string] Required
  
  related_integrations array[object] Required
  
  Hide related_integrations attributes Show related_integrations attributes object
  
  Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
  
  NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
  
  Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
  
  package: name of the package (required, unique id)
  
  version: version of the package (required, semver-compatible)
  
  integration: name of the integration of this package (optional, id within the package)
  
  There are Fleet packages like windows that contain only one integration; in this case, integration should be unspecified. There are also packages like aws and azure that contain several integrations; in this case, integration should be specified.
  
  @example const x: RelatedIntegration = { package: 'windows', version: '1.5.x', };
  
  @example const x: RelatedIntegration = { package: 'azure', version: '~1.1.6', integration: 'activitylogs', };
  
  integration string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  package string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  version string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  required_fields array[object] Required
  
  Hide required_fields attributes Show required_fields attributes object
  
  Describes an Elasticsearch field that is needed for the rule to function.
  
  Almost all types of Security rules check source event documents for a match to some kind of query or filter. If a document has certain field with certain values, then it's a match and the rule will generate an alert.
  
  Required field is an event field that must be present in the source indices of a given rule.
  
  @example const standardEcsField: RequiredField = { name: 'event.action', type: 'keyword', ecs: true, };
  
  @example const nonEcsField: RequiredField = { name: 'winlog.event_data.AttributeLDAPDisplayName', type: 'keyword', ecs: false, };
  
  ecs boolean Required
  
  Whether the field is an ECS field
  
  name string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  type string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  risk_score integer Required
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  risk_score_mapping array[object] Required
  
  Overrides generated alerts' risk_score with a value from the source event
  
  Hide risk_score_mapping attributes Show risk_score_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  risk_score integer
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  value string Required
  
  rule_name_override string
  
  Sets the source field for the alert's signal.rule.name value
  
  setup string Required
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  severity_mapping array[object] Required
  
  Overrides generated alerts' severity with values from the source event
  
  Hide severity_mapping attributes Show severity_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  value string Required
  
  tags array[string] Required
  
  String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
  
  threat array[object] Required
  
  Hide threat attributes Show threat attributes object
  
  framework string Required
  
  Relevant attack framework
  
  tactic object Required
  
  Hide tactic attributes Show tactic attributes object
  
  id string Required
  
  Tactic ID
  
  name string Required
  
  Tactic name
  
  reference string Required
  
  Tactic reference
  
  technique array[object]
  
  Array containing information on the attack techniques (optional)
  
  Hide technique attributes Show technique attributes object
  
  id string Required
  
  Technique ID
  
  name string Required
  
  Technique name
  
  reference string Required
  
  Technique reference
  
  subtechnique array[object]
  
  Array containing more specific information on the attack technique
  
  Hide subtechnique attributes Show subtechnique attributes object
  
  id string Required
  
  Subtechnique ID
  
  name string Required
  
  Subtechnique name
  
  reference string Required
  
  Subtechnique reference
  
  throttle string | null
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  timeline_id string
  
  Timeline template ID
  
  timeline_title string
  
  Timeline template title
  
  timestamp_override string
  
  Sets the time field used to query indices
  
  timestamp_override_fallback_disabled boolean
  
  Disables the fallback to the event's @timestamp field
  
  to string Required
  
  version integer Required
  
  The rule's version number.
  
  Minimum value is 1.
  
  created_at string(date-time) Required
  
  created_by string Required
  
  execution_summary object
  
  Hide execution_summary attribute Show execution_summary attribute object
  
  last_execution object Required
  
  Hide last_execution attributes Show last_execution attributes object
  
  date string(date-time) Required
  
  Date of the last execution
  
  message string Required
  
  metrics object Required
  
  Hide metrics attributes Show metrics attributes object
  
  execution_gap_duration_s integer
  
  Duration in seconds of execution gap
  
  Minimum value is 0.
  
  total_enrichment_duration_ms integer
  
  Total time spent enriching documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_indexing_duration_ms integer
  
  Total time spent indexing documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_search_duration_ms integer
  
  Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
  
  Minimum value is 0.
  
  status string Required
  
  Status of the last execution
  
  Values are going to run, running, partial failure, failed, or succeeded.
  
  status_order integer Required
  
  id string(uuid) Required
  
  A universally unique identifier
  
  immutable boolean Required Deprecated
  
  This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the rule_source field.
  
  revision integer Required
  
  Minimum value is 0.
  
  rule_id string Required
  
  Could be any string, not necessarily a UUID
  
  rule_source object
  
  Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
  
  One of:
  Security_Solution_Detections_API_ExternalRuleSource object Security_Solution_Detections_API_InternalRuleSource object
  
  Type of rule source for externally sourced rules, i.e. rules that have an external source, such as the Elastic Prebuilt rules repo.
  
  Hide attributes Show attributes
  
  is_customized boolean Required
  
  Determines whether an external/prebuilt rule has been customized by the user (i.e. any of its fields have been modified and diverged from the base value).
  
  type string Required Discriminator
  
  Value is external.
  
  updated_at string(date-time) Required
  
  updated_by string Required
  
  type string Required Discriminator
  
  Rule type
  
  Value is query.
  
  alert_suppression object
  
  Hide alert_suppression attributes Show alert_suppression attributes object
  
  duration object
  
  Hide duration attributes Show duration attributes object
  
  unit string Required
  
  Values are s, m, or h.
  
  value integer Required
  
  Minimum value is 1.
  
  group_by array[string] Required
  
  At least 1 but not more than 3 elements.
  
  missing_fields_strategy string
  
  Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
  
  Values are doNotSuppress or suppress.
  
  data_view_id string
  
  filters array
  
  index array[string]
  
  response_actions array[object]
  
  One of:
  Security_Solution_Detections_API_OsqueryResponseAction object Security_Solution_Detections_API_EndpointResponseAction object
  
  Hide attributes Show attributes
  
  action_type_id string Required
  
  Value is .osquery.
  
  params object Required
  
  Hide params attributes Show params attributes object
  
  ecs_mapping object
  
  Hide ecs_mapping attribute Show ecs_mapping attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  field string
  
  value string | array[string]
  
  One of:
  string-1 string array-2 array[string]
  
  pack_id string
  
  queries array[object]
  
  Hide queries attributes Show queries attributes object
  
  ecs_mapping object
  
  Hide ecs_mapping attribute Show ecs_mapping attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  field string
  
  value string | array[string]
  
  One of:
  string-1 string array-2 array[string]
  
  id string Required
  
  Query ID
  
  platform string
  
  query string Required
  
  Query to run
  
  removed boolean
  
  snapshot boolean
  
  version string
  
  Query version
  
  query string
  
  saved_query_id string
  
  timeout number
  
  Hide attributes Show attributes
  
  action_type_id string Required
  
  Value is .endpoint.
  
  params object Required
  
  One of:
  Security_Solution_Detections_API_DefaultParams object Security_Solution_Detections_API_ProcessesParams object
  
  Hide attributes Show attributes
  
  command string Required
  
  Values are kill-process or suspend-process.
  
  comment string
  
  config object Required
  
  Hide config attributes Show config attributes object
  
  field string Required
  
  Field to use instead of process.pid
  
  overwrite boolean
  
  Whether to overwrite field with process.pid
  
  Default value is true.
  
  saved_id string
  
  language string Required
  
  Values are kuery or lucene.
  
  query string Required
  
  EQL query to execute
  
  Hide attributes Show attributes
  
  actions array[object] Required
  
  Hide actions attributes Show actions attributes object
  
  action_type_id string Required
  
  The action type used for sending notifications.
  
  alerts_filter object
  
  Hide alerts_filter attribute Show alerts_filter attribute object
  
  Additional properties are allowed
  
  frequency object
  
  The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
  
  Hide frequency attributes Show frequency attributes object
  
  notifyWhen string Required
  
  The condition for throttling the notification: onActionGroupChange, onActiveAlert, or onThrottleInterval
  
  Values are onActiveAlert, onThrottleInterval, or onActionGroupChange.
  
  summary boolean Required
  
  Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
  
  throttle string | null Required
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  group string
  
  Optionally groups actions by use cases. Use default for alert notifications.
  
  id string Required
  
  The connector ID.
  
  params object Required
  
  Object containing the allowed connector fields, which varies according to the connector type.
  
  Hide params attribute Show params attribute object
  
  Additional properties are allowed
  
  uuid string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  alias_purpose string
  
  Values are savedObjectConversion or savedObjectImport.
  
  alias_target_id string
  
  author array[string] Required
  
  building_block_type string
  
  Determines if the rule acts as a building block. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. Its value must be default.
  
  description string Required
  
  Minimum length is 1.
  
  enabled boolean Required
  
  Determines whether the rule is enabled.
  
  exceptions_list array[object] Required
  
  Hide exceptions_list attributes Show exceptions_list attributes object
  
  id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  list_id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  namespace_type string Required
  
  Determines the exceptions validity in rule's Kibana space
  
  Values are agnostic or single.
  
  type string Required
  
  The exception type
  
  Values are detection, rule_default, endpoint, endpoint_trusted_apps, endpoint_events, endpoint_host_isolation_exceptions, or endpoint_blocklists.
  
  false_positives array[string] Required
  
  from string(date-math) Required
  
  Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
  
  interval string Required
  
  Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
  
  investigation_fields object
  
  Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert. Added in PR #163235 Right now we only have a single field but anticipate adding more related fields to store various configuration states such as override - where a user might say if they want only these fields to display, or if they want these fields + the fields we select. When expanding this field, it may look something like:
  
  const investigationFields = z.object({ field_names: NonEmptyArray(NonEmptyString), override: z.boolean().optional(), });
  
  Hide investigation_fields attribute Show investigation_fields attribute object
  
  field_names array[string] Required
  
  A string that is not empty and does not contain only whitespace
  
  At least 1 element. Minimum length of each is 1. Format of each should match the following pattern: ^(?! *$).+$.
  
  license string
  
  The rule's license.
  
  max_signals integer Required
  
  Minimum value is 1.
  
  meta object
  
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed
  
  name string Required
  
  Minimum length is 1.
  
  namespace string
  
  Has no effect.
  
  note string
  
  Notes to help investigate alerts produced by the rule.
  
  outcome string
  
  Values are exactMatch, aliasMatch, or conflict.
  
  output_index string Deprecated
  
  (deprecated) Has no effect.
  
  references array[string] Required
  
  related_integrations array[object] Required
  
  Hide related_integrations attributes Show related_integrations attributes object
  
  Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
  
  NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
  
  Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
  
  package: name of the package (required, unique id)
  
  version: version of the package (required, semver-compatible)
  
  integration: name of the integration of this package (optional, id within the package)
  
  There are Fleet packages like windows that contain only one integration; in this case, integration should be unspecified. There are also packages like aws and azure that contain several integrations; in this case, integration should be specified.
  
  @example const x: RelatedIntegration = { package: 'windows', version: '1.5.x', };
  
  @example const x: RelatedIntegration = { package: 'azure', version: '~1.1.6', integration: 'activitylogs', };
  
  integration string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  package string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  version string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  required_fields array[object] Required
  
  Hide required_fields attributes Show required_fields attributes object
  
  Describes an Elasticsearch field that is needed for the rule to function.
  
  Almost all types of Security rules check source event documents for a match to some kind of query or filter. If a document has certain field with certain values, then it's a match and the rule will generate an alert.
  
  Required field is an event field that must be present in the source indices of a given rule.
  
  @example const standardEcsField: RequiredField = { name: 'event.action', type: 'keyword', ecs: true, };
  
  @example const nonEcsField: RequiredField = { name: 'winlog.event_data.AttributeLDAPDisplayName', type: 'keyword', ecs: false, };
  
  ecs boolean Required
  
  Whether the field is an ECS field
  
  name string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  type string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  risk_score integer Required
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  risk_score_mapping array[object] Required
  
  Overrides generated alerts' risk_score with a value from the source event
  
  Hide risk_score_mapping attributes Show risk_score_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  risk_score integer
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  value string Required
  
  rule_name_override string
  
  Sets the source field for the alert's signal.rule.name value
  
  setup string Required
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  severity_mapping array[object] Required
  
  Overrides generated alerts' severity with values from the source event
  
  Hide severity_mapping attributes Show severity_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  value string Required
  
  tags array[string] Required
  
  String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
  
  threat array[object] Required
  
  Hide threat attributes Show threat attributes object
  
  framework string Required
  
  Relevant attack framework
  
  tactic object Required
  
  Hide tactic attributes Show tactic attributes object
  
  id string Required
  
  Tactic ID
  
  name string Required
  
  Tactic name
  
  reference string Required
  
  Tactic reference
  
  technique array[object]
  
  Array containing information on the attack techniques (optional)
  
  Hide technique attributes Show technique attributes object
  
  id string Required
  
  Technique ID
  
  name string Required
  
  Technique name
  
  reference string Required
  
  Technique reference
  
  subtechnique array[object]
  
  Array containing more specific information on the attack technique
  
  Hide subtechnique attributes Show subtechnique attributes object
  
  id string Required
  
  Subtechnique ID
  
  name string Required
  
  Subtechnique name
  
  reference string Required
  
  Subtechnique reference
  
  throttle string | null
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  timeline_id string
  
  Timeline template ID
  
  timeline_title string
  
  Timeline template title
  
  timestamp_override string
  
  Sets the time field used to query indices
  
  timestamp_override_fallback_disabled boolean
  
  Disables the fallback to the event's @timestamp field
  
  to string Required
  
  version integer Required
  
  The rule's version number.
  
  Minimum value is 1.
  
  created_at string(date-time) Required
  
  created_by string Required
  
  execution_summary object
  
  Hide execution_summary attribute Show execution_summary attribute object
  
  last_execution object Required
  
  Hide last_execution attributes Show last_execution attributes object
  
  date string(date-time) Required
  
  Date of the last execution
  
  message string Required
  
  metrics object Required
  
  Hide metrics attributes Show metrics attributes object
  
  execution_gap_duration_s integer
  
  Duration in seconds of execution gap
  
  Minimum value is 0.
  
  total_enrichment_duration_ms integer
  
  Total time spent enriching documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_indexing_duration_ms integer
  
  Total time spent indexing documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_search_duration_ms integer
  
  Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
  
  Minimum value is 0.
  
  status string Required
  
  Status of the last execution
  
  Values are going to run, running, partial failure, failed, or succeeded.
  
  status_order integer Required
  
  id string(uuid) Required
  
  A universally unique identifier
  
  immutable boolean Required Deprecated
  
  This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the rule_source field.
  
  revision integer Required
  
  Minimum value is 0.
  
  rule_id string Required
  
  Could be any string, not necessarily a UUID
  
  rule_source object
  
  Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
  
  One of:
  Security_Solution_Detections_API_ExternalRuleSource object Security_Solution_Detections_API_InternalRuleSource object
  
  Type of rule source for externally sourced rules, i.e. rules that have an external source, such as the Elastic Prebuilt rules repo.
  
  Hide attributes Show attributes
  
  is_customized boolean Required
  
  Determines whether an external/prebuilt rule has been customized by the user (i.e. any of its fields have been modified and diverged from the base value).
  
  type string Required Discriminator
  
  Value is external.
  
  updated_at string(date-time) Required
  
  updated_by string Required
  
  saved_id string Required
  
  type string Required Discriminator
  
  Rule type
  
  Value is saved_query.
  
  alert_suppression object
  
  Hide alert_suppression attributes Show alert_suppression attributes object
  
  duration object
  
  Hide duration attributes Show duration attributes object
  
  unit string Required
  
  Values are s, m, or h.
  
  value integer Required
  
  Minimum value is 1.
  
  group_by array[string] Required
  
  At least 1 but not more than 3 elements.
  
  missing_fields_strategy string
  
  Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
  
  Values are doNotSuppress or suppress.
  
  data_view_id string
  
  filters array
  
  index array[string]
  
  query string
  
  EQL query to execute
  
  response_actions array[object]
  
  One of:
  Security_Solution_Detections_API_OsqueryResponseAction object Security_Solution_Detections_API_EndpointResponseAction object
  
  Hide attributes Show attributes
  
  action_type_id string Required
  
  Value is .osquery.
  
  params object Required
  
  Hide params attributes Show params attributes object
  
  ecs_mapping object
  
  Hide ecs_mapping attribute Show ecs_mapping attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  field string
  
  value string | array[string]
  
  One of:
  string-1 string array-2 array[string]
  
  pack_id string
  
  queries array[object]
  
  Hide queries attributes Show queries attributes object
  
  ecs_mapping object
  
  Hide ecs_mapping attribute Show ecs_mapping attribute object
  
  * object Additional properties
  
  Hide * attributes Show * attributes object
  
  field string
  
  value string | array[string]
  
  One of:
  string-1 string array-2 array[string]
  
  id string Required
  
  Query ID
  
  platform string
  
  query string Required
  
  Query to run
  
  removed boolean
  
  snapshot boolean
  
  version string
  
  Query version
  
  query string
  
  saved_query_id string
  
  timeout number
  
  Hide attributes Show attributes
  
  action_type_id string Required
  
  Value is .endpoint.
  
  params object Required
  
  One of:
  Security_Solution_Detections_API_DefaultParams object Security_Solution_Detections_API_ProcessesParams object
  
  Hide attributes Show attributes
  
  command string Required
  
  Values are kill-process or suspend-process.
  
  comment string
  
  config object Required
  
  Hide config attributes Show config attributes object
  
  field string Required
  
  Field to use instead of process.pid
  
  overwrite boolean
  
  Whether to overwrite field with process.pid
  
  Default value is true.
  
  language string Required
  
  Values are kuery or lucene.
  
  Hide attributes Show attributes
  
  actions array[object] Required
  
  Hide actions attributes Show actions attributes object
  
  action_type_id string Required
  
  The action type used for sending notifications.
  
  alerts_filter object
  
  Hide alerts_filter attribute Show alerts_filter attribute object
  
  Additional properties are allowed
  
  frequency object
  
  The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
  
  Hide frequency attributes Show frequency attributes object
  
  notifyWhen string Required
  
  The condition for throttling the notification: onActionGroupChange, onActiveAlert, or onThrottleInterval
  
  Values are onActiveAlert, onThrottleInterval, or onActionGroupChange.
  
  summary boolean Required
  
  Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
  
  throttle string | null Required
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  group string
  
  Optionally groups actions by use cases. Use default for alert notifications.
  
  id string Required
  
  The connector ID.
  
  params object Required
  
  Object containing the allowed connector fields, which varies according to the connector type.
  
  Hide params attribute Show params attribute object
  
  Additional properties are allowed
  
  uuid string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  alias_purpose string
  
  Values are savedObjectConversion or savedObjectImport.
  
  alias_target_id string
  
  author array[string] Required
  
  building_block_type string
  
  Determines if the rule acts as a building block. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. Its value must be default.
  
  description string Required
  
  Minimum length is 1.
  
  enabled boolean Required
  
  Determines whether the rule is enabled.
  
  exceptions_list array[object] Required
  
  Hide exceptions_list attributes Show exceptions_list attributes object
  
  id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  list_id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  namespace_type string Required
  
  Determines the exceptions validity in rule's Kibana space
  
  Values are agnostic or single.
  
  type string Required
  
  The exception type
  
  Values are detection, rule_default, endpoint, endpoint_trusted_apps, endpoint_events, endpoint_host_isolation_exceptions, or endpoint_blocklists.
  
  false_positives array[string] Required
  
  from string(date-math) Required
  
  Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
  
  interval string Required
  
  Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
  
  investigation_fields object
  
  Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert. Added in PR #163235 Right now we only have a single field but anticipate adding more related fields to store various configuration states such as override - where a user might say if they want only these fields to display, or if they want these fields + the fields we select. When expanding this field, it may look something like:
  
  const investigationFields = z.object({ field_names: NonEmptyArray(NonEmptyString), override: z.boolean().optional(), });
  
  Hide investigation_fields attribute Show investigation_fields attribute object
  
  field_names array[string] Required
  
  A string that is not empty and does not contain only whitespace
  
  At least 1 element. Minimum length of each is 1. Format of each should match the following pattern: ^(?! *$).+$.
  
  license string
  
  The rule's license.
  
  max_signals integer Required
  
  Minimum value is 1.
  
  meta object
  
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed
  
  name string Required
  
  Minimum length is 1.
  
  namespace string
  
  Has no effect.
  
  note string
  
  Notes to help investigate alerts produced by the rule.
  
  outcome string
  
  Values are exactMatch, aliasMatch, or conflict.
  
  output_index string Deprecated
  
  (deprecated) Has no effect.
  
  references array[string] Required
  
  related_integrations array[object] Required
  
  Hide related_integrations attributes Show related_integrations attributes object
  
  Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
  
  NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
  
  Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
  
  package: name of the package (required, unique id)
  
  version: version of the package (required, semver-compatible)
  
  integration: name of the integration of this package (optional, id within the package)
  
  There are Fleet packages like windows that contain only one integration; in this case, integration should be unspecified. There are also packages like aws and azure that contain several integrations; in this case, integration should be specified.
  
  @example const x: RelatedIntegration = { package: 'windows', version: '1.5.x', };
  
  @example const x: RelatedIntegration = { package: 'azure', version: '~1.1.6', integration: 'activitylogs', };
  
  integration string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  package string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  version string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  required_fields array[object] Required
  
  Hide required_fields attributes Show required_fields attributes object
  
  Describes an Elasticsearch field that is needed for the rule to function.
  
  Almost all types of Security rules check source event documents for a match to some kind of query or filter. If a document has certain field with certain values, then it's a match and the rule will generate an alert.
  
  Required field is an event field that must be present in the source indices of a given rule.
  
  @example const standardEcsField: RequiredField = { name: 'event.action', type: 'keyword', ecs: true, };
  
  @example const nonEcsField: RequiredField = { name: 'winlog.event_data.AttributeLDAPDisplayName', type: 'keyword', ecs: false, };
  
  ecs boolean Required
  
  Whether the field is an ECS field
  
  name string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  type string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  risk_score integer Required
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  risk_score_mapping array[object] Required
  
  Overrides generated alerts' risk_score with a value from the source event
  
  Hide risk_score_mapping attributes Show risk_score_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  risk_score integer
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  value string Required
  
  rule_name_override string
  
  Sets the source field for the alert's signal.rule.name value
  
  setup string Required
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  severity_mapping array[object] Required
  
  Overrides generated alerts' severity with values from the source event
  
  Hide severity_mapping attributes Show severity_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  value string Required
  
  tags array[string] Required
  
  String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
  
  threat array[object] Required
  
  Hide threat attributes Show threat attributes object
  
  framework string Required
  
  Relevant attack framework
  
  tactic object Required
  
  Hide tactic attributes Show tactic attributes object
  
  id string Required
  
  Tactic ID
  
  name string Required
  
  Tactic name
  
  reference string Required
  
  Tactic reference
  
  technique array[object]
  
  Array containing information on the attack techniques (optional)
  
  Hide technique attributes Show technique attributes object
  
  id string Required
  
  Technique ID
  
  name string Required
  
  Technique name
  
  reference string Required
  
  Technique reference
  
  subtechnique array[object]
  
  Array containing more specific information on the attack technique
  
  Hide subtechnique attributes Show subtechnique attributes object
  
  id string Required
  
  Subtechnique ID
  
  name string Required
  
  Subtechnique name
  
  reference string Required
  
  Subtechnique reference
  
  throttle string | null
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  timeline_id string
  
  Timeline template ID
  
  timeline_title string
  
  Timeline template title
  
  timestamp_override string
  
  Sets the time field used to query indices
  
  timestamp_override_fallback_disabled boolean
  
  Disables the fallback to the event's @timestamp field
  
  to string Required
  
  version integer Required
  
  The rule's version number.
  
  Minimum value is 1.
  
  created_at string(date-time) Required
  
  created_by string Required
  
  execution_summary object
  
  Hide execution_summary attribute Show execution_summary attribute object
  
  last_execution object Required
  
  Hide last_execution attributes Show last_execution attributes object
  
  date string(date-time) Required
  
  Date of the last execution
  
  message string Required
  
  metrics object Required
  
  Hide metrics attributes Show metrics attributes object
  
  execution_gap_duration_s integer
  
  Duration in seconds of execution gap
  
  Minimum value is 0.
  
  total_enrichment_duration_ms integer
  
  Total time spent enriching documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_indexing_duration_ms integer
  
  Total time spent indexing documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_search_duration_ms integer
  
  Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
  
  Minimum value is 0.
  
  status string Required
  
  Status of the last execution
  
  Values are going to run, running, partial failure, failed, or succeeded.
  
  status_order integer Required
  
  id string(uuid) Required
  
  A universally unique identifier
  
  immutable boolean Required Deprecated
  
  This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the rule_source field.
  
  revision integer Required
  
  Minimum value is 0.
  
  rule_id string Required
  
  Could be any string, not necessarily a UUID
  
  rule_source object
  
  Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
  
  One of:
  Security_Solution_Detections_API_ExternalRuleSource object Security_Solution_Detections_API_InternalRuleSource object
  
  Type of rule source for externally sourced rules, i.e. rules that have an external source, such as the Elastic Prebuilt rules repo.
  
  Hide attributes Show attributes
  
  is_customized boolean Required
  
  Determines whether an external/prebuilt rule has been customized by the user (i.e. any of its fields have been modified and diverged from the base value).
  
  type string Required Discriminator
  
  Value is external.
  
  updated_at string(date-time) Required
  
  updated_by string Required
  
  query string Required
  
  EQL query to execute
  
  threshold object Required
  
  Hide threshold attributes Show threshold attributes object
  
  cardinality array[object]
  
  Hide cardinality attributes Show cardinality attributes object
  
  field string Required
  
  value integer Required
  
  Minimum value is 0.
  
  field string | array[string] Required
  
  Field to aggregate on
  
  One of:
  string-1 string array-2 array[string]
  
  value integer Required
  
  Threshold value
  
  Minimum value is 1.
  
  type string Required Discriminator
  
  Rule type
  
  Value is threshold.
  
  alert_suppression object
  
  Hide alert_suppression attribute Show alert_suppression attribute object
  
  duration object Required
  
  Hide duration attributes Show duration attributes object
  
  unit string Required
  
  Values are s, m, or h.
  
  value integer Required
  
  Minimum value is 1.
  
  data_view_id string
  
  filters array
  
  index array[string]
  
  saved_id string
  
  language string Required
  
  Values are kuery or lucene.
  
  Hide attributes Show attributes
  
  actions array[object] Required
  
  Hide actions attributes Show actions attributes object
  
  action_type_id string Required
  
  The action type used for sending notifications.
  
  alerts_filter object
  
  Hide alerts_filter attribute Show alerts_filter attribute object
  
  Additional properties are allowed
  
  frequency object
  
  The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
  
  Hide frequency attributes Show frequency attributes object
  
  notifyWhen string Required
  
  The condition for throttling the notification: onActionGroupChange, onActiveAlert, or onThrottleInterval
  
  Values are onActiveAlert, onThrottleInterval, or onActionGroupChange.
  
  summary boolean Required
  
  Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
  
  throttle string | null Required
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  group string
  
  Optionally groups actions by use cases. Use default for alert notifications.
  
  id string Required
  
  The connector ID.
  
  params object Required
  
  Object containing the allowed connector fields, which varies according to the connector type.
  
  Hide params attribute Show params attribute object
  
  Additional properties are allowed
  
  uuid string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  alias_purpose string
  
  Values are savedObjectConversion or savedObjectImport.
  
  alias_target_id string
  
  author array[string] Required
  
  building_block_type string
  
  Determines if the rule acts as a building block. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. Its value must be default.
  
  description string Required
  
  Minimum length is 1.
  
  enabled boolean Required
  
  Determines whether the rule is enabled.
  
  exceptions_list array[object] Required
  
  Hide exceptions_list attributes Show exceptions_list attributes object
  
  id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  list_id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  namespace_type string Required
  
  Determines the exceptions validity in rule's Kibana space
  
  Values are agnostic or single.
  
  type string Required
  
  The exception type
  
  Values are detection, rule_default, endpoint, endpoint_trusted_apps, endpoint_events, endpoint_host_isolation_exceptions, or endpoint_blocklists.
  
  false_positives array[string] Required
  
  from string(date-math) Required
  
  Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
  
  interval string Required
  
  Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
  
  investigation_fields object
  
  Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert. Added in PR #163235 Right now we only have a single field but anticipate adding more related fields to store various configuration states such as override - where a user might say if they want only these fields to display, or if they want these fields + the fields we select. When expanding this field, it may look something like:
  
  const investigationFields = z.object({ field_names: NonEmptyArray(NonEmptyString), override: z.boolean().optional(), });
  
  Hide investigation_fields attribute Show investigation_fields attribute object
  
  field_names array[string] Required
  
  A string that is not empty and does not contain only whitespace
  
  At least 1 element. Minimum length of each is 1. Format of each should match the following pattern: ^(?! *$).+$.
  
  license string
  
  The rule's license.
  
  max_signals integer Required
  
  Minimum value is 1.
  
  meta object
  
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed
  
  name string Required
  
  Minimum length is 1.
  
  namespace string
  
  Has no effect.
  
  note string
  
  Notes to help investigate alerts produced by the rule.
  
  outcome string
  
  Values are exactMatch, aliasMatch, or conflict.
  
  output_index string Deprecated
  
  (deprecated) Has no effect.
  
  references array[string] Required
  
  related_integrations array[object] Required
  
  Hide related_integrations attributes Show related_integrations attributes object
  
  Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
  
  NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
  
  Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
  
  package: name of the package (required, unique id)
  
  version: version of the package (required, semver-compatible)
  
  integration: name of the integration of this package (optional, id within the package)
  
  There are Fleet packages like windows that contain only one integration; in this case, integration should be unspecified. There are also packages like aws and azure that contain several integrations; in this case, integration should be specified.
  
  @example const x: RelatedIntegration = { package: 'windows', version: '1.5.x', };
  
  @example const x: RelatedIntegration = { package: 'azure', version: '~1.1.6', integration: 'activitylogs', };
  
  integration string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  package string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  version string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  required_fields array[object] Required
  
  Hide required_fields attributes Show required_fields attributes object
  
  Describes an Elasticsearch field that is needed for the rule to function.
  
  Almost all types of Security rules check source event documents for a match to some kind of query or filter. If a document has certain field with certain values, then it's a match and the rule will generate an alert.
  
  Required field is an event field that must be present in the source indices of a given rule.
  
  @example const standardEcsField: RequiredField = { name: 'event.action', type: 'keyword', ecs: true, };
  
  @example const nonEcsField: RequiredField = { name: 'winlog.event_data.AttributeLDAPDisplayName', type: 'keyword', ecs: false, };
  
  ecs boolean Required
  
  Whether the field is an ECS field
  
  name string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  type string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  risk_score integer Required
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  risk_score_mapping array[object] Required
  
  Overrides generated alerts' risk_score with a value from the source event
  
  Hide risk_score_mapping attributes Show risk_score_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  risk_score integer
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  value string Required
  
  rule_name_override string
  
  Sets the source field for the alert's signal.rule.name value
  
  setup string Required
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  severity_mapping array[object] Required
  
  Overrides generated alerts' severity with values from the source event
  
  Hide severity_mapping attributes Show severity_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  value string Required
  
  tags array[string] Required
  
  String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
  
  threat array[object] Required
  
  Hide threat attributes Show threat attributes object
  
  framework string Required
  
  Relevant attack framework
  
  tactic object Required
  
  Hide tactic attributes Show tactic attributes object
  
  id string Required
  
  Tactic ID
  
  name string Required
  
  Tactic name
  
  reference string Required
  
  Tactic reference
  
  technique array[object]
  
  Array containing information on the attack techniques (optional)
  
  Hide technique attributes Show technique attributes object
  
  id string Required
  
  Technique ID
  
  name string Required
  
  Technique name
  
  reference string Required
  
  Technique reference
  
  subtechnique array[object]
  
  Array containing more specific information on the attack technique
  
  Hide subtechnique attributes Show subtechnique attributes object
  
  id string Required
  
  Subtechnique ID
  
  name string Required
  
  Subtechnique name
  
  reference string Required
  
  Subtechnique reference
  
  throttle string | null
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  timeline_id string
  
  Timeline template ID
  
  timeline_title string
  
  Timeline template title
  
  timestamp_override string
  
  Sets the time field used to query indices
  
  timestamp_override_fallback_disabled boolean
  
  Disables the fallback to the event's @timestamp field
  
  to string Required
  
  version integer Required
  
  The rule's version number.
  
  Minimum value is 1.
  
  created_at string(date-time) Required
  
  created_by string Required
  
  execution_summary object
  
  Hide execution_summary attribute Show execution_summary attribute object
  
  last_execution object Required
  
  Hide last_execution attributes Show last_execution attributes object
  
  date string(date-time) Required
  
  Date of the last execution
  
  message string Required
  
  metrics object Required
  
  Hide metrics attributes Show metrics attributes object
  
  execution_gap_duration_s integer
  
  Duration in seconds of execution gap
  
  Minimum value is 0.
  
  total_enrichment_duration_ms integer
  
  Total time spent enriching documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_indexing_duration_ms integer
  
  Total time spent indexing documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_search_duration_ms integer
  
  Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
  
  Minimum value is 0.
  
  status string Required
  
  Status of the last execution
  
  Values are going to run, running, partial failure, failed, or succeeded.
  
  status_order integer Required
  
  id string(uuid) Required
  
  A universally unique identifier
  
  immutable boolean Required Deprecated
  
  This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the rule_source field.
  
  revision integer Required
  
  Minimum value is 0.
  
  rule_id string Required
  
  Could be any string, not necessarily a UUID
  
  rule_source object
  
  Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
  
  One of:
  Security_Solution_Detections_API_ExternalRuleSource object Security_Solution_Detections_API_InternalRuleSource object
  
  Type of rule source for externally sourced rules, i.e. rules that have an external source, such as the Elastic Prebuilt rules repo.
  
  Hide attributes Show attributes
  
  is_customized boolean Required
  
  Determines whether an external/prebuilt rule has been customized by the user (i.e. any of its fields have been modified and diverged from the base value).
  
  type string Required Discriminator
  
  Value is external.
  
  updated_at string(date-time) Required
  
  updated_by string Required
  
  query string Required
  
  EQL query to execute
  
  threat_index array[string] Required
  
  threat_mapping array[object] Required
  
  At least 1 element.
  
  Hide threat_mapping attribute Show threat_mapping attribute object
  
  entries array[object] Required
  
  Hide entries attributes Show entries attributes object
  
  field string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  type string Required
  
  Value is mapping.
  
  value string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  threat_query string Required
  
  Query to run
  
  type string Required Discriminator
  
  Rule type
  
  Value is threat_match.
  
  alert_suppression object
  
  Hide alert_suppression attributes Show alert_suppression attributes object
  
  duration object
  
  Hide duration attributes Show duration attributes object
  
  unit string Required
  
  Values are s, m, or h.
  
  value integer Required
  
  Minimum value is 1.
  
  group_by array[string] Required
  
  At least 1 but not more than 3 elements.
  
  missing_fields_strategy string
  
  Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
  
  Values are doNotSuppress or suppress.
  
  concurrent_searches integer
  
  Minimum value is 1.
  
  data_view_id string
  
  filters array
  
  index array[string]
  
  items_per_search integer
  
  Minimum value is 1.
  
  saved_id string
  
  threat_filters array
  
  Query and filter context array used to filter documents from the Elasticsearch index containing the threat values
  
  threat_indicator_path string
  
  Defines the path to the threat indicator in the indicator documents (optional)
  
  threat_language string
  
  Values are kuery or lucene.
  
  language string Required
  
  Values are kuery or lucene.
  
  Hide attributes Show attributes
  
  actions array[object] Required
  
  Hide actions attributes Show actions attributes object
  
  action_type_id string Required
  
  The action type used for sending notifications.
  
  alerts_filter object
  
  Hide alerts_filter attribute Show alerts_filter attribute object
  
  Additional properties are allowed
  
  frequency object
  
  The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
  
  Hide frequency attributes Show frequency attributes object
  
  notifyWhen string Required
  
  The condition for throttling the notification: onActionGroupChange, onActiveAlert, or onThrottleInterval
  
  Values are onActiveAlert, onThrottleInterval, or onActionGroupChange.
  
  summary boolean Required
  
  Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
  
  throttle string | null Required
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  group string
  
  Optionally groups actions by use cases. Use default for alert notifications.
  
  id string Required
  
  The connector ID.
  
  params object Required
  
  Object containing the allowed connector fields, which varies according to the connector type.
  
  Hide params attribute Show params attribute object
  
  Additional properties are allowed
  
  uuid string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  alias_purpose string
  
  Values are savedObjectConversion or savedObjectImport.
  
  alias_target_id string
  
  author array[string] Required
  
  building_block_type string
  
  Determines if the rule acts as a building block. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. Its value must be default.
  
  description string Required
  
  Minimum length is 1.
  
  enabled boolean Required
  
  Determines whether the rule is enabled.
  
  exceptions_list array[object] Required
  
  Hide exceptions_list attributes Show exceptions_list attributes object
  
  id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  list_id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  namespace_type string Required
  
  Determines the exceptions validity in rule's Kibana space
  
  Values are agnostic or single.
  
  type string Required
  
  The exception type
  
  Values are detection, rule_default, endpoint, endpoint_trusted_apps, endpoint_events, endpoint_host_isolation_exceptions, or endpoint_blocklists.
  
  false_positives array[string] Required
  
  from string(date-math) Required
  
  Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
  
  interval string Required
  
  Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
  
  investigation_fields object
  
  Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert. Added in PR #163235 Right now we only have a single field but anticipate adding more related fields to store various configuration states such as override - where a user might say if they want only these fields to display, or if they want these fields + the fields we select. When expanding this field, it may look something like:
  
  const investigationFields = z.object({ field_names: NonEmptyArray(NonEmptyString), override: z.boolean().optional(), });
  
  Hide investigation_fields attribute Show investigation_fields attribute object
  
  field_names array[string] Required
  
  A string that is not empty and does not contain only whitespace
  
  At least 1 element. Minimum length of each is 1. Format of each should match the following pattern: ^(?! *$).+$.
  
  license string
  
  The rule's license.
  
  max_signals integer Required
  
  Minimum value is 1.
  
  meta object
  
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed
  
  name string Required
  
  Minimum length is 1.
  
  namespace string
  
  Has no effect.
  
  note string
  
  Notes to help investigate alerts produced by the rule.
  
  outcome string
  
  Values are exactMatch, aliasMatch, or conflict.
  
  output_index string Deprecated
  
  (deprecated) Has no effect.
  
  references array[string] Required
  
  related_integrations array[object] Required
  
  Hide related_integrations attributes Show related_integrations attributes object
  
  Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
  
  NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
  
  Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
  
  package: name of the package (required, unique id)
  
  version: version of the package (required, semver-compatible)
  
  integration: name of the integration of this package (optional, id within the package)
  
  There are Fleet packages like windows that contain only one integration; in this case, integration should be unspecified. There are also packages like aws and azure that contain several integrations; in this case, integration should be specified.
  
  @example const x: RelatedIntegration = { package: 'windows', version: '1.5.x', };
  
  @example const x: RelatedIntegration = { package: 'azure', version: '~1.1.6', integration: 'activitylogs', };
  
  integration string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  package string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  version string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  required_fields array[object] Required
  
  Hide required_fields attributes Show required_fields attributes object
  
  Describes an Elasticsearch field that is needed for the rule to function.
  
  Almost all types of Security rules check source event documents for a match to some kind of query or filter. If a document has certain field with certain values, then it's a match and the rule will generate an alert.
  
  Required field is an event field that must be present in the source indices of a given rule.
  
  @example const standardEcsField: RequiredField = { name: 'event.action', type: 'keyword', ecs: true, };
  
  @example const nonEcsField: RequiredField = { name: 'winlog.event_data.AttributeLDAPDisplayName', type: 'keyword', ecs: false, };
  
  ecs boolean Required
  
  Whether the field is an ECS field
  
  name string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  type string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  risk_score integer Required
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  risk_score_mapping array[object] Required
  
  Overrides generated alerts' risk_score with a value from the source event
  
  Hide risk_score_mapping attributes Show risk_score_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  risk_score integer
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  value string Required
  
  rule_name_override string
  
  Sets the source field for the alert's signal.rule.name value
  
  setup string Required
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  severity_mapping array[object] Required
  
  Overrides generated alerts' severity with values from the source event
  
  Hide severity_mapping attributes Show severity_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  value string Required
  
  tags array[string] Required
  
  String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
  
  threat array[object] Required
  
  Hide threat attributes Show threat attributes object
  
  framework string Required
  
  Relevant attack framework
  
  tactic object Required
  
  Hide tactic attributes Show tactic attributes object
  
  id string Required
  
  Tactic ID
  
  name string Required
  
  Tactic name
  
  reference string Required
  
  Tactic reference
  
  technique array[object]
  
  Array containing information on the attack techniques (optional)
  
  Hide technique attributes Show technique attributes object
  
  id string Required
  
  Technique ID
  
  name string Required
  
  Technique name
  
  reference string Required
  
  Technique reference
  
  subtechnique array[object]
  
  Array containing more specific information on the attack technique
  
  Hide subtechnique attributes Show subtechnique attributes object
  
  id string Required
  
  Subtechnique ID
  
  name string Required
  
  Subtechnique name
  
  reference string Required
  
  Subtechnique reference
  
  throttle string | null
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  timeline_id string
  
  Timeline template ID
  
  timeline_title string
  
  Timeline template title
  
  timestamp_override string
  
  Sets the time field used to query indices
  
  timestamp_override_fallback_disabled boolean
  
  Disables the fallback to the event's @timestamp field
  
  to string Required
  
  version integer Required
  
  The rule's version number.
  
  Minimum value is 1.
  
  created_at string(date-time) Required
  
  created_by string Required
  
  execution_summary object
  
  Hide execution_summary attribute Show execution_summary attribute object
  
  last_execution object Required
  
  Hide last_execution attributes Show last_execution attributes object
  
  date string(date-time) Required
  
  Date of the last execution
  
  message string Required
  
  metrics object Required
  
  Hide metrics attributes Show metrics attributes object
  
  execution_gap_duration_s integer
  
  Duration in seconds of execution gap
  
  Minimum value is 0.
  
  total_enrichment_duration_ms integer
  
  Total time spent enriching documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_indexing_duration_ms integer
  
  Total time spent indexing documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_search_duration_ms integer
  
  Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
  
  Minimum value is 0.
  
  status string Required
  
  Status of the last execution
  
  Values are going to run, running, partial failure, failed, or succeeded.
  
  status_order integer Required
  
  id string(uuid) Required
  
  A universally unique identifier
  
  immutable boolean Required Deprecated
  
  This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the rule_source field.
  
  revision integer Required
  
  Minimum value is 0.
  
  rule_id string Required
  
  Could be any string, not necessarily a UUID
  
  rule_source object
  
  Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
  
  One of:
  Security_Solution_Detections_API_ExternalRuleSource object Security_Solution_Detections_API_InternalRuleSource object
  
  Type of rule source for externally sourced rules, i.e. rules that have an external source, such as the Elastic Prebuilt rules repo.
  
  Hide attributes Show attributes
  
  is_customized boolean Required
  
  Determines whether an external/prebuilt rule has been customized by the user (i.e. any of its fields have been modified and diverged from the base value).
  
  type string Required Discriminator
  
  Value is external.
  
  updated_at string(date-time) Required
  
  updated_by string Required
  
  anomaly_threshold integer Required
  
  Anomaly threshold
  
  Minimum value is 0.
  
  machine_learning_job_id string | array[string] Required
  
  Machine learning job ID
  
  One of:
  string-1 string array-2 array[string]
  
  At least 1 element.
  
  type string Required Discriminator
  
  Rule type
  
  Value is machine_learning.
  
  alert_suppression object
  
  Hide alert_suppression attributes Show alert_suppression attributes object
  
  duration object
  
  Hide duration attributes Show duration attributes object
  
  unit string Required
  
  Values are s, m, or h.
  
  value integer Required
  
  Minimum value is 1.
  
  group_by array[string] Required
  
  At least 1 but not more than 3 elements.
  
  missing_fields_strategy string
  
  Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
  
  Values are doNotSuppress or suppress.
  
  Hide attributes Show attributes
  
  actions array[object] Required
  
  Hide actions attributes Show actions attributes object
  
  action_type_id string Required
  
  The action type used for sending notifications.
  
  alerts_filter object
  
  Hide alerts_filter attribute Show alerts_filter attribute object
  
  Additional properties are allowed
  
  frequency object
  
  The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
  
  Hide frequency attributes Show frequency attributes object
  
  notifyWhen string Required
  
  The condition for throttling the notification: onActionGroupChange, onActiveAlert, or onThrottleInterval
  
  Values are onActiveAlert, onThrottleInterval, or onActionGroupChange.
  
  summary boolean Required
  
  Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
  
  throttle string | null Required
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  group string
  
  Optionally groups actions by use cases. Use default for alert notifications.
  
  id string Required
  
  The connector ID.
  
  params object Required
  
  Object containing the allowed connector fields, which varies according to the connector type.
  
  Hide params attribute Show params attribute object
  
  Additional properties are allowed
  
  uuid string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  alias_purpose string
  
  Values are savedObjectConversion or savedObjectImport.
  
  alias_target_id string
  
  author array[string] Required
  
  building_block_type string
  
  Determines if the rule acts as a building block. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. Its value must be default.
  
  description string Required
  
  Minimum length is 1.
  
  enabled boolean Required
  
  Determines whether the rule is enabled.
  
  exceptions_list array[object] Required
  
  Hide exceptions_list attributes Show exceptions_list attributes object
  
  id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  list_id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  namespace_type string Required
  
  Determines the exceptions validity in rule's Kibana space
  
  Values are agnostic or single.
  
  type string Required
  
  The exception type
  
  Values are detection, rule_default, endpoint, endpoint_trusted_apps, endpoint_events, endpoint_host_isolation_exceptions, or endpoint_blocklists.
  
  false_positives array[string] Required
  
  from string(date-math) Required
  
  Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
  
  interval string Required
  
  Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
  
  investigation_fields object
  
  Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert. Added in PR #163235 Right now we only have a single field but anticipate adding more related fields to store various configuration states such as override - where a user might say if they want only these fields to display, or if they want these fields + the fields we select. When expanding this field, it may look something like:
  
  const investigationFields = z.object({ field_names: NonEmptyArray(NonEmptyString), override: z.boolean().optional(), });
  
  Hide investigation_fields attribute Show investigation_fields attribute object
  
  field_names array[string] Required
  
  A string that is not empty and does not contain only whitespace
  
  At least 1 element. Minimum length of each is 1. Format of each should match the following pattern: ^(?! *$).+$.
  
  license string
  
  The rule's license.
  
  max_signals integer Required
  
  Minimum value is 1.
  
  meta object
  
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed
  
  name string Required
  
  Minimum length is 1.
  
  namespace string
  
  Has no effect.
  
  note string
  
  Notes to help investigate alerts produced by the rule.
  
  outcome string
  
  Values are exactMatch, aliasMatch, or conflict.
  
  output_index string Deprecated
  
  (deprecated) Has no effect.
  
  references array[string] Required
  
  related_integrations array[object] Required
  
  Hide related_integrations attributes Show related_integrations attributes object
  
  Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
  
  NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
  
  Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
  
  package: name of the package (required, unique id)
  
  version: version of the package (required, semver-compatible)
  
  integration: name of the integration of this package (optional, id within the package)
  
  There are Fleet packages like windows that contain only one integration; in this case, integration should be unspecified. There are also packages like aws and azure that contain several integrations; in this case, integration should be specified.
  
  @example const x: RelatedIntegration = { package: 'windows', version: '1.5.x', };
  
  @example const x: RelatedIntegration = { package: 'azure', version: '~1.1.6', integration: 'activitylogs', };
  
  integration string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  package string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  version string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  required_fields array[object] Required
  
  Hide required_fields attributes Show required_fields attributes object
  
  Describes an Elasticsearch field that is needed for the rule to function.
  
  Almost all types of Security rules check source event documents for a match to some kind of query or filter. If a document has certain field with certain values, then it's a match and the rule will generate an alert.
  
  Required field is an event field that must be present in the source indices of a given rule.
  
  @example const standardEcsField: RequiredField = { name: 'event.action', type: 'keyword', ecs: true, };
  
  @example const nonEcsField: RequiredField = { name: 'winlog.event_data.AttributeLDAPDisplayName', type: 'keyword', ecs: false, };
  
  ecs boolean Required
  
  Whether the field is an ECS field
  
  name string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  type string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  risk_score integer Required
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  risk_score_mapping array[object] Required
  
  Overrides generated alerts' risk_score with a value from the source event
  
  Hide risk_score_mapping attributes Show risk_score_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  risk_score integer
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  value string Required
  
  rule_name_override string
  
  Sets the source field for the alert's signal.rule.name value
  
  setup string Required
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  severity_mapping array[object] Required
  
  Overrides generated alerts' severity with values from the source event
  
  Hide severity_mapping attributes Show severity_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  value string Required
  
  tags array[string] Required
  
  String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
  
  threat array[object] Required
  
  Hide threat attributes Show threat attributes object
  
  framework string Required
  
  Relevant attack framework
  
  tactic object Required
  
  Hide tactic attributes Show tactic attributes object
  
  id string Required
  
  Tactic ID
  
  name string Required
  
  Tactic name
  
  reference string Required
  
  Tactic reference
  
  technique array[object]
  
  Array containing information on the attack techniques (optional)
  
  Hide technique attributes Show technique attributes object
  
  id string Required
  
  Technique ID
  
  name string Required
  
  Technique name
  
  reference string Required
  
  Technique reference
  
  subtechnique array[object]
  
  Array containing more specific information on the attack technique
  
  Hide subtechnique attributes Show subtechnique attributes object
  
  id string Required
  
  Subtechnique ID
  
  name string Required
  
  Subtechnique name
  
  reference string Required
  
  Subtechnique reference
  
  throttle string | null
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  timeline_id string
  
  Timeline template ID
  
  timeline_title string
  
  Timeline template title
  
  timestamp_override string
  
  Sets the time field used to query indices
  
  timestamp_override_fallback_disabled boolean
  
  Disables the fallback to the event's @timestamp field
  
  to string Required
  
  version integer Required
  
  The rule's version number.
  
  Minimum value is 1.
  
  created_at string(date-time) Required
  
  created_by string Required
  
  execution_summary object
  
  Hide execution_summary attribute Show execution_summary attribute object
  
  last_execution object Required
  
  Hide last_execution attributes Show last_execution attributes object
  
  date string(date-time) Required
  
  Date of the last execution
  
  message string Required
  
  metrics object Required
  
  Hide metrics attributes Show metrics attributes object
  
  execution_gap_duration_s integer
  
  Duration in seconds of execution gap
  
  Minimum value is 0.
  
  total_enrichment_duration_ms integer
  
  Total time spent enriching documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_indexing_duration_ms integer
  
  Total time spent indexing documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_search_duration_ms integer
  
  Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
  
  Minimum value is 0.
  
  status string Required
  
  Status of the last execution
  
  Values are going to run, running, partial failure, failed, or succeeded.
  
  status_order integer Required
  
  id string(uuid) Required
  
  A universally unique identifier
  
  immutable boolean Required Deprecated
  
  This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the rule_source field.
  
  revision integer Required
  
  Minimum value is 0.
  
  rule_id string Required
  
  Could be any string, not necessarily a UUID
  
  rule_source object
  
  Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
  
  One of:
  Security_Solution_Detections_API_ExternalRuleSource object Security_Solution_Detections_API_InternalRuleSource object
  
  Type of rule source for externally sourced rules, i.e. rules that have an external source, such as the Elastic Prebuilt rules repo.
  
  Hide attributes Show attributes
  
  is_customized boolean Required
  
  Determines whether an external/prebuilt rule has been customized by the user (i.e. any of its fields have been modified and diverged from the base value).
  
  type string Required Discriminator
  
  Value is external.
  
  updated_at string(date-time) Required
  
  updated_by string Required
  
  history_window_start string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  new_terms_fields array[string] Required
  
  At least 1 but not more than 3 elements.
  
  query string Required
  
  EQL query to execute
  
  type string Required Discriminator
  
  Rule type
  
  Value is new_terms.
  
  alert_suppression object
  
  Hide alert_suppression attributes Show alert_suppression attributes object
  
  duration object
  
  Hide duration attributes Show duration attributes object
  
  unit string Required
  
  Values are s, m, or h.
  
  value integer Required
  
  Minimum value is 1.
  
  group_by array[string] Required
  
  At least 1 but not more than 3 elements.
  
  missing_fields_strategy string
  
  Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
  
  Values are doNotSuppress or suppress.
  
  data_view_id string
  
  filters array
  
  index array[string]
  
  language string Required
  
  Values are kuery or lucene.
  
  Hide attributes Show attributes
  
  actions array[object] Required
  
  Hide actions attributes Show actions attributes object
  
  action_type_id string Required
  
  The action type used for sending notifications.
  
  alerts_filter object
  
  Hide alerts_filter attribute Show alerts_filter attribute object
  
  Additional properties are allowed
  
  frequency object
  
  The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
  
  Hide frequency attributes Show frequency attributes object
  
  notifyWhen string Required
  
  The condition for throttling the notification: onActionGroupChange, onActiveAlert, or onThrottleInterval
  
  Values are onActiveAlert, onThrottleInterval, or onActionGroupChange.
  
  summary boolean Required
  
  Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
  
  throttle string | null Required
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  group string
  
  Optionally groups actions by use cases. Use default for alert notifications.
  
  id string Required
  
  The connector ID.
  
  params object Required
  
  Object containing the allowed connector fields, which varies according to the connector type.
  
  Hide params attribute Show params attribute object
  
  Additional properties are allowed
  
  uuid string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  alias_purpose string
  
  Values are savedObjectConversion or savedObjectImport.
  
  alias_target_id string
  
  author array[string] Required
  
  building_block_type string
  
  Determines if the rule acts as a building block. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. Its value must be default.
  
  description string Required
  
  Minimum length is 1.
  
  enabled boolean Required
  
  Determines whether the rule is enabled.
  
  exceptions_list array[object] Required
  
  Hide exceptions_list attributes Show exceptions_list attributes object
  
  id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  list_id string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  namespace_type string Required
  
  Determines the exceptions validity in rule's Kibana space
  
  Values are agnostic or single.
  
  type string Required
  
  The exception type
  
  Values are detection, rule_default, endpoint, endpoint_trusted_apps, endpoint_events, endpoint_host_isolation_exceptions, or endpoint_blocklists.
  
  false_positives array[string] Required
  
  from string(date-math) Required
  
  Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
  
  interval string Required
  
  Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
  
  investigation_fields object
  
  Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert. Added in PR #163235 Right now we only have a single field but anticipate adding more related fields to store various configuration states such as override - where a user might say if they want only these fields to display, or if they want these fields + the fields we select. When expanding this field, it may look something like:
  
  const investigationFields = z.object({ field_names: NonEmptyArray(NonEmptyString), override: z.boolean().optional(), });
  
  Hide investigation_fields attribute Show investigation_fields attribute object
  
  field_names array[string] Required
  
  A string that is not empty and does not contain only whitespace
  
  At least 1 element. Minimum length of each is 1. Format of each should match the following pattern: ^(?! *$).+$.
  
  license string
  
  The rule's license.
  
  max_signals integer Required
  
  Minimum value is 1.
  
  meta object
  
  Hide meta attribute Show meta attribute object
  
  Additional properties are allowed
  
  name string Required
  
  Minimum length is 1.
  
  namespace string
  
  Has no effect.
  
  note string
  
  Notes to help investigate alerts produced by the rule.
  
  outcome string
  
  Values are exactMatch, aliasMatch, or conflict.
  
  output_index string Deprecated
  
  (deprecated) Has no effect.
  
  references array[string] Required
  
  related_integrations array[object] Required
  
  Hide related_integrations attributes Show related_integrations attributes object
  
  Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
  
  NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
  
  Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
  
  package: name of the package (required, unique id)
  
  version: version of the package (required, semver-compatible)
  
  integration: name of the integration of this package (optional, id within the package)
  
  There are Fleet packages like windows that contain only one integration; in this case, integration should be unspecified. There are also packages like aws and azure that contain several integrations; in this case, integration should be specified.
  
  @example const x: RelatedIntegration = { package: 'windows', version: '1.5.x', };
  
  @example const x: RelatedIntegration = { package: 'azure', version: '~1.1.6', integration: 'activitylogs', };
  
  integration string
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  package string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  version string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  required_fields array[object] Required
  
  Hide required_fields attributes Show required_fields attributes object
  
  Describes an Elasticsearch field that is needed for the rule to function.
  
  Almost all types of Security rules check source event documents for a match to some kind of query or filter. If a document has certain field with certain values, then it's a match and the rule will generate an alert.
  
  Required field is an event field that must be present in the source indices of a given rule.
  
  @example const standardEcsField: RequiredField = { name: 'event.action', type: 'keyword', ecs: true, };
  
  @example const nonEcsField: RequiredField = { name: 'winlog.event_data.AttributeLDAPDisplayName', type: 'keyword', ecs: false, };
  
  ecs boolean Required
  
  Whether the field is an ECS field
  
  name string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  type string Required
  
  A string that is not empty and does not contain only whitespace
  
  Minimum length is 1. Format should match the following pattern: ^(?! *$).+$.
  
  risk_score integer Required
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  risk_score_mapping array[object] Required
  
  Overrides generated alerts' risk_score with a value from the source event
  
  Hide risk_score_mapping attributes Show risk_score_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  risk_score integer
  
  Risk score (0 to 100)
  
  Minimum value is 0, maximum value is 100.
  
  value string Required
  
  rule_name_override string
  
  Sets the source field for the alert's signal.rule.name value
  
  setup string Required
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  severity_mapping array[object] Required
  
  Overrides generated alerts' severity with values from the source event
  
  Hide severity_mapping attributes Show severity_mapping attributes object
  
  field string Required
  
  operator string Required
  
  Value is equals.
  
  severity string Required
  
  Severity of the rule
  
  Values are low, medium, high, or critical.
  
  value string Required
  
  tags array[string] Required
  
  String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
  
  threat array[object] Required
  
  Hide threat attributes Show threat attributes object
  
  framework string Required
  
  Relevant attack framework
  
  tactic object Required
  
  Hide tactic attributes Show tactic attributes object
  
  id string Required
  
  Tactic ID
  
  name string Required
  
  Tactic name
  
  reference string Required
  
  Tactic reference
  
  technique array[object]
  
  Array containing information on the attack techniques (optional)
  
  Hide technique attributes Show technique attributes object
  
  id string Required
  
  Technique ID
  
  name string Required
  
  Technique name
  
  reference string Required
  
  Technique reference
  
  subtechnique array[object]
  
  Array containing more specific information on the attack technique
  
  Hide subtechnique attributes Show subtechnique attributes object
  
  id string Required
  
  Subtechnique ID
  
  name string Required
  
  Subtechnique name
  
  reference string Required
  
  Subtechnique reference
  
  throttle string | null
  
  Defines how often rule actions are taken.
  
  One of:
  string-1 string | null string-2 string | null
  
  Values are no_actions or rule.
  
  Time interval in seconds, minutes, hours, or days.
  
  Format should match the following pattern: ^[1-9]\d*[smhd]$.
  
  timeline_id string
  
  Timeline template ID
  
  timeline_title string
  
  Timeline template title
  
  timestamp_override string
  
  Sets the time field used to query indices
  
  timestamp_override_fallback_disabled boolean
  
  Disables the fallback to the event's @timestamp field
  
  to string Required
  
  version integer Required
  
  The rule's version number.
  
  Minimum value is 1.
  
  created_at string(date-time) Required
  
  created_by string Required
  
  execution_summary object
  
  Hide execution_summary attribute Show execution_summary attribute object
  
  last_execution object Required
  
  Hide last_execution attributes Show last_execution attributes object
  
  date string(date-time) Required
  
  Date of the last execution
  
  message string Required
  
  metrics object Required
  
  Hide metrics attributes Show metrics attributes object
  
  execution_gap_duration_s integer
  
  Duration in seconds of execution gap
  
  Minimum value is 0.
  
  total_enrichment_duration_ms integer
  
  Total time spent enriching documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_indexing_duration_ms integer
  
  Total time spent indexing documents during current rule execution cycle
  
  Minimum value is 0.
  
  total_search_duration_ms integer
  
  Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
  
  Minimum value is 0.
  
  status string Required
  
  Status of the last execution
  
  Values are going to run, running, partial failure, failed, or succeeded.
  
  status_order integer Required
  
  id string(uuid) Required
  
  A universally unique identifier
  
  immutable boolean Required Deprecated
  
  This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the rule_source field.
  
  revision integer Required
  
  Minimum value is 0.
  
  rule_id string Required
  
  Could be any string, not necessarily a UUID
  
  rule_source object
  
  Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
  
  One of:
  Security_Solution_Detections_API_ExternalRuleSource object Security_Solution_Detections_API_InternalRuleSource object
  
  Type of rule source for externally sourced rules, i.e. rules that have an external source, such as the Elastic Prebuilt rules repo.
  
  Hide attributes Show attributes
  
  is_customized boolean Required
  
  Determines whether an external/prebuilt rule has been customized by the user (i.e. any of its fields have been modified and diverged from the base value).
  
  type string Required Discriminator
  
  Value is external.
  
  updated_at string(date-time) Required
  
  updated_by string Required
  
  alert_suppression object
  
  Hide alert_suppression attributes Show alert_suppression attributes object
  
  duration object
  
  Hide duration attributes Show duration attributes object
  
  unit string Required
  
  Values are s, m, or h.
  
  value integer Required
  
  Minimum value is 1.
  
  group_by array[string] Required
  
  At least 1 but not more than 3 elements.
  
  missing_fields_strategy string
  
  Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
  
  Values are doNotSuppress or suppress.
  
  language string Required
  
  Value is esql.
  
  query string Required
  
  EQL query to execute
  
  type string Required Discriminator
  
  Rule type
  
  Value is esql.
- page integer Required
- perPage integer Required
- total integer Required

GET /api/detection_engine/rules/_find

curl \
 -X GET http://api.example.com/api/detection_engine/rules/_find

Response examples (200)

{
  "data": [
    {
      "actions": [
        {
          "action_type_id": "string",
          "alerts_filter": {},
          "frequency": {
            "notifyWhen": "onActiveAlert",
            "summary": true,
            "throttle": "no_actions"
          },
          "group": "string",
          "id": "string",
          "params": {},
          "uuid": "string"
        }
      ],
      "alias_purpose": "savedObjectConversion",
      "alias_target_id": "string",
      "author": [
        "string"
      ],
      "building_block_type": "string",
      "description": "string",
      "enabled": true,
      "exceptions_list": [
        {
          "id": "string",
          "list_id": "string",
          "namespace_type": "agnostic",
          "type": "detection"
        }
      ],
      "false_positives": [
        "string"
      ],
      "from": "string",
      "interval": "string",
      "investigation_fields": {
        "field_names": [
          "string"
        ]
      },
      "license": "string",
      "max_signals": 42,
      "meta": {},
      "name": "string",
      "namespace": "string",
      "note": "string",
      "outcome": "exactMatch",
      "output_index": "string",
      "references": [
        "string"
      ],
      "related_integrations": [
        {
          "integration": "string",
          "package": "string",
          "version": "string"
        }
      ],
      "required_fields": [
        {
          "ecs": true,
          "name": "string",
          "type": "string"
        }
      ],
      "risk_score": 42,
      "risk_score_mapping": [
        {
          "field": "string",
          "operator": "equals",
          "risk_score": 42,
          "value": "string"
        }
      ],
      "rule_name_override": "string",
      "setup": "string",
      "severity": "low",
      "severity_mapping": [
        {
          "field": "string",
          "operator": "equals",
          "severity": "low",
          "value": "string"
        }
      ],
      "tags": [
        "string"
      ],
      "threat": [
        {
          "framework": "string",
          "tactic": {
            "id": "string",
            "name": "string",
            "reference": "string"
          },
          "technique": [
            {
              "id": "string",
              "name": "string",
              "reference": "string",
              "subtechnique": [
                {
                  "id": "string",
                  "name": "string",
                  "reference": "string"
                }
              ]
            }
          ]
        }
      ],
      "throttle": "no_actions",
      "timeline_id": "string",
      "timeline_title": "string",
      "timestamp_override": "string",
      "timestamp_override_fallback_disabled": true,
      "to": "string",
      "version": 42,
      "created_at": "2024-05-04T09:42:00+00:00",
      "created_by": "string",
      "execution_summary": {
        "last_execution": {
          "date": "2024-05-04T09:42:00+00:00",
          "message": "string",
          "metrics": {
            "execution_gap_duration_s": 42,
            "total_enrichment_duration_ms": 42,
            "total_indexing_duration_ms": 42,
            "total_search_duration_ms": 42
          },
          "status": "going to run",
          "status_order": 42
        }
      },
      "id": "string",
      "immutable": true,
      "revision": 42,
      "rule_id": "string",
      "rule_source": {
        "is_customized": true,
        "type": "external"
      },
      "updated_at": "2024-05-04T09:42:00+00:00",
      "updated_by": "string",
      "language": "eql",
      "query": "string",
      "type": "eql",
      "alert_suppression": {
        "duration": {
          "unit": "s",
          "value": 42
        },
        "group_by": [
          "string"
        ],
        "missing_fields_strategy": "doNotSuppress"
      },
      "data_view_id": "string",
      "event_category_override": "string",
      "filters": [],
      "index": [
        "string"
      ],
      "tiebreaker_field": "string",
      "timestamp_field": "string"
    }
  ],
  "page": 42,
  "perPage": 42,
  "total": 42
}

List all detection rules

Query parameters

Responses

throttle string | null Required

throttle string | null Required

value string | array[string]

value string | array[string]

throttle string | null Required

value string | array[string]

value string | array[string]

throttle string | null Required

throttle string | null Required

throttle string | null Required

throttle string | null Required

throttle string | null Required