Zabbix Documentation 2.0

3.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.22.43.23.4

User Tools

Site Tools


Sidebar

manual:appendix:api:event:get

event.get

Description

integer/array event.get(object parameters)

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

Parameters

(object) Parameters defining the desired output.

The method supports the following parameters.

Parameter Type Description
eventids string/array Return only events with the given IDs.
groupids string/array Return only events created by triggers that belong to the given host groups.
hostids string/array Return only events created by triggers that belong to the given hosts.
triggerids string/array Return only events that have been created by the given triggers.
object integer Return only events created by objects of the given type.

Refer to the event object page for a list of supported object types.
source integer Return only events with the given type.

Refer to the event object page for a list of supported event types.
acknowledged boolean If set to true return only acknowledged events.
value integer/array Return only events with the given values.
time_from timestamp Return only events that have been created after or at the given time.
time_till timestamp Return only events that have been created before or at the given time.
eventid_from string Return only events with IDs greater or equal to the given ID.
eventid_till string Return only events with IDs less or equal to the given ID.
selectHosts query Return hosts containing the trigger that created the event in the hosts property.

Does not support shorten or arrays of properties.
selectItems query Return items contained in the trigger that created the event in the items property.

Does not support shorten or arrays of properties.
selectTriggers query Return the trigger that created the event as an array in the triggers property.

Does not support shorten or arrays of properties.
select_alerts query Return alerts generated by the event in the alerts property. Alerts are sorted in reverse chronological order.

Does not support shorten or arrays of properties.
select_acknowledges query Return event's acknowledges in the acknowledges property. Acknowledges are sorted in reverse chronological order.

The event acknowledgement object has the following properties:
acknowledgeid - (string) acknowledgement's ID;
userid - (string) ID of the user that acknowledged the event;
eventid - (string) ID of the acknowledged event;
clock - (timestamp) time when the event was acknowledged;
message - (string) text of the acknowledgement message;
alias - (string) alias of the user that acknowledged the event.

Supports count; does not support shorten or arrays of properties.
sortfield string/array Sort the result by the given properties.

Possible values are: eventid, object and objectid.
countOutput flagThese parameters being common for all get methods are described in detail on the Generic Zabbix API information page.
editable boolean
excludeSearch flag
filter object
limit integer
nodeids string/array
output query
preservekeys flag
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch flag

Return values

(integer/array) Returns either:

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

Examples

Retrieving trigger events

Retrieve the latest events from trigger “13926.”

Request:

{
    "jsonrpc": "2.0",
    "method": "event.get",
    "params": {
        "output": "extend",
        "select_acknowledges": "extend",
        "triggerids": "13926",
        "sortfield": "eventid",
        "sortorder": "DESC"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "acknowledges": [
                {
                    "acknowledgeid": "1",
                    "userid": "1",
                    "eventid": "9695",
                    "clock": "1350640590",
                    "message": "Problem resolved.\n\r----[BULK ACKNOWLEDGE]----",
                    "alias": "Admin"
                }
            ],
            "eventid": "9695",
            "source": "0",
            "object": "0",
            "objectid": "13926",
            "clock": "1347970410",
            "value": "1",
            "acknowledged": "1",
            "ns": "413316245",
            "value_changed": "1"
        },
        {
            "acknowledges": [],
            "eventid": "9671",
            "source": "0",
            "object": "0",
            "objectid": "13926",
            "clock": "1347970347",
            "value": "2",
            "acknowledged": "0",
            "ns": "0",
            "value_changed": "0"
        }
    ],
    "id": 1
}

Retrieving events by time period

Retrieve all events that have been created between October 9 and 10, 2012, in reverse chronological order.

Request:

{
    "jsonrpc": "2.0",
    "method": "event.get",
    "params": {
        "output": "extend",
        "time_from": "1349797228",
        "time_till": "1350661228",
        "sortfield": "eventid",
        "sortorder": "desc"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "eventid": "20616",
            "source": "0",
            "object": "0",
            "objectid": "14282",
            "clock": "1350477814",
            "value": "2",
            "acknowledged": "0",
            "ns": "0",
            "value_changed": "0"
        },
        {
            "eventid": "20617",
            "source": "0",
            "object": "0",
            "objectid": "14283",
            "clock": "1350477814",
            "value": "2",
            "acknowledged": "0",
            "ns": "0",
            "value_changed": "0"
        },
        {
            "eventid": "20618",
            "source": "0",
            "object": "0",
            "objectid": "14284",
            "clock": "1350477815",
            "value": "2",
            "acknowledged": "0",
            "ns": "0",
            "value_changed": "0"
        }
    ],
    "id": 1
}

See also

Source

CEvent::get() in frontends/php/api/classes/CEvent.php.