iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Correct SA findings alerts API (#6179) 

* Correct SA findings alerts API

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>

* Apply suggestions from code review

Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Heather Halter <HDHALTER@AMAZON.COM>
This commit is contained in:
Naarcha-AWS 2024-01-16 18:01:55 -06:00 committed by GitHub
parent e7fc10885c
commit b5fdaf2acd
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
_security-analytics/api-tools/alert-finding-api.md
View File

@ -11,7 +11,8 @@ nav_order: 50
The following APIs can be used for tasks related to alerts and findings. The following APIs can be used for tasks related to alerts and findings.
--- ---
## Get Alerts
## Get alerts
Provides an option for retrieving alerts related to a specific detector type or detector ID. Provides an option for retrieving alerts related to a specific detector type or detector ID.
@ -21,12 +22,12 @@ You can specify the following parameters when requesting an alert.
Parameter | Description Parameter | Description
:--- | :--- :--- | :---
`detectorId` | The ID of the detector used to fetch alerts. Optional when the `detectorType` is specified. Otherwise required. `detector_id` | The ID of the detector used to fetch alerts. Optional when the `detectorType` is specified. Otherwise required.
`detectorType` | The type of detector used to fetch alerts. Optional when the `detectorId` is specified. Otherwise required. `detectorType` | The type of detector used to fetch alerts. Optional when the `detector_Id` is specified. Otherwise required.
`severityLevel` | Used to filter by alert severity level. Optional. `severityLevel` | Used to filter by alert severity level. Optional.
`alertState` | Used to filter by alert state. Possible values: ACTIVE, ACKNOWLEDGED, COMPLETED, ERROR, DELETED. Optional. `alertState` | Used to filter by alert state. Possible values are ACTIVE, ACKNOWLEDGED, COMPLETED, ERROR, or DELETED. Optional.
`sortString` | This field specifies which string Security Analytics uses to sort the alerts. Optional. `sortString` | This field specifies which string Security Analytics uses to sort the alerts. Optional.
`sortOrder` | The order used to sort the list of findings, either `ascending` or `descending`. Optional. `sortOrder` | The order used to sort the list of findings. Possible values are `asc` or `desc`. Optional.
`missing` | A list of fields for which there are no found alias mappings. Optional. `missing` | A list of fields for which there are no found alias mappings. Optional.
`size` | An optional limit for the maximum number of results returned in the response. Optional. `size` | An optional limit for the maximum number of results returned in the response. Optional.
`startIndex` | The pagination indicator. Optional. `startIndex` | The pagination indicator. Optional.
@ -83,7 +84,10 @@ State | Description
`DELETED` | Someone deleted the detector or trigger associated with this alert while the alert was ongoing. `DELETED` | Someone deleted the detector or trigger associated with this alert while the alert was ongoing.
--- ---
## Acknowledge Alerts
## Acknowledge alerts
Sends an acknowledgement when an alert is triggered.
### Example request ### Example request
@ -134,9 +138,21 @@ POST /_plugins/_security_analytics/<detector_id>/_acknowledge/alerts
``` ```
--- ---
## Get Findings
The Get findings API based on detector attributes. ## Get findings
The Get findings API returns findings based on the detector attributes.
### Parameters
You can specify the following parameters when getting findings.
Parameter | Description
:--- | :---
`detector_id` | The ID of the detector used to fetch alerts. Optional when the `detectorType` is specified. Otherwise required.
`detectorType` | The type of detector used to fetch alerts. Optional when the `detector_id` is specified. Otherwise required.
`sortOrder` | The order used to sort the list of findings. Possible values are `asc` or `desc`. Optional.
`size` | An optional limit for the maximum number of results returned in the response. Optional.
### Example request ### Example request