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.

Sign up for GitHub

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

[8.14] Updates setup guide field API docs (backport #5095) #5103

Merged
merged 1 commit into from
Apr 22, 2024
Merged

[8.14] Updates setup guide field API docs (backport #5095) #5103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 19 additions & 14 deletions docs/detections/api/rules/rules-api-create.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,10 @@ relevant information about the rule. Defaults to an empty array.
is converted from a third-party security solution. Automatically created when
it is not provided.

|setup |String |Populates the rule's setup guide with instructions on rule
prerequisites such as required integrations, configuration steps, and anything
else needed for the rule to work correctly.

|tags |String[] |String array containing words and phrases to help categorize,
filter, and search rules. Defaults to an empty array.

Expand Down Expand Up @@ -914,6 +918,7 @@ POST api/detection_engine/rules
"interval": "5m",
"name": "Anomalous Linux network activity",
"note": "Shut down the internet.",
"setup": "This rule requires data coming in from Elastic Defend."
"severity": "high",
"tags": [
"machine learning",
Expand Down Expand Up @@ -1178,10 +1183,10 @@ Example response for a query rule:
"language": "kuery",
"related_integrations": [], <1>
"required_fields": [], <1>
"setup": "" <1>
"setup": ""
}
--------------------------------------------------
<1> dev:[] These fields are under development and their usage may change: `related_integrations`, `required_fields`, and `setup`.
<1> dev:[] These fields are under development and their usage may change: `related_integrations` and `required_fields`.


Example response for a {ml} job rule:
Expand Down Expand Up @@ -1236,10 +1241,10 @@ Example response for a {ml} job rule:
"machine_learning_job_id": "linux_anomalous_network_activity_ecs",
"related_integrations": [], <1>
"required_fields": [], <1>
"setup": "" <1>
"setup": ""
}
--------------------------------------------------
<1> dev:[] These fields are under development and their usage may change: `related_integrations`, `required_fields`, and `setup`.
<1> dev:[] These fields are under development and their usage may change: `related_integrations` and `required_fields`.

Example response for a threshold rule:

Expand Down Expand Up @@ -1317,10 +1322,10 @@ Example response for a threshold rule:
},
"related_integrations": [], <1>
"required_fields": [], <1>
"setup": "" <1>
"setup": ""
}
--------------------------------------------------
<1> dev:[] These fields are under development and their usage may change: `related_integrations`, `required_fields`, and `setup`.
<1> dev:[] These fields are under development and their usage may change: `related_integrations` and `required_fields`.

Example response for an EQL rule:

Expand Down Expand Up @@ -1362,10 +1367,10 @@ Example response for an EQL rule:
"language": "eql",
"related_integrations": [], <1>
"required_fields": [], <1>
"setup": "" <1>
"setup": ""
}
--------------------------------------------------
<1> dev:[] These fields are under development and their usage may change: `related_integrations`, `required_fields`, and `setup`.
<1> dev:[] These fields are under development and their usage may change: `related_integrations` and `required_fields`.

Example response for an indicator match rule:

Expand Down Expand Up @@ -1434,10 +1439,10 @@ Example response for an indicator match rule:
],
"related_integrations": [], <1>
"required_fields": [], <1>
"setup": "" <1>
"setup": ""
}
--------------------------------------------------
<1> dev:[] These fields are under development and their usage may change: `related_integrations`, `required_fields`, and `setup`.
<1> dev:[] These fields are under development and their usage may change: `related_integrations` and `required_fields`.

Example response for a new terms rule:

Expand Down Expand Up @@ -1479,10 +1484,10 @@ Example response for a new terms rule:
"history_window_start": "now-30d",
"related_integrations": [], <1>
"required_fields": [], <1>
"setup": "" <1>
"setup": ""
}
--------------------------------------------------
<1> dev:[] These fields are under development and their usage may change: `related_integrations`, `required_fields`, and `setup`.
<1> dev:[] These fields are under development and their usage may change: `related_integrations` and `required_fields`.

Example response for an {esql} rule:

Expand Down Expand Up @@ -1519,10 +1524,10 @@ Example response for an {esql} rule:
"immutable": false,
"related_integrations": [], <1>
"required_fields": [], <1>
"setup": "", <1>
"setup": "",
"type": "esql",
"language": "esql",
"query": "from auditbeat-8.10.2 [metadata _id] | where process.parent.name == \"EXCEL.EXE\""
}
--------------------------------------------------
<1> dev:[] These fields are under development and their usage may change: `related_integrations`, `required_fields`, and `setup`.
<1> dev:[] These fields are under development and their usage may change: `related_integrations` and `required_fields`.
8 changes: 6 additions & 2 deletions docs/detections/api/rules/rules-api-update.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,10 @@ single execution. Defaults to `100`.
|references |String[] |Array containing notes about or references to
relevant information about the rule. Defaults to an empty array.

|setup |String |Populates the rule's setup guide with instructions on rule
prerequisites such as required integrations, configuration steps, and anything
else needed for the rule to work correctly.

|tags |String[] |String array containing words and phrases to help categorize,
filter, and search rules. Defaults to an empty array.

Expand Down Expand Up @@ -629,7 +633,7 @@ Example response:
],
"related_integrations": [], <1>
"required_fields": [], <1>
"setup": "", <1>
"setup": "",
"type": "query",
"threat": [
{
Expand Down Expand Up @@ -665,4 +669,4 @@ Example response:
}
--------------------------------------------------

<1> dev:[] These fields are under development and their usage or schema may change: `related_integrations`, `required_fields`, `setup`, and `execution_summary`.
<1> dev:[] These fields are under development and their usage or schema may change: `related_integrations`, `required_fields`, and `execution_summary`.