-
Notifications
You must be signed in to change notification settings - Fork 206
[Detection Engine][Exceptions] - Update docs for single and shared exceptions #4021
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
Merged
Merged
Changes from all commits
Commits
Show all changes
42 commits
Select commit
Hold shift + click to select a range
8b32dfe
First draft
nastasha-solomon b5dbd1e
Fixed include
nastasha-solomon 8137100
Update/create exception changes
nastasha-solomon a2807ce
Update docs/detections/api/exceptions/api-create-rule-default-excepti…
nastasha-solomon d68218b
Revising intro
nastasha-solomon af1e023
Adding new topic
nastasha-solomon 7b8e8c3
Fixing refs
nastasha-solomon a772774
Removed duplicate entry
nastasha-solomon d1070c9
Yara's input
nastasha-solomon 007e759
Minor wording changes
nastasha-solomon 0ad87bd
Title update
nastasha-solomon d4da17a
Modifies title for shared exceptions
nastasha-solomon 6c3747c
Fixing conflicts
nastasha-solomon 8e76518
attempt number 2
nastasha-solomon 356b9c6
Added file ext to index file
nastasha-solomon 8b765a8
Closing table
nastasha-solomon fa50009
Update docs/detections/api/rules/rules-api-overview.asciidoc
nastasha-solomon 7083f94
Update docs/detections/api/rules/rules-api-create-rule-default-except…
nastasha-solomon b836b6d
Minor changes and notes
nastasha-solomon 52424a4
Fixed route in example
nastasha-solomon 580f433
Update docs/detections/api/rules/rules-api-create-rule-default-except…
nastasha-solomon 80f7417
Update docs/detections/api/rules/rules-api-create-single-rule-excepti…
nastasha-solomon 1ab1940
Update docs/detections/api/rules/rules-api-create-single-rule-excepti…
nastasha-solomon 9317b58
Remove comment chars
nastasha-solomon a32204d
Input from Yara
nastasha-solomon 600fec0
Refreshed params
nastasha-solomon f301ba1
minor style fixes
nastasha-solomon bf3a09f
Update docs/detections/api/rules/rules-api-create-rule-default-except…
nastasha-solomon 5e68b6e
Merge branch 'main' into issue-3491-exception-item-list
nastasha-solomon 8f55a33
Merge branch 'main' into issue-3491-exception-item-list
nastasha-solomon d88a02d
Merge branch 'main' into issue-3491-exception-item-list
nastasha-solomon 4f35260
Merge branch 'main' into issue-3491-exception-item-list
nastasha-solomon ed6e914
Update docs/detections/api/exceptions/api-create-exception-container.…
nastasha-solomon f952986
Update docs/detections/api/exceptions/api-update-exception-container.…
nastasha-solomon 4b45ed1
Update docs/detections/api/rules/rules-api-create-rule-default-except…
nastasha-solomon 8275775
Update docs/detections/api/rules/rules-api-create-rule-default-except…
nastasha-solomon 2b85ddb
Ben's suggestion
nastasha-solomon 404bc9d
Update docs/detections/api/rules/rules-api-overview.asciidoc
nastasha-solomon af5b351
Update docs/detections/api/rules/rules-api-create-single-rule-excepti…
nastasha-solomon e59785b
Merge branch 'main' into issue-3491-exception-item-list
nastasha-solomon 68d3cb3
Replaced container with list
nastasha-solomon 1cca3ee
fixed typo
nastasha-solomon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
104 changes: 104 additions & 0 deletions
104
docs/detections/api/rules/rules-api-create-rule-default-exception-list.asciidoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| [[exceptions-api-create-rule-default-exception-list]] | ||
| === Create default exception list for a rule | ||
|
|
||
| Creates a default exception list for the rule you specify. | ||
|
|
||
| To add exception items to a default exception list, pass in exceptions items that you want applied to the rule. Refer to <<exceptions-api-create-rule-default-exception-item>> for more information. | ||
|
|
||
| When an exception item’s query evaluates to `true`, the associated rule does not issue alerts even when its other criteria are met. | ||
nastasha-solomon marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| NOTE: Default exception lists do not display on the **Shared Exception Lists** page in the {security-app} UI; they only appear in the Rule exceptions on the rule details page. This is because default exception lists can only be associated with a single rule. Refer to <<manage-exception>> to learn more. | ||
|
|
||
| ==== Request URL | ||
|
|
||
| `POST <kibana host>:<port>/api/detection_engine/<rule_id>/exceptions` | ||
|
|
||
| ==== Request body | ||
|
|
||
| A JSON object with these fields: | ||
|
|
||
| [width="100%",options="header"] | ||
| |============================================== | ||
| |Name |Type |Description |Required | ||
|
|
||
| |`description` |String |Describes the exception list. |Yes | ||
| |`list_id` |String |Unique identifier. |No, automatically created when it is not | ||
| provided. | ||
| |`meta` |Object |Placeholder for metadata about the exception list. |No | ||
| |`name` |String |The exception list's name. |Yes | ||
| |`namespace_type` |String a|Determines whether the exception list is available in all {kib} spaces or just the space in which it is created, where: | ||
|
|
||
| * `single`: Only available in the {kib} space in which it is created. | ||
| * `agnostic`: Available in all {kib} spaces. | ||
|
|
||
| |No, defaults to `single`. | ||
| |`tags` |String[] |String array containing words and phrases to help categorize | ||
| exception lists. |No | ||
| |`type` |String a|The type of exception, which must be: | ||
|
|
||
| * `rule_default`: Exception list that belongs to a single rule. | ||
|
|
||
| |Yes | ||
|
|
||
| |============================================== | ||
|
|
||
| ===== Example requests | ||
|
|
||
| Creates an exception list for holding trusted Linux process exception | ||
| items: | ||
|
|
||
| [source,console] | ||
| -------------------------------------------------- | ||
| POST api/detection_engine/<rule_id>/exceptions | ||
| { | ||
| "description": "Excludes Linux trusted processes", | ||
| "name": "Linux process exceptions", | ||
| "list_id": "trusted-linux-processes", | ||
| "type": "detection", | ||
| "namespace_type": "single", | ||
| "tags": [ | ||
| "linux", | ||
| "processes" | ||
| ] | ||
| } | ||
| -------------------------------------------------- | ||
| // KIBANA | ||
|
|
||
| ==== Response code | ||
|
|
||
| `200`:: | ||
| Indicates a successful call. | ||
|
|
||
|
|
||
| ==== Response payload | ||
|
|
||
| The exception list object with a unique ID. | ||
|
|
||
| [source,json] | ||
| -------------------------------------------------- | ||
| { | ||
| "_tags": [], | ||
| "created_at": "2020-07-13T09:33:46.187Z", | ||
| "created_by": "elastic", | ||
| "description": "Excludes Linux trusted processes", | ||
| "id": "f320c070-c4eb-11ea-80bb-11861bae2798", <1> | ||
| "list_id": "trusted-linux-processes", <2> | ||
| "name": "Linux process exceptions", | ||
| "namespace_type": "single", <3> | ||
| "tags": [ | ||
| "linux", | ||
| "processes" | ||
| ], | ||
| "tie_breaker_id": "2c08d5a5-2ecc-4d5a-acfb-0a367f25b3f3", | ||
| "type": "detection", <4> | ||
| "updated_at": "2020-07-13T09:33:46.359Z", | ||
| "updated_by": "elastic" | ||
| } | ||
| -------------------------------------------------- | ||
|
|
||
| The highlighted values can help you identify detection rules associated with the exception list: | ||
|
|
||
| <1> `id` | ||
| <2> `list_id` | ||
| <3> `namespace_type` | ||
| <4> `type` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@caitlinbetz is this still accurate? I know we opened endpoint exceptions up to have less field restrictions, not sure if these still hold.