HP OneView REST API Reference

alerts
alerts.html[10/17/2013 10:35:10 AM]
Examples
GET https://{appl}/rest/alerts?start=0&count=-1&filter=
"alertState EQ 'Active'"
The above example retrieves all the alerts whose
alertState equals Active.
GET https://{appl}/rest/alerts?view=alertSummary
If you specify the view parameter, the total alert
counts
for all alert severities are returned in addition to the
alerts themselves.
GET https://{appl}/rest/alerts?start=-1&count=25&filter=
"alertTypeID EQ 'Trap.cpqHe4FltTolPowerSupplyFailed'"
&filter="healthCategory EQ 'POWER'"
The above example retrieves the first filtered 25
alerts of type power supply failure and the health
category of POWER. The above example uses alertTypeID to
filter on an SNMP Trap, where the alertTypeID is of the
format Trap.<Name of the trap> and the name of the trap
is
provided in the appropriate SNMP MIB.
URI: /rest/alerts/AlertChangeLog/{id}
Method API
DELETE Deletes the AlertChangeLog item identified by ID. Only user entered AlertChangeLogs can be
deleted by user. The AlertChangeLogs generated by the System cannot be deleted by the user.
Alerts cleared when processing an event with clearPriorEvents set to true have a system
generated note indicating the automatic clearing of the alerts.
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the
current release, this must be set to "X-API-Version:3"
Response Description
void Does not return any value.
Response Codes
REST API Response Codes
Examples
DELETE https://{appl}/rest/alerts/{id}/AlertChangeLog/12
The above example deletes the AlertChangeLog item 12 for
an alert which matches the unique identifier specified.
URI: /rest/alerts/schema
Method API
GET Generate the JSON formatted schema for an alert resource