IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› ›

Rule Fields

edit

Rule Fields

edit

Rule fields are used to capture the specifics of any observer or agent rules that generate alerts or other notable events.

Examples of data sources that would populate the rule fields include: network admission control platforms, network or host IDS/IPS, network firewalls, web application firewalls, url filters, endpoint detection and response (EDR) systems, etc.

Rule Field Details

edit

Field	Description	Level
rule.author	Name, organization, or pseudonym of the author or authors who created the rule used to generate this event. type: keyword Note: this field should contain an array of values. example: `['Star-Lord']`	extended
rule.category	A categorization value keyword used by the entity using the rule for detection of this event. type: keyword example: `Attempted Information Leak`	extended
rule.description	The description of the rule generating the event. type: keyword example: `Block requests to public DNS over HTTPS / TLS protocols`	extended
rule.id	A rule ID that is unique within the scope of an agent, observer, or other entity using the rule for detection of this event. type: keyword example: `101`	extended
rule.license	Name of the license under which the rule used to generate this event is made available. type: keyword example: `Apache 2.0`	extended
rule.name	The name of the rule or signature generating the event. type: keyword example: `BLOCK_DNS_over_TLS`	extended
rule.reference	Reference URL to additional information about the rule used to generate this event. The URL can point to the vendor’s documentation about the rule. If that’s not available, it can also be a link to a more general page describing this type of alert. type: keyword example: `https://en.wikipedia.org/wiki/DNS_over_TLS`	extended
rule.ruleset	Name of the ruleset, policy, group, or parent category in which the rule used to generate this event is a member. type: keyword example: `Standard_Protocol_Filters`	extended
rule.uuid	A rule ID that is unique within the scope of a set or group of agents, observers, or other entities using the rule for detection of this event. type: keyword example: `1100110011`	extended
rule.version	The version / revision of the rule being used for analysis. type: keyword example: `1.1`	extended

« Related Fields Server Fields »