Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Security][OpenAPI] Improve exceptions intro #201716

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion oas_docs/output/kibana.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,23 @@ tags:
- description: ''
name: Security Entity Analytics API
x-displayName: Security entity analytics
- description: Exceptions API allows you to manage detection rule exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met.
- description: |-
Exceptions are associated with detection and endpoint rules, and are used to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met. They can be used to reduce the number of false positives, and to prevent trusted processes and network activity from generating unnecessary alerts.

Exceptions are made up of:

* Exception containers: A container for related exceptions. In general, a single exception container contains all the exception items relevant for a subset of rules. For example, a container can be used to group together network-related exceptions that are relevant for a large number of network rules. The container can then be associated with all the relevant rules.
* Exception items: The query (fields, values, and logic) used to prevent rules from generating alerts. When an exception item's query evaluates to true, the rule does not generate an alert.
For detection rules, you can also use lists to define rule exceptions. A list holds multiple values of the same Elasticsearch data type, such as IP addresses, which are used to determine when an exception prevents an alert from being generated.

IMPORTANT: You cannot use lists with endpoint rule exceptions.

NOTE: Only exception containers can be associated with rules. You cannot directly associate an exception item or a list container with a rule. To use list exceptions, create an exception item that references the relevant list container.

## Exceptions requirements

Before you start working with exceptions that use value lists, you must create the `.lists` and `.items` data streams for the relevant Kibana space. To learn how to do this, go to Lists index endpoint.
Once these data streams are created, your role needs privileges to manage rules. Refer to Enable and access detections for a complete list of requirements.
name: Security Exceptions API
x-displayName: Security exceptions
- description: Lists API allows you to manage lists of keywords, IPs or IP ranges items.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1900,8 +1900,50 @@ security:
- BasicAuth: []
tags:
- description: >-
Exceptions API allows you to manage detection rule exceptions to prevent a
rule from generating an alert from incoming events even when the rule's
other criteria are met.
Exceptions are associated with detection and endpoint rules, and are used
to prevent a rule from generating an alert from incoming events even when
the rule's other criteria are met. They can be used to reduce the number
of false positives, and to prevent trusted processes and network activity
from generating unnecessary alerts.


Exceptions are made up of:


* Exception containers: A container for related exceptions. In general, a
single exception container contains all the exception items relevant for a
subset of rules. For example, a container can be used to group together
network-related exceptions that are relevant for a large number of network
rules. The container can then be associated with all the relevant rules.

* Exception items: The query (fields, values, and logic) used to prevent
rules from generating alerts. When an exception item's query evaluates to
true, the rule does not generate an alert.

For detection rules, you can also use lists to define rule exceptions. A
list holds multiple values of the same Elasticsearch data type, such as IP
addresses, which are used to determine when an exception prevents an alert
from being generated.


IMPORTANT: You cannot use lists with endpoint rule exceptions.


NOTE: Only exception containers can be associated with rules. You cannot
directly associate an exception item or a list container with a rule. To
use list exceptions, create an exception item that references the relevant
list container.


## Exceptions requirements


Before you start working with exceptions that use value lists, you must
create the `.lists` and `.items` data streams for the relevant Kibana
space. To learn how to do this, go to Lists index endpoint.

Once these data streams are created, your role needs privileges to manage
rules. Refer to Enable and access detections for a complete list of
requirements.
name: Security Exceptions API
x-displayName: Security exceptions
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ const ROOT = resolve(__dirname, '..');
name: 'Security Exceptions API',
'x-displayName': 'Security exceptions',
description:
"Exceptions API allows you to manage detection rule exceptions to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met.",
"Exceptions are associated with detection and endpoint rules, and are used to prevent a rule from generating an alert from incoming events even when the rule's other criteria are met. They can be used to reduce the number of false positives, and to prevent trusted processes and network activity from generating unnecessary alerts. \n\nExceptions are made up of:\n\n* Exception containers: A container for related exceptions. In general, a single exception container contains all the exception items relevant for a subset of rules. For example, a container can be used to group together network-related exceptions that are relevant for a large number of network rules. The container can then be associated with all the relevant rules.\n* Exception items: The query (fields, values, and logic) used to prevent rules from generating alerts. When an exception item's query evaluates to true, the rule does not generate an alert.\nFor detection rules, you can also use lists to define rule exceptions. A list holds multiple values of the same Elasticsearch data type, such as IP addresses, which are used to determine when an exception prevents an alert from being generated.\n\nIMPORTANT: You cannot use lists with endpoint rule exceptions.\n\nNOTE: Only exception containers can be associated with rules. You cannot directly associate an exception item or a list container with a rule. To use list exceptions, create an exception item that references the relevant list container.\n\n## Exceptions requirements\n\nBefore you start working with exceptions that use value lists, you must create the `.lists` and `.items` data streams for the relevant Kibana space. To learn how to do this, go to Lists index endpoint.\nOnce these data streams are created, your role needs privileges to manage rules. Refer to Enable and access detections for a complete list of requirements.",
},
],
},
Expand Down