Getting StartedAPI ReferenceRecipesGitHub
API Reference

Get list of helios alerts.

get
https://helios.cohesity.com/v2/mcm/alerts

Get the list of helios alerts.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
alertIdList
array of strings

Filter by list of alert ids.

alertIdList
alertStateList
array of strings

Filter by list of alert states.

alertStateList
alertTypeList
array of int32s

Filter by list of alert types.

alertTypeList
alertSeverityList
array of strings

Filter by list of alert severity types.

alertSeverityList
regionIds
array of strings

Filter by list of region ids.

regionIds
clusterIdentifiers
array of strings

Filter by list of cluster ids.

clusterIdentifiers
int64

Specifies the start time of the alerts to be returned. All the alerts returned are raised after the specified start time. This value should be in Unix timestamp epoch in microseconds.

int64

Specifies the end time of the alerts to be returned. All the alerts returned are raised before the specified end time. This value should be in Unix timestamp epoch in microseconds.

int64

Specifies the start time in Unix epoch seconds to filter alerts by updateTimeStamp (when alert was stored/updated in Elasticsearch). If provided, this parameter takes precedence over startDateUsecs for time-based filtering. This addresses scenarios where alerts have processing delays between occurrence and storage.

int64

Specifies the end time in Unix epoch seconds to filter alerts by updateTimeStamp (when alert was stored/updated in Elasticsearch). If provided, this parameter takes precedence over endDateUsecs for time-based filtering. This addresses scenarios where alerts have processing delays between occurrence and storage.

int64

Specifies maximum number of alerts to return

alertCategoryList
array of strings or null

Filter by list of alert categories.

alertCategoryList
tenantIds
array of strings

Filter by tenant ids.

tenantIds
alertTypeBucketList
array of strings or null

Filter by list of alert type buckets.

alertTypeBucketList
alertPropertyKeyList
array of strings or null

Specifies list of the alert property keys to query.

alertPropertyKeyList
alertPropertyValueList
array of strings or null

Specifies list of the alert property value, multiple values for one key should be joined by '|'.

alertPropertyValueList
string

Specifies name of alert to filter alerts by.

serviceInstanceIds
array of strings

Specifies services instance ids to filter alerts for IBM customers.

serviceInstanceIds
Responses

Updated 16 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 16 days ago