You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[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
Copy file name to clipboardExpand all lines: oas_docs/output/kibana.serverless.yaml
+35-21Lines changed: 35 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -8153,7 +8153,7 @@ paths:
8153
8153
name: product_name
8154
8154
/api/attack_discovery/_bulk:
8155
8155
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`
8157
8157
operationId: PostAttackDiscoveryBulk
8158
8158
requestBody:
8159
8159
content:
@@ -8202,7 +8202,7 @@ paths:
8202
8202
- ids
8203
8203
required:
8204
8204
- update
8205
-
description: Bulk update parameters for Attack discovery alerts
8205
+
description: Bulk update parameters for Attack discoveries
8206
8206
required: true
8207
8207
responses:
8208
8208
'200':
@@ -8242,7 +8242,7 @@ paths:
8242
8242
- error
8243
8243
- message
8244
8244
description: Generic Error
8245
-
summary: Bulk update Attack discovery alerts
8245
+
summary: Bulk update Attack discoveries
8246
8246
tags:
8247
8247
- Security Attack discovery API
8248
8248
x-code-samples:
@@ -8268,7 +8268,7 @@ paths:
8268
8268
name: product_name
8269
8269
/api/attack_discovery/_find:
8270
8270
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`
8272
8272
operationId: AttackDiscoveryFind
8273
8273
parameters:
8274
8274
- description: Filter results to Attack discoveries that include any of the provided alert IDs
@@ -8455,7 +8455,7 @@ paths:
8455
8455
example: 400
8456
8456
type: number
8457
8457
description: Generic Error
8458
-
summary: Finds Attack discoveries that match the search criteria
8458
+
summary: Find Attack discoveries that match the search criteria
8459
8459
tags:
8460
8460
- Security Attack discovery API
8461
8461
x-code-samples:
@@ -8528,7 +8528,6 @@ paths:
8528
8528
--request POST 'http://localhost:5601/api/attack_discovery/_generate' \
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`
9472
9471
operationId: GetAttackDiscoveryGenerations
9473
9472
parameters:
9474
9473
- 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:
9528
9527
example: 400
9529
9528
type: number
9530
9529
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
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`
10167
10181
operationId: DisableAttackDiscoverySchedules
10168
10182
parameters:
@@ -10206,15 +10220,15 @@ paths:
10206
10220
lang: curl
10207
10221
source: |
10208
10222
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' \
10210
10224
--header "Authorization: $API_KEY" \
10211
10225
--header "Content-Type: application/json"
10212
10226
x-state: Technical Preview; added in 9.2.0
10213
10227
x-metaTags:
10214
10228
- content: Kibana, Elastic Cloud Serverless
10215
10229
name: product_name
10216
10230
/api/attack_discovery/schedules/{id}/_enable:
10217
-
put:
10231
+
post:
10218
10232
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`
10219
10233
operationId: EnableAttackDiscoverySchedules
10220
10234
parameters:
@@ -10258,7 +10272,7 @@ paths:
10258
10272
lang: curl
10259
10273
source: |
10260
10274
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' \
0 commit comments