Skip to content

Commit ea9bbf5

Browse files
[Attack discovery] Additional Attack discovery API docs updates (elastic#239635)
## [Attack discovery] Additional Attack discovery API docs updates This PR includes additional updates to the [Security Attack discovery](https://www.elastic.co/docs/api/doc/kibana/group/endpoint-security-attack-discovery-api) API documentation, for the public [Attack discovery and Attack discovery schedules public APIs](elastic#236736). ### Summary of updates - Changed routes and examples for enabling/disabling schedules from `PUT` to `POST` - Improved descriptions for clarity and brevity - Replaced example index patterns with a specific (default) index to make the examples more concrete - Removed query parameters from some examples
1 parent de77a41 commit ea9bbf5

File tree

10 files changed

+191
-121
lines changed

10 files changed

+191
-121
lines changed

oas_docs/output/kibana.serverless.yaml

Lines changed: 35 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -8153,7 +8153,7 @@ paths:
81538153
name: product_name
81548154
/api/attack_discovery/_bulk:
81558155
post:
8156-
description: Performs bulk updates on multiple Attack discovery alerts, including workflow status changes and visibility settings. This endpoint allows efficient batch processing of alert modifications without requiring individual API calls for each alert. `Technical preview`
8156+
description: Performs bulk updates on multiple Attack discoveries, including workflow status changes and visibility settings. This endpoint allows efficient batch processing of alert modifications without requiring individual API calls for each alert. `Technical preview`
81578157
operationId: PostAttackDiscoveryBulk
81588158
requestBody:
81598159
content:
@@ -8202,7 +8202,7 @@ paths:
82028202
- ids
82038203
required:
82048204
- update
8205-
description: Bulk update parameters for Attack discovery alerts
8205+
description: Bulk update parameters for Attack discoveries
82068206
required: true
82078207
responses:
82088208
'200':
@@ -8242,7 +8242,7 @@ paths:
82428242
- error
82438243
- message
82448244
description: Generic Error
8245-
summary: Bulk update Attack discovery alerts
8245+
summary: Bulk update Attack discoveries
82468246
tags:
82478247
- Security Attack discovery API
82488248
x-code-samples:
@@ -8268,7 +8268,7 @@ paths:
82688268
name: product_name
82698269
/api/attack_discovery/_find:
82708270
get:
8271-
description: Finds Attack discoveries that match the search criteria. Supports free text search, filtering, pagination, and sorting. `Technical preview`
8271+
description: Find Attack discoveries that match the search criteria. Supports free text search, filtering, pagination, and sorting. `Technical preview`
82728272
operationId: AttackDiscoveryFind
82738273
parameters:
82748274
- description: Filter results to Attack discoveries that include any of the provided alert IDs
@@ -8455,7 +8455,7 @@ paths:
84558455
example: 400
84568456
type: number
84578457
description: Generic Error
8458-
summary: Finds Attack discoveries that match the search criteria
8458+
summary: Find Attack discoveries that match the search criteria
84598459
tags:
84608460
- Security Attack discovery API
84618461
x-code-samples:
@@ -8528,7 +8528,6 @@ paths:
85288528
--request POST 'http://localhost:5601/api/attack_discovery/_generate' \
85298529
--header "Authorization: $API_KEY" \
85308530
--header "Content-Type: application/json" \
8531-
--header "elastic-api-version: 2023-10-31" \
85328531
--data '{
85338532
"alertsIndexPattern": ".alerts-security.alerts-default",
85348533
"anonymizationFields": [
@@ -9468,7 +9467,7 @@ paths:
94689467
name: product_name
94699468
/api/attack_discovery/generations:
94709469
get:
9471-
description: Get the latest attack discovery generations (that are not dismissed) for the current user. This endpoint retrieves generation metadata including execution status and statistics for Attack discovery generations. `Technical preview`
9470+
description: Get the latest attack discovery generations metadata (that are not dismissed) for the current user. This endpoint retrieves generation metadata including execution status and statistics for Attack discovery generations. `Technical preview`
94729471
operationId: GetAttackDiscoveryGenerations
94739472
parameters:
94749473
- description: End of the time range for filtering generations. Accepts absolute timestamps (ISO 8601) or relative date math (e.g. "now", "now-24h").
@@ -9528,7 +9527,7 @@ paths:
95289527
example: 400
95299528
type: number
95309529
description: Bad request
9531-
summary: Get the latest attack discovery generations (that are not dismissed) for the current user
9530+
summary: Get the latest attack discovery generations metadata for the current user
95329531
tags:
95339532
- Security Attack discovery API
95349533
x-code-samples:
@@ -9758,7 +9757,7 @@ paths:
97589757
enabled: true
97599758
name: Daily Security Analysis
97609759
params:
9761-
alerts_index_pattern: .alerts-security.alerts-*
9760+
alerts_index_pattern: .alerts-security.alerts-default
97629761
api_config:
97639762
actionTypeId: bedrock
97649763
connectorId: my-bedrock-connector
@@ -9784,7 +9783,7 @@ paths:
97849783
id: 12345678-1234-1234-1234-123456789012
97859784
name: Daily Security Analysis
97869785
params:
9787-
alerts_index_pattern: .alerts-security.alerts-*
9786+
alerts_index_pattern: .alerts-security.alerts-default
97889787
api_config:
97899788
actionTypeId: bedrock
97909789
connectorId: my-bedrock-connector
@@ -9824,7 +9823,7 @@ paths:
98249823
"name": "Daily Security Analysis",
98259824
"enabled": true,
98269825
"params": {
9827-
"alerts_index_pattern": ".alerts-security.alerts-*",
9826+
"alerts_index_pattern": ".alerts-security.alerts-default",
98289827
"api_config": {
98299828
"actionTypeId": "bedrock",
98309829
"connectorId": "my-bedrock-connector",
@@ -9837,7 +9836,22 @@ paths:
98379836
"schedule": {
98389837
"interval": "24h"
98399838
},
9840-
"actions": []
9839+
"actions": [
9840+
{
9841+
"action_type_id": ".cases",
9842+
"id": "system-connector-.cases",
9843+
"params": {
9844+
"subAction": "run",
9845+
"subActionParams": {
9846+
"timeWindow": "7d",
9847+
"reopenClosedCases": false,
9848+
"groupingBy": [],
9849+
"templateId": null
9850+
}
9851+
},
9852+
"uuid": "12345678-1234-1234-1234-123456789012"
9853+
}
9854+
]
98419855
}'
98429856
x-state: Technical Preview; added in 9.2.0
98439857
x-metaTags:
@@ -9933,7 +9947,7 @@ paths:
99339947
lang: curl
99349948
source: |
99359949
curl \
9936-
--request GET 'http://localhost:5601/api/attack_discovery/schedules/_find?page=1&per_page=10&sort_field=name&sort_direction=asc' \
9950+
--request GET 'http://localhost:5601/api/attack_discovery/schedules/_find' \
99379951
--header "Authorization: $API_KEY" \
99389952
--header "Content-Type: application/json"
99399953
x-state: Technical Preview; added in 9.2.0
@@ -10019,7 +10033,7 @@ paths:
1001910033
status: ok
1002010034
name: Daily Security Analysis
1002110035
params:
10022-
alerts_index_pattern: .alerts-security.alerts-*
10036+
alerts_index_pattern: .alerts-security.alerts-default
1002310037
api_config:
1002410038
actionTypeId: bedrock
1002510039
connectorId: my-bedrock-connector
@@ -10077,7 +10091,7 @@ paths:
1007710091
actions: []
1007810092
name: Updated Daily Security Analysis
1007910093
params:
10080-
alerts_index_pattern: .alerts-security.alerts-*
10094+
alerts_index_pattern: .alerts-security.alerts-default
1008110095
api_config:
1008210096
actionTypeId: bedrock
1008310097
connectorId: my-bedrock-connector
@@ -10103,7 +10117,7 @@ paths:
1010310117
id: 12345678-1234-1234-1234-123456789012
1010410118
name: Updated Daily Security Analysis
1010510119
params:
10106-
alerts_index_pattern: .alerts-security.alerts-*
10120+
alerts_index_pattern: .alerts-security.alerts-default
1010710121
api_config:
1010810122
actionTypeId: bedrock
1010910123
connectorId: my-bedrock-connector
@@ -10142,7 +10156,7 @@ paths:
1014210156
--data '{
1014310157
"name": "Updated Daily Security Analysis",
1014410158
"params": {
10145-
"alerts_index_pattern": ".alerts-security.alerts-*",
10159+
"alerts_index_pattern": ".alerts-security.alerts-default",
1014610160
"api_config": {
1014710161
"actionTypeId": "bedrock",
1014810162
"connectorId": "my-bedrock-connector",
@@ -10162,7 +10176,7 @@ paths:
1016210176
- content: Kibana, Elastic Cloud Serverless
1016310177
name: product_name
1016410178
/api/attack_discovery/schedules/{id}/_disable:
10165-
put:
10179+
post:
1016610180
description: Disables an Attack discovery schedule, preventing it from running according to its configured interval. The schedule configuration is preserved and can be re-enabled later. Any currently running executions will complete, but no new executions will be started. `Technical preview`
1016710181
operationId: DisableAttackDiscoverySchedules
1016810182
parameters:
@@ -10206,15 +10220,15 @@ paths:
1020610220
lang: curl
1020710221
source: |
1020810222
curl \
10209-
--request PUT 'http://localhost:5601/api/attack_discovery/schedules/12345678-1234-1234-1234-123456789012/_disable' \
10223+
--request POST 'http://localhost:5601/api/attack_discovery/schedules/12345678-1234-1234-1234-123456789012/_disable' \
1021010224
--header "Authorization: $API_KEY" \
1021110225
--header "Content-Type: application/json"
1021210226
x-state: Technical Preview; added in 9.2.0
1021310227
x-metaTags:
1021410228
- content: Kibana, Elastic Cloud Serverless
1021510229
name: product_name
1021610230
/api/attack_discovery/schedules/{id}/_enable:
10217-
put:
10231+
post:
1021810232
description: Enables a previously disabled Attack discovery schedule, allowing it to run according to its configured interval. Once enabled, the schedule will begin executing at the next scheduled time based on its interval configuration. `Technical preview`
1021910233
operationId: EnableAttackDiscoverySchedules
1022010234
parameters:
@@ -10258,7 +10272,7 @@ paths:
1025810272
lang: curl
1025910273
source: |
1026010274
curl \
10261-
--request PUT 'http://localhost:5601/api/attack_discovery/schedules/12345678-1234-1234-1234-123456789012/_enable' \
10275+
--request POST 'http://localhost:5601/api/attack_discovery/schedules/12345678-1234-1234-1234-123456789012/_enable' \
1026210276
--header "Authorization: $API_KEY" \
1026310277
--header "Content-Type: application/json"
1026410278
x-state: Technical Preview; added in 9.2.0

0 commit comments

Comments
 (0)