NAME
OpenSearch::Client::Core::3_0::Direct::SecurityAnalytics
VERSION
version 3.007009
SYNOPSIS
use OpenSearch::Client;
my $client = OpenSearch::Client->new( ... );
my $response = $client->security_analytics-><methodname>(
valone => $value1,
valtwo => $value2
);DESCRIPTION
Security Analytics
Security Analytics includes a number of APIs to help administrators maintain and update an implementation. The APIs often mimic the same controls available for setting up Security Analytics in OpenSearch Dashboards, and they provide another option for administering the plugin.
See OpenSearch documentation for security_analytics.
METHODS
get_alerts
Retrieve alerts related to a specific detector type or detector ID.
Paths served by this method:
Method added in OpenSearch version 2.4
$resp = $client->security_analytics->get_alerts(
# Endpoint specific query string parameters
'alertState' => $qval1, # string
'detectorType' => $qval2, # string
'detector_id' => $qval3, # string
'endTime' => $qval4, # number
'missing' => $qval5, # string
'searchString' => $qval6, # string
'severityLevel' => $qval7, # string
'size' => $qval8, # number
'sortOrder' => $qval9, # string
'sortString' => $qval10, # string
'startIndex' => $qval11, # number
'startTime' => $qval12, # number
# Common API query string parameters
'error_trace' => $qval13, # boolean
'filter_path' => $qval14, # list
'human' => $qval15, # boolean
'pretty' => $qval16, # boolean
'source' => $qval17, # string
);OpenSearch documentation for security_analytics->get_alerts
get_findings
Retrieve findings related to a specific detector type or detector ID.
Paths served by this method:
Method added in OpenSearch version 2.4
$resp = $client->security_analytics->get_findings(
# Endpoint specific query string parameters
'detectionType' => $qval1, # string
'detectorType' => $qval2, # string
'detector_id' => $qval3, # string
'endTime' => $qval4, # string
'findingIds' => $qval5, # string
'missing' => $qval6, # string
'searchString' => $qval7, # string
'severity' => $qval8, # string
'size' => $qval9, # number
'sortOrder' => $qval10, # string
'sortString' => $qval11, # string
'startIndex' => $qval12, # number
'startTime' => $qval13, # number
# Common API query string parameters
'error_trace' => $qval14, # boolean
'filter_path' => $qval15, # list
'human' => $qval16, # boolean
'pretty' => $qval17, # boolean
'source' => $qval18, # string
);OpenSearch documentation for security_analytics->get_findings
search_finding_correlations
List correlations for a finding.
Paths served by this method:
Method added in OpenSearch version 2.7
$resp = $client->security_analytics->search_finding_correlations(
# Endpoint specific query string parameters
'detector_type' => $qval1, # string
'finding' => $qval2, # string
'nearby_findings' => $qval3, # number
'time_window' => $qval4, # number
# Common API query string parameters
'error_trace' => $qval5, # boolean
'filter_path' => $qval6, # list
'human' => $qval7, # boolean
'pretty' => $qval8, # boolean
'source' => $qval9, # string
);OpenSearch documentation for security_analytics->search_finding_correlations
method_supported_in_version
Return whether a method in this module namespace is supported for an OpenSearch server version
my $boolean = $os->security_analytics->method_supported_in_version(
method => 'get_alerts',
version => '2.4.0'
);Both method and version are required.
See also global_method_supported_in_version
MANUAL
Documentation index OpenSearch::Client::Manual
HISTORY
This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.
AUTHOR
Mark Dootson <mdootson@cpan.org> ( current maintainer )
CREDITS
OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.
COPYRIGHT AND LICENSE
Copyright (C) 2026 by Mark Dootson ( this distribution )
Copyright (C) 2021 by Elasticsearch BV ( original distribution )
This is free software, licensed under:
The Apache License, Version 2.0, January 2004