Class GetAlertsRequestParameters
Request options for GetAlerts
https://docs.opensearch.org/docs/latest/security-analytics/api-tools/alert-finding-api/#get-alerts
Implements
Inherited Members
Namespace: OpenSearch .Net.Specification.SecurityAnalyticsApi
Assembly: OpenSearch.Net.dll
Syntax
public class GetAlertsRequestParameters : RequestParameters<GetAlertsRequestParameters>, IRequestParameters
Properties
| Edit this page View SourceAlertState
Used to filter by alert state. Optional.
Declaration
public SecurityAnalyticsAlertsAlertState? AlertState { get; set; }
Property Value
Type | Description |
---|---|
Security |
DefaultHttpMethod
Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type | Description |
---|---|
Http |
Overrides
| Edit this page View SourceDetectorId
The ID of the detector used to fetch alerts. Optional when detectorType
is specified. Otherwise required.
Declaration
public string DetectorId { get; set; }
Property Value
Type | Description |
---|---|
string |
DetectorType
The type of detector used to fetch alerts. Optional when detector_id
is specified. Otherwise required.
Declaration
public string DetectorType { get; set; }
Property Value
Type | Description |
---|---|
string |
EndTime
The end timestamp (in ms) of the time window in which you want to retrieve alerts. Optional.
Declaration
public long? EndTime { get; set; }
Property Value
Type | Description |
---|---|
long? |
Missing
Used to sort by whether the field missing
exists or not in the documents associated with the alert. Optional.
Declaration
public string Missing { get; set; }
Property Value
Type | Description |
---|---|
string |
SearchString
The alert attribute you want returned in the search. Optional.
Declaration
public string SearchString { get; set; }
Property Value
Type | Description |
---|---|
string |
SeverityLevel
Used to filter by alert severity level. Optional.
Declaration
public SecurityAnalyticsAlertsAlertSeverityLevel? SeverityLevel { get; set; }
Property Value
Type | Description |
---|---|
Security |
Size
The maximum number of results returned in the response. Optional.
Declaration
public long? Size { get; set; }
Property Value
Type | Description |
---|---|
long? |
SortOrder
The order used to sort the list of findings. Possible values are asc
or desc
. Optional.
Declaration
public SortOrder? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
Sort |
SortString
The string used by Security Analytics to sort the alerts. Optional.
Declaration
public string SortString { get; set; }
Property Value
Type | Description |
---|---|
string |
StartIndex
The pagination index. Optional.
Declaration
public long? StartIndex { get; set; }
Property Value
Type | Description |
---|---|
long? |
StartTime
The beginning timestamp (in ms) of the time window in which you want to retrieve alerts. Optional.
Declaration
public long? StartTime { get; set; }
Property Value
Type | Description |
---|---|
long? |
SupportsBody
Declaration
public override bool SupportsBody { get; }
Property Value
Type | Description |
---|---|
bool |