List the Alerts on the Cohesity Cluster.

get

https://cluster.ip.address/irisservices/api/v1/public/alerts

Privileges: ALERT_VIEW

Returns all Alert objects found on the Cohesity Cluster that
match the filter criteria specified using parameters.
The Cohesity Cluster creates an Alert when a potential problem
is found or when a threshold has been exceeded on the Cohesity Cluster.
If no filter parameters are specified, all Alert objects are returned.
Each object provides details about the Alert such as the Status and Severity.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

alertIdList

array of strings

Specifies list of Alert ids to filter alerts by.

alertIdList

alertTypeList

array of int32s

Specifies list of Alert Types to filter alerts by.

alertTypeList

alertCategoryList

array of strings

Specifies list of Alert Categories.

alertCategoryList

propertyKey

string

Specifies name of the property to filter alerts by.

propertyValue

string

Specifies value of the property to filter alerts by.

startDateUsecs

int64

Specifies start time Unix epoch time in microseconds to filter alerts by.

endDateUsecs

int64

Specifies end time Unix epoch time in microseconds to filter alerts by.

alertStateList

array of strings

Specifies list of Alert States to filter alerts by.

alertStateList

Allowed:

alertSeverityList

array of strings

Specifies list of Alert severity to filter alerts by.

alertSeverityList

Allowed:

alertTypeBucketList

array of strings

Specifies the list of Alert type bucket.
Specifies the Alert type bucket.
kHardware - Alerts related to hardware on which Cohesity software is running.
kSoftware - Alerts which are related to software components.
kDataService - Alerts related to data services.
kMaintenance - Alerts relates to maintenance activities.

alertTypeBucketList

Allowed:

resolutionIdList

array of int64s

Specifies alert resolution ids to filter alerts by.

resolutionIdList

maxAlerts

int32

required

Specifies the number of returned Alerts to be returned. The newest Alerts
are returned.

alertName

string

Specifies Alert name to filter alerts by.

tenantIds

array of strings

TenantIds contains ids of the tenants for which objects are to be
returned.

tenantIds

allUnderHierarchy

boolean

AllUnderHierarchy specifies if objects of all the tenants under the
hierarchy of the logged in user's organization should be returned.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

defaultError