alert.get

Description

integer/array alert.get(object **parameters**)

The method allows to retrieve alerts according to the given parameters.

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

ParameterTypeDescription
alertidsstring/arrayReturn only alerts with the given IDs.
actionidsstring/arrayReturn only alerts generated by the given actions.
eventidsstring/arrayReturn only alerts generated by the given events.
groupidsstring/arrayReturn only alerts generated by objects from the given host groups.
hostidsstring/arrayReturn only alerts generated by objects from the given hosts.
mediatypeidsstring/arrayReturn only message alerts that used the given media types.
objectidsstring/arrayReturn only alerts generated by the given objects
useridsstring/arrayReturn only message alerts that were sent to the given users.
eventobjectintegerReturn only alerts generated by events related to objects of the given type.

See event “object” for a list of supported object types.

Default: 0 - trigger.
eventsourceintegerReturn only alerts generated by events of the given type.

See event “source” for a list of supported event types.

Default: 0 - trigger events.
time_fromtimestampReturn only alerts that have been generated after the given time.
time_tilltimestampReturn only alerts that have been generated before the given time.
selectHostsqueryReturn a hosts property with data of hosts that triggered the action operation.
selectMediatypesqueryReturn a mediatypes property with an array of the media types that were used for the message alert.
selectUsersqueryReturn a users property with an array of the users that the message was addressed to.
sortfieldstring/arraySort the result by the given properties.

Possible values are: alertid, clock, eventid, mediatypeid, sendto and status.
countOutputbooleanThese parameters being common for all get methods are described in the reference commentary.
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

Return values

(integer/array) Returns either:

  • an array of objects;

  • the count of retrieved objects, if the countOutput parameter has been used.

Examples

Retrieve alerts by action ID

Retrieve all alerts generated by action “3”.

Request:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "alert.get",
  4.     "params": {
  5.         "output": "extend",
  6.         "actionids": "3"
  7.     },
  8.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9.     "id": 1
  10. }

Response:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "alertid": "1",
  6.             "actionid": "3",
  7.             "eventid": "21243",
  8.             "userid": "1",
  9.             "clock": "1362128008",
  10.             "mediatypeid": "1",
  11.             "sendto": "[email protected]",
  12.             "subject": "PROBLEM: Zabbix agent on Linux server is unreachable for 5 minutes: ",
  13.             "message": "Trigger: Zabbix agent on Linux server is unreachable for 5 minutes: \nTrigger status: PROBLEM\nTrigger severity: Not classified",
  14.             "status": "0",
  15.             "retries": "3",
  16.             "error": "",
  17.             "esc_step": "1",
  18.             "alerttype": "0",
  19.             "p_eventid": "0",
  20.             "acknowledgeid": "0"
  21.         }
  22.     ],
  23.     "id": 1
  24. }

See also

Source

CAlert::get() in ui/include/classes/api/services/CAlert.php.