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

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