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

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