Alerta API

Welcome to the Alerta API for the monitoring and alerting tool.

Examples

Some basic examples of using the API are:

Query parameters

Query parameters can be used to filter the results by any valid alert attribute.

environment=PRODequality - return alerts whose environment field has the value of PROD
environment!=PRODinvert - return alerts whose environment does not have the value PROD
service=~frontend.*regex - return alerts whose service field starts with frontend
service!=~frontend.*invert regex - return alerts whose service field does not start with frontend

Special query parameters include 'limit', 'sort-by', 'from-date' and 'q' (for a free-form query).

limit=5return the five most recent alerts for the filter
sort-by=resourcesort the results by alert resource
from-date=2014-01-07T11:11:24.135Zreturn alerts from a certain date and time onwards
q={"$or":[{"service":"Nova"},{"resource":{"$regex":"nova"}}]}return Nova service alerts or resource with nova

Routes

{% for rule in rules|sort(attribute='rule') %} {% endfor %}
{{ rule.methods|join(', ') }}{{ rule.rule }}{{ rule.endpoint }}