Welcome to the Alerta API for the monitoring and alerting tool.
Some basic examples of using the API are:
Query parameters can be used to filter the results by any valid alert attribute.
| environment=PROD | equality - return alerts whose environment field has the value of PROD |
| environment!=PROD | invert - 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=5 | return the five most recent alerts for the filter |
| sort-by=resource | sort the results by alert resource |
| from-date=2014-01-07T11:11:24.135Z | return alerts from a certain date and time onwards |
| q={"$or":[{"service":"Nova"},{"resource":{"$regex":"nova"}}]} | return Nova service alerts or resource with nova |
| {{ rule.methods|join(', ') }} | {{ rule.rule }} | {{ rule.endpoint }} |