Class LowLevelSecurityAnalyticsNamespace

Security Analytics APIs.

Not intended to be instantiated directly. Use the SecurityAnalytics property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelSecurityAnalyticsNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.SecurityAnalyticsApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelSecurityAnalyticsNamespace : NamespacedClientProxy

Methods

GetAlertsAsync<TResponse>(GetAlertsRequestParameters, CancellationToken)

GET on /_plugins/_security_analytics/alerts

https://docs.opensearch.org/docs/latest/security-analytics/api-tools/alert-finding-api/#get-alerts

Declaration

public Task<TResponse> GetAlertsAsync<TResponse>(GetAlertsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAlertsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetAlerts<TResponse>(GetAlertsRequestParameters)

GET on /_plugins/_security_analytics/alerts

https://docs.opensearch.org/docs/latest/security-analytics/api-tools/alert-finding-api/#get-alerts

Declaration

public TResponse GetAlerts<TResponse>(GetAlertsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAlertsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetFindingsAsync<TResponse>(GetFindingsRequestParameters, CancellationToken)

GET on /_plugins/_security_analytics/findings/_search

https://docs.opensearch.org/docs/latest/security-analytics/api-tools/alert-finding-api/#get-findings

Declaration

public Task<TResponse> GetFindingsAsync<TResponse>(GetFindingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetFindingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

GetFindings<TResponse>(GetFindingsRequestParameters)

GET on /_plugins/_security_analytics/findings/_search

https://docs.opensearch.org/docs/latest/security-analytics/api-tools/alert-finding-api/#get-findings

Declaration

public TResponse GetFindings<TResponse>(GetFindingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetFindingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.4.0 or greater.

SearchFindingCorrelationsAsync<TResponse>(SearchFindingCorrelationsRequestParameters, CancellationToken)

GET on /_plugins/_security_analytics/findings/correlate

https://docs.opensearch.org/docs/latest/security-analytics/api-tools/correlation-eng/#list-correlations-for-a-finding-belonging-to-a-log-type

Declaration

public Task<TResponse> SearchFindingCorrelationsAsync<TResponse>(SearchFindingCorrelationsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
SearchFindingCorrelationsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

SearchFindingCorrelations<TResponse>(SearchFindingCorrelationsRequestParameters)

GET on /_plugins/_security_analytics/findings/correlate

https://docs.opensearch.org/docs/latest/security-analytics/api-tools/correlation-eng/#list-correlations-for-a-finding-belonging-to-a-log-type

Declaration

public TResponse SearchFindingCorrelations<TResponse>(SearchFindingCorrelationsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
SearchFindingCorrelationsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

Extension Methods

SuffixExtensions.Suffix(object, string)