-
Notifications
You must be signed in to change notification settings - Fork 191
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1f365c1
commit 206f23d
Showing
3 changed files
with
106 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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 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
103 changes: 103 additions & 0 deletions
103
docs/detections/api/exceptions/api-create-rule-default-exception-list.asciidoc
This file contains 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,103 @@ | ||
[[exceptions-api-create-rule-default-exception-list]] | ||
=== Create exception list for an individual rule | ||
|
||
Creates a rule default exception list. | ||
|
||
An exception list groups <<exceptions-api-create-exception-item, exception items>> and a rule default list is associated with a single rule. When an exception item’s query evaluates to true, the associated rule does not issue alerts even when its other criteria are met. | ||
|
||
A rule default exception list can apply to a single detection rule. To add to a rule's default exception list, simply pass in the exception items you would like to be applied to the rule. If a default exception list does not yet exist for the rule, one will be created and the exception added. | ||
|
||
==== Request URL | ||
|
||
`POST <kibana host>:<port>/api/exception_lists` | ||
|
||
==== Request body | ||
|
||
A JSON object with these fields: | ||
|
||
[width="100%",options="header"] | ||
|============================================== | ||
|Name |Type |Description |Required | ||
|
||
|`description` |String |Describes the exception container. |Yes | ||
|`list_id` |String |Unique identifier. |No, automatically created when it is not | ||
provided. | ||
|`meta` |Object |Placeholder for metadata about the list container. |No | ||
|`name` |String |The exception container's name. |Yes | ||
|`namespace_type` |String a|Determines whether the exception container 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 containers. |No | ||
|`type` |String a|The type of exception, which must be: | ||
|
||
* `rule_default`: Exception that belongs to a single rule | ||
|
||
|Yes | ||
|
||
|============================================== | ||
|
||
===== Example requests | ||
|
||
Creates an exception container for holding trusted Linux process exception | ||
items: | ||
|
||
[source,console] | ||
-------------------------------------------------- | ||
POST api/exception_lists | ||
{ | ||
"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 container 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" | ||
} | ||
-------------------------------------------------- | ||
|
||
These values are required to associate the exception container with detection | ||
rules: | ||
|
||
<1> `id` | ||
<2> `list_id` | ||
<3> `namespace_type` | ||
<4> `type` |