api.mon.alerting.action

/mon/action

api.mon.alerting.action.views.mon_action_list(*args, **kwargs)

Get (GET) list of monitoring actions.

GET /mon/action
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • data.full (boolean) – Return list of objects with all monitoring action details (default: false)
Status Codes:

/mon/action/(action_name)

api.mon.alerting.action.views.mon_action_manage(*args, **kwargs)

Show (GET), create (POST), remove (DELETE) or update (PUT) a monitoring action.

GET /mon/action/(action_name)
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • action_name (string) – required - Monitoring action name
Status Codes:
POST /mon/action/(action_name)
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • action_name (string) – required - Monitoring action name
  • data.hostgroups (array) – required - Host groups that trigger an alert
  • data.usergroups (array) – required - User groups that should receive a notifications
  • data.message_subject (string) – Subject of the notification message (default: as in Zabbix documentation)
  • data.message_text (string) – Text of the notification message (default: as in Zabbix documentation)
  • data.recovery_message_enabled (boolean) – Enable recovery message (default: false)
  • data.recovery_message_subject (string) – Recovery message subject (default: as in Zabbix documentation)
  • data.recovery_message_text (string) – Recovery message text (default: as in Zabbix documentation)
  • data.enabled (boolean) – Enable or disable the action temporarily without the need to delete it (default: true)
Status Codes:
PUT /mon/action/(action_name)
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • action_name (string) – required - Monitoring action name
  • data.hostgroups (array) – Host groups that trigger an alert
  • data.usergroups (array) – User groups that should receive a notifications
  • data.message_subject (string) – Subject of the notification message
  • data.message_text (string) – Text of the notification message
  • data.recovery_message_enabled (boolean) – Enable recovery message
  • data.recovery_message_subject (string) – Recovery message subject
  • data.recovery_message_text (string) – Recovery message text
  • data.enabled (boolean) – Enable or disable the action temporarily without the need to delete it
Status Codes:
DELETE /mon/action/(action_name)
DC-bound?:
Permissions:
Asynchronous?:
Parameters:
  • action_name (string) – required - Monitoring action name
Status Codes: