Zabbix Documentation 5.0

3.04.04.45.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


manual:api:reference:event:object

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
manual:api:reference:event:object [2019/04/02 06:04]
127.0.0.1 external edit
manual:api:reference:event:object [2020/02/24 10:19] (current)
marinagen more precise wording
Line 11: Line 11:
 ^  Property ​ ^  Type  ^  Description ​ ^ ^  Property ​ ^  Type  ^  Description ​ ^
 | eventid ​ | string ​ | ID of the event. ​ | | eventid ​ | string ​ | ID of the event. ​ |
-| source | integer | Type of the event. \\ \\ Possible values: \\ 0 - event created by a trigger; \\ 1 - event created by a discovery rule; \\ 2 - event created by active agent auto-registration; \\ 3 - internal event. | +| source | integer | Type of the event. \\ \\ Possible values: \\ 0 - event created by a trigger; \\ 1 - event created by a discovery rule; \\ 2 - event created by active agent autoregistration; \\ 3 - internal event. | 
-| object | integer | Type of object that is related to the event. \\ \\ Possible values for trigger events: \\ 0 - trigger. \\ \\ Possible values for discovery events: \\ 1 - discovered host; \\ 2 - discovered service. \\ \\ Possible values for auto-registration ​events: \\ 3 - auto-registered host. \\ \\ Possible values for internal events: \\ 0 - trigger; \\ 4 - item; \\ 5 - LLD rule. |+| object | integer | Type of object that is related to the event. \\ \\ Possible values for trigger events: \\ 0 - trigger. \\ \\ Possible values for discovery events: \\ 1 - discovered host; \\ 2 - discovered service. \\ \\ Possible values for autoregistration ​events: \\ 3 - auto-registered host. \\ \\ Possible values for internal events: \\ 0 - trigger; \\ 4 - item; \\ 5 - LLD rule. |
 | objectid | string | ID of the related object. | | objectid | string | ID of the related object. |
 | acknowledged | integer | Whether the event has been acknowledged. | | acknowledged | integer | Whether the event has been acknowledged. |
Line 18: Line 18:
 | ns | integer | Nanoseconds when the event was created. | | ns | integer | Nanoseconds when the event was created. |
 | name | string | Resolved event name. | | name | string | Resolved event name. |
-| value | integer | State of the related object. \\ \\ Possible values for trigger events: \\ 0 - OK; \\ 1 - problem. \\ \\ Possible values for discovery events: \\ 0 - host or service up; \\ 1 - host or service down; \\ 2 - host or service discovered; \\ 3 - host or service lost. \\ \\ Possible values for internal events: \\ 0 - "​normal"​ state; \\ 1 - "​unknown"​ or "not supported"​ state. \\ \\ This parameter is not used for active agent auto-registration ​events. |+| value | integer | State of the related object. \\ \\ Possible values for trigger events: \\ 0 - OK; \\ 1 - problem. \\ \\ Possible values for discovery events: \\ 0 - host or service up; \\ 1 - host or service down; \\ 2 - host or service discovered; \\ 3 - host or service lost. \\ \\ Possible values for internal events: \\ 0 - "​normal"​ state; \\ 1 - "​unknown"​ or "not supported"​ state. \\ \\ This parameter is not used for active agent autoregistration ​events. |
 | severity| integer | Event current severity. \\ \\ Possible values: \\ 0 - not classified; \\ 1 - information;​ \\ 2 - warning; \\ 3 - average; \\ 4 - high; \\ 5 - disaster. | | severity| integer | Event current severity. \\ \\ Possible values: \\ 0 - not classified; \\ 1 - information;​ \\ 2 - warning; \\ 3 - average; \\ 4 - high; \\ 5 - disaster. |
 | r_eventid | string | Recovery event ID  | | r_eventid | string | Recovery event ID  |
-| c_eventid | string | Problem event ID who generated OK event | +| c_eventid | string | ID of the event that was used to override (close) current event under global correlation rule. See ''​correlationid''​ to identify exact correlation rule. \\ This parameter is only used when the event is closed by global correlation rule.  ​
-| correlationid | string | Correlation ​ID |+| correlationid | string | ID of the correlation rule that generated closing of the problem.\\ This parameter is only used when the event is closed by global correlation rule.  ​|
 | userid | string | User ID if the event was manually closed. | | userid | string | User ID if the event was manually closed. |
 | suppressed | integer | Whether the event is suppressed. \\ \\ Possible values: \\ 0 - event is in normal state; \\ 1 - event is suppressed. | | suppressed | integer | Whether the event is suppressed. \\ \\ Possible values: \\ 0 - event is in normal state; \\ 1 - event is suppressed. |
 +| opdata | string | Operational data with expanded macros. |
 +| urls | array of [[manual:​api:​reference:​problem:​object#​Media type URLs|Media type URLs]] | Active media types URLs. |
  
 ==== Event tag ==== ==== Event tag ====
Line 33: Line 35:
 | tag      | string | Event tag name.  | | tag      | string | Event tag name.  |
 | value    | string | Event tag value. | | value    | string | Event tag value. |
 +
 +==== Media type URLs ====
 +
 +Object with media type url have the following properties.
 +
 +^ Property ^ Type ^ Description ^
 +| name     | string | Media type defined URL name.  |
 +| url      | string | Media type defined URL value. |
 +
 +Results will contain entries only for active media types with enabled event menu entry. Macro used in properties will be expanded, but if one of properties contain non expanded macro both properties will be excluded from results. Supported macros described on [[manual:​appendix:​macros:​supported_by_location|page]].