Zabbix Documentation 1.8

3.04.05.0 (current)| In development:5.2 (devel)| Unsupported:1.82.02.22.43.23.44.24.4Guidelines

User Tools

Site Tools


api:alert

Differences

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

Link to this comparison view

api:alert [2018/10/01 09:42]
api:alert [2014/12/29 17:49] (current)
dotneft
Line 1: Line 1:
 +===== Alert =====
 +==== Methods ====
  
 +Class containing methods for operations with Alerts.
 +^Methods^Description^
 +|[[api:​alert:​get|get()]] |Get alert details |
 +
 +==== Object details ====
 +
 +The table contains complete list of Alert attributes.
 +
 +^Parameter^Type^Description^Details^
 +|**alertid**|//​integer//​|Alert ID  | |
 +|**actionid**|//​integer//​|Action ID | |
 +|**eventid**|//​integer//​|Event ID | |
 +|**userid**|//​integer//​|User ID | |
 +|**clock**|//​integer//​|Date |Unix timestamp |
 +|**mediatypeid**|//​integer//​|Madia type ID | |
 +|**sendto**|//​string//​|Address | |
 +|**subject**|//​string//​|Alert subject | |
 +|**message**|//​string//​|Alert message | |
 +|**status**|//​integer//​|Alert status | |
 +|**retries**|//​integer//​|Retries made to send | |
 +|**error**|//​string//​|Error details in case if sending failed | |
 +
 +==== Common tasks ====
 +The table contains list of common alert-related tasks and possible implementation using Zabbix API
 +^Task^HOWTO^
 +|Remove a bunch of alerts | Use method **alert.delete** with array of Alert objects |
 +|Retrieve alert details by Alert IDs | Use method **alert.get** with parameter **alertids** |
 +|Retrieve alerts details by some period | Use method **alert.get** with parameters **time_from** and **time_till** |