User Tools

Site Tools


api_alerts

Table of Contents

API - Alerts

With Alert API you can get actual states of your setup alerts.

Examples

  • Here you can see example of GET request that get information about your all servers. (Replace “your_api_key” with your API key)
    www.bijk.com/publicapi/alertStatus/key/your_api_key
  • You can get alerts from only one server with parametr sid, or get only error states with parametr onlyErrors. For example:
    www.bijk.com/publicapi/alertStatus/key/your_api_key/sid/140/onlyErrors/true

Data format

Data are in JSON format. You recieve this parameters about every server:

  • group_name - name of plugin
  • ds_name - name of sensor
  • sid - server ID
  • hostname - server label
  • state - state of alert, if state = 0: everything is OK and current value is between v_ min and v_ max
  • brief - current value of sensor with short text description
  • v_min - state is ok when current value is bigger than v_min
  • v_max - state is ok when current value is smaller than v_max
  • output - some sensors has text description
  • cur_value_data - current value
  • ratio - true|false, if ratio is true values are in percentages
  • ts_start - start of alert, if state is 0, ts_start is NULL
  • last_check - unix timestamp of check alerted value
api_alerts.txt · Last modified: 2011/04/18 15:15 by woky