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

OPTIONS, HEAD, GET/index
OPTIONS, POST/alertreceive_alert
OPTIONS, HEAD, GET/alert/<id>get_alert
OPTIONS, POST, DELETE/alert/<id>delete_alert
OPTIONS, PUT/alert/<id>/attributesupdate_attributes
OPTIONS, POST, PUT/alert/<id>/statusset_status
OPTIONS, POST, PUT/alert/<id>/tagtag_alert
OPTIONS, POST, PUT/alert/<id>/untaguntag_alert
OPTIONS, HEAD, GET/alertsget_alerts
OPTIONS, HEAD, GET/alerts/countget_counts
OPTIONS, HEAD, GET/alerts/historyget_history
OPTIONS, HEAD, GET/alerts/top10get_top10_count
OPTIONS, HEAD, GET/alerts/top10/countget_top10_count
OPTIONS, HEAD, GET/alerts/top10/flappingget_top10_flapping
OPTIONS, HEAD, GET/auth/confirm/<hash>verify_email
OPTIONS, POST/auth/githubgithub
OPTIONS, POST/auth/gitlabgitlab
OPTIONS, POST/auth/googlegoogle
OPTIONS, POST/auth/loginlogin
OPTIONS, POST/auth/signupsignup
OPTIONS, POST/blackoutcreate_blackout
OPTIONS, POST, DELETE/blackout/<path:blackout>delete_blackout
OPTIONS, HEAD, GET/blackoutsget_blackouts
OPTIONS, POST/customercreate_customer
OPTIONS, POST, DELETE/customer/<customer>delete_customer
OPTIONS, HEAD, GET/customersget_customers
OPTIONS, HEAD, GET/embed.jsembed_js
OPTIONS, HEAD, GET/environmentsget_environments
OPTIONS, POST/heartbeatcreate_heartbeat
OPTIONS, HEAD, GET/heartbeat/<id>get_heartbeat
OPTIONS, POST, DELETE/heartbeat/<id>delete_heartbeat
OPTIONS, HEAD, GET/heartbeatsget_heartbeats
OPTIONS, POST/keycreate_key
OPTIONS, POST, DELETE/key/<path:key>delete_key
OPTIONS, HEAD, GET/keysget_keys
OPTIONS, HEAD, GET/managementmanagement
OPTIONS, HEAD, GET/management/gtggood_to_go
OPTIONS, HEAD, GET/management/healthcheckhealth_check
OPTIONS, HEAD, GET/management/manifestmanifest
OPTIONS, HEAD, GET/management/metricsprometheus_metrics
OPTIONS, HEAD, GET/management/propertiesproperties
OPTIONS, HEAD, GET/management/statusstatus
OPTIONS, POST, GET, HEAD/management/switchboardswitchboard
OPTIONS, HEAD, GET/oembedoembed
OPTIONS, HEAD, GET/oembed.<format>oembed
OPTIONS, HEAD, GET/servicesget_services
OPTIONS, POST/usercreate_user
OPTIONS, PUT/user/<user>update_user
OPTIONS, POST, DELETE/user/<user>delete_user
OPTIONS, HEAD, GET/userinfouserinfo
OPTIONS, HEAD, GET/usersget_users
OPTIONS, POST/webhooks/cloudwatchcloudwatch
OPTIONS, POST/webhooks/grafanagrafana
OPTIONS, POST/webhooks/newrelicnewrelic
OPTIONS, POST/webhooks/pagerdutypagerduty
OPTIONS, HEAD, GET/webhooks/pingdompingdom
OPTIONS, POST/webhooks/prometheusprometheus
OPTIONS, POST/webhooks/riemannriemann
OPTIONS, POST/webhooks/serverdensityserverdensity
OPTIONS, POST/webhooks/stackdriverstackdriver
OPTIONS, POST/webhooks/telegramtelegram