--- layout: default title: API parent: Alerting nav_order: 15 --- # Alerting API Use the alerting API to programmatically manage monitors and alerts. --- #### Table of contents - TOC {:toc} --- ## Create monitor #### Request ```json POST _plugins/_alerting/monitors { "type": "monitor", "name": "test-monitor", "enabled": true, "schedule": { "period": { "interval": 1, "unit": "MINUTES" } }, "inputs": [{ "search": { "indices": ["movies"], "query": { "size": 0, "aggregations": {}, "query": { "bool": { "filter": { "range": { "@timestamp": { "gte": "||-1h", "lte": "", "format": "epoch_millis" } } } } } } } }], "triggers": [{ "name": "test-trigger", "severity": "1", "condition": { "script": { "source": "ctx.results[0].hits.total.value > 0", "lang": "painless" } }, "actions": [{ "name": "test-action", "destination_id": "ld7912sBlQ5JUWWFThoW", "message_template": { "source": "This is my message body." }, "throttle_enabled": true, "throttle": { "value": 27, "unit": "MINUTES" }, "subject_template": { "source": "TheSubject" } }] }] } ``` If you use a custom webhook for your destination and need to embed JSON in the message body, be sure to escape your quotes: ```json { "message_template": { {% raw %}"source": "{ \"text\": \"Monitor {{ctx.monitor.name}} just entered alert status. Please investigate the issue. - Trigger: {{ctx.trigger.name}} - Severity: {{ctx.trigger.severity}} - Period start: {{ctx.periodStart}} - Period end: {{ctx.periodEnd}}\" }"{% endraw %} } } ``` #### Sample response ```json { "_id": "vd5k2GsBlQ5JUWWFxhsP", "_version": 1, "_seq_no": 7, "_primary_term": 1, "monitor": { "type": "monitor", "schema_version": 1, "name": "test-monitor", "enabled": true, "enabled_time": 1562703611363, "schedule": { "period": { "interval": 1, "unit": "MINUTES" } }, "inputs": [{ "search": { "indices": [ "movies" ], "query": { "size": 0, "query": { "bool": { "filter": [{ "range": { "@timestamp": { "from": "||-1h", "to": "", "include_lower": true, "include_upper": true, "format": "epoch_millis", "boost": 1 } } }], "adjust_pure_negative": true, "boost": 1 } }, "aggregations": {} } } }], "triggers": [{ "id": "ud5k2GsBlQ5JUWWFxRvi", "name": "test-trigger", "severity": "1", "condition": { "script": { "source": "ctx.results[0].hits.total.value > 0", "lang": "painless" } }, "actions": [{ "id": "ut5k2GsBlQ5JUWWFxRvj", "name": "test-action", "destination_id": "ld7912sBlQ5JUWWFThoW", "message_template": { "source": "This is my message body.", "lang": "mustache" }, "throttle_enabled": false, "subject_template": { "source": "TheSubject", "lang": "mustache" } }] }], "last_update_time": 1562703611363 } } ``` If you want to specify a timezone, you can do so by including a [cron expression](../cron/) with a timezone name in the `schedule` section of your request. The following example creates a monitor that runs at 12:10 PM Pacific Time on the 1st day of every month. #### Request ```json { "type": "monitor", "name": "test-monitor", "enabled": true, "schedule": { "cron" : { "expression": "10 12 1 * *", "timezone": "America/Los_Angeles" } }, "inputs": [{ "search": { "indices": ["movies"], "query": { "size": 0, "aggregations": {}, "query": { "bool": { "filter": { "range": { "@timestamp": { "gte": "||-1h", "lte": "", "format": "epoch_millis" } } } } } } } }], "triggers": [{ "name": "test-trigger", "severity": "1", "condition": { "script": { "source": "ctx.results[0].hits.total.value > 0", "lang": "painless" } }, "actions": [{ "name": "test-action", "destination_id": "ld7912sBlQ5JUWWFThoW", "message_template": { "source": "This is my message body." }, "throttle_enabled": true, "throttle": { "value": 27, "unit": "MINUTES" }, "subject_template": { "source": "TheSubject" } }] }] } ``` For a full list of timezone names, refer to [Wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). The alerting plugin uses the Java [TimeZone](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/TimeZone.html) class to convert a [`ZoneId`](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/ZoneId.html) to a valid timezone. --- ## Update monitor When you update a monitor, include the current version number as a parameter. OpenSearch increments the version number automatically (see the sample response). #### Request ```json PUT _plugins/_alerting/monitors/ { "type": "monitor", "name": "test-monitor", "enabled": true, "enabled_time": 1551466220455, "schedule": { "period": { "interval": 1, "unit": "MINUTES" } }, "inputs": [{ "search": { "indices": [ "*" ], "query": { "query": { "match_all": { "boost": 1 } } } } }], "triggers": [{ "id": "StaeOmkBC25HCRGmL_y-", "name": "test-trigger", "severity": "1", "condition": { "script": { "source": "return true", "lang": "painless" } }, "actions": [{ "name": "test-action", "destination_id": "RtaaOmkBC25HCRGm0fxi", "subject_template": { "source": "My Message Subject", "lang": "mustache" }, "message_template": { "source": "This is my message body.", "lang": "mustache" } }] }], "last_update_time": 1551466639295 } ``` #### Sample response ```json { "_id": "Q9aXOmkBC25HCRGmzfw-", "_version": 4, "monitor": { "type": "monitor", "name": "test-monitor", "enabled": true, "enabled_time": 1551466220455, "schedule": { "period": { "interval": 1, "unit": "MINUTES" } }, "inputs": [{ "search": { "indices": [ "*" ], "query": { "query": { "match_all": { "boost": 1 } } } } }], "triggers": [{ "id": "StaeOmkBC25HCRGmL_y-", "name": "test-trigger", "severity": "1", "condition": { "script": { "source": "return true", "lang": "painless" } }, "actions": [{ "name": "test-action", "destination_id": "RtaaOmkBC25HCRGm0fxi", "subject_template": { "source": "My Message Subject", "lang": "mustache" }, "message_template": { "source": "This is my message body.", "lang": "mustache" } }] }], "last_update_time": 1551466761596 } } ``` --- ## Get monitor #### Request ``` GET _plugins/_alerting/monitors/ ``` #### Sample response ```json { "_id": "Q9aXOmkBC25HCRGmzfw-", "_version": 3, "monitor": { "type": "monitor", "name": "test-monitor", "enabled": true, "enabled_time": 1551466220455, "schedule": { "period": { "interval": 1, "unit": "MINUTES" } }, "inputs": [{ "search": { "indices": [ "*" ], "query": { "query": { "match_all": { "boost": 1 } } } } }], "triggers": [{ "id": "StaeOmkBC25HCRGmL_y-", "name": "test-trigger", "severity": "1", "condition": { "script": { "source": "return true", "lang": "painless" } }, "actions": [{ "name": "test-action", "destination_id": "RtaaOmkBC25HCRGm0fxi", "subject_template": { "source": "My Message Subject", "lang": "mustache" }, "message_template": { "source": "This is my message body.", "lang": "mustache" } }] }], "last_update_time": 1551466639295 } } ``` --- ## Monitor stats Returns statistics about the alerting feature. Use `_plugins/_alerting/stats` to find node IDs and metrics. Then you can drill down using those values. #### Request ```json GET _plugins/_alerting/stats GET _plugins/_alerting/stats/ GET _plugins/_alerting//stats GET _plugins/_alerting//stats/ ``` #### Sample response ```json { "_nodes": { "total": 9, "successful": 9, "failed": 0 }, "cluster_name": "475300751431:alerting65-dont-delete", "opensearch.scheduled_jobs.enabled": true, "scheduled_job_index_exists": true, "scheduled_job_index_status": "green", "nodes_on_schedule": 9, "nodes_not_on_schedule": 0, "nodes": { "qWcbKbb-TVyyI-Q7VSeOqA": { "name": "qWcbKbb", "schedule_status": "green", "roles": [ "MASTER" ], "job_scheduling_metrics": { "last_full_sweep_time_millis": 207017, "full_sweep_on_time": true }, "jobs_info": {} }, "Do-DX9ZcS06Y9w1XbSJo1A": { "name": "Do-DX9Z", "schedule_status": "green", "roles": [ "DATA", "INGEST" ], "job_scheduling_metrics": { "last_full_sweep_time_millis": 230516, "full_sweep_on_time": true }, "jobs_info": {} }, "n5phkBiYQfS5I0FDzcqjZQ": { "name": "n5phkBi", "schedule_status": "green", "roles": [ "MASTER" ], "job_scheduling_metrics": { "last_full_sweep_time_millis": 228406, "full_sweep_on_time": true }, "jobs_info": {} }, "Tazzo8cQSY-g3vOjgYYLzA": { "name": "Tazzo8c", "schedule_status": "green", "roles": [ "DATA", "INGEST" ], "job_scheduling_metrics": { "last_full_sweep_time_millis": 211722, "full_sweep_on_time": true }, "jobs_info": { "i-wsFmkB8NzS6aXjQSk0": { "last_execution_time": 1550864912882, "running_on_time": true } } }, "Nyf7F8brTOSJuFPXw6CnpA": { "name": "Nyf7F8b", "schedule_status": "green", "roles": [ "DATA", "INGEST" ], "job_scheduling_metrics": { "last_full_sweep_time_millis": 223300, "full_sweep_on_time": true }, "jobs_info": { "NbpoFmkBeSe-hD59AKgE": { "last_execution_time": 1550864928354, "running_on_time": true }, "-LlLFmkBeSe-hD59Ydtb": { "last_execution_time": 1550864732727, "running_on_time": true }, "pBFxFmkBNXkgNmTBaFj1": { "last_execution_time": 1550863325024, "running_on_time": true }, "hfasEmkBNXkgNmTBrvIW": { "last_execution_time": 1550862000001, "running_on_time": true } } }, "oOdJDIBVT5qbbO3d8VLeEw": { "name": "oOdJDIB", "schedule_status": "green", "roles": [ "DATA", "INGEST" ], "job_scheduling_metrics": { "last_full_sweep_time_millis": 227570, "full_sweep_on_time": true }, "jobs_info": { "4hKRFmkBNXkgNmTBKjYX": { "last_execution_time": 1550864806101, "running_on_time": true } } }, "NRDG6JYgR8m0GOZYQ9QGjQ": { "name": "NRDG6JY", "schedule_status": "green", "roles": [ "MASTER" ], "job_scheduling_metrics": { "last_full_sweep_time_millis": 227652, "full_sweep_on_time": true }, "jobs_info": {} }, "URMrXRz3Tm-CB72hlsl93Q": { "name": "URMrXRz", "schedule_status": "green", "roles": [ "DATA", "INGEST" ], "job_scheduling_metrics": { "last_full_sweep_time_millis": 231048, "full_sweep_on_time": true }, "jobs_info": { "m7uKFmkBeSe-hD59jplP": { "running_on_time": true } } }, "eXgt1k9oTRCLmx2HBGElUw": { "name": "eXgt1k9", "schedule_status": "green", "roles": [ "DATA", "INGEST" ], "job_scheduling_metrics": { "last_full_sweep_time_millis": 229234, "full_sweep_on_time": true }, "jobs_info": { "wWkFFmkBc2NG-PeLntxk": { "running_on_time": true }, "3usNFmkB8NzS6aXjO1Gs": { "last_execution_time": 1550863959848, "running_on_time": true } } } } } ``` --- ## Delete monitor #### Request ``` DELETE _plugins/_alerting/monitors/ ``` #### Sample response ```json { "_index": ".opensearch-scheduled-jobs", "_type": "_doc", "_id": "OYAHOmgBl3cmwnqZl_yH", "_version": 2, "result": "deleted", "forced_refresh": true, "_shards": { "total": 2, "successful": 2, "failed": 0 }, "_seq_no": 11, "_primary_term": 1 } ``` --- ## Search monitors #### Request ```json GET _plugins/_alerting/monitors/_search { "query": { "match" : { "monitor.name": "my-monitor-name" } } } ``` #### Sample response ```json { "took": 17, "timed_out": false, "_shards": { "total": 5, "successful": 5, "skipped": 0, "failed": 0 }, "hits": { "total": 1, "max_score": 0.6931472, "hits": [{ "_index": ".opensearch-scheduled-jobs", "_type": "_doc", "_id": "eGQi7GcBRS7-AJEqfAnr", "_score": 0.6931472, "_source": { "type": "monitor", "name": "my-monitor-name", "enabled": true, "enabled_time": 1545854942426, "schedule": { "period": { "interval": 1, "unit": "MINUTES" } }, "inputs": [{ "search": { "indices": [ "*" ], "query": { "size": 0, "query": { "bool": { "filter": [{ "range": { "@timestamp": { "from": "{{period_end}}||-1h", "to": "{{period_end}}", "include_lower": true, "include_upper": true, "format": "epoch_millis", "boost": 1 } } }], "adjust_pure_negative": true, "boost": 1 } }, "aggregations": {} } } }], "triggers": [{ "id": "Sooi7GcB53a0ewuj_6MH", "name": "Over", "severity": "1", "condition": { "script": { "source": "_ctx.results[0].hits.total > 400000", "lang": "painless" } }, "actions": [] }], "last_update_time": 1545854975758 } }] } } ``` --- ## Run monitor You can add the optional `?dryrun=true` parameter to the URL to show the results of a run without actions sending any message. #### Request ```json POST _plugins/_alerting/monitors//_execute ``` #### Sample response ```json { "monitor_name": "logs", "period_start": 1547161872322, "period_end": 1547161932322, "error": null, "trigger_results": { "Sooi7GcB53a0ewuj_6MH": { "name": "Over", "triggered": true, "error": null, "action_results": {} } } } ``` --- ## Get alerts Returns an array of all alerts. #### Request ```json GET _plugins/_alerting/monitors/alerts ``` #### Response ```json { "alerts": [ { "id": "eQURa3gBKo1jAh6qUo49", "version": 300, "monitor_id": "awUMa3gBKo1jAh6qu47E", "schema_version": 2, "monitor_version": 2, "monitor_name": "Example_monitor_name", "monitor_user": { "name": "admin", "backend_roles": [ "admin" ], "roles": [ "all_access", "own_index" ], "custom_attribute_names": [], "user_requested_tenant": null }, "trigger_id": "bQUQa3gBKo1jAh6qnY6G", "trigger_name": "Example_trigger_name", "state": "ACTIVE", "error_message": null, "alert_history": [ { "timestamp": 1617314504873, "message": "Example error emssage" }, { "timestamp": 1617312543925, "message": "Example error message" } ], "severity": "1", "action_execution_results": [ { "action_id": "bgUQa3gBKo1jAh6qnY6G", "last_execution_time": 1617317979908, "throttled_count": 0 } ], "start_time": 1616704000492, "last_notification_time": 1617317979908, "end_time": null, "acknowledged_time": null } ], "totalAlerts": 1 } ``` --- ## Acknowledge alert [After getting your alerts](#get-alerts/), you can acknowledge any number of active alerts in one call. If the alert is already in an ERROR, COMPLETED, or ACKNOWLEDGED state, it appears in the `failed` array. #### Request ```json POST _plugins/_alerting/monitors//_acknowledge/alerts { "alerts": ["eQURa3gBKo1jAh6qUo49"] } ``` #### Sample response ```json { "success": [ "eQURa3gBKo1jAh6qUo49" ], "failed": [] } ``` --- ## Create destination #### Requests ```json POST _plugins/_alerting/destinations { "name": "my-destination", "type": "slack", "slack": { "url": "http://www.example.com" } } POST _plugins/_alerting/destinations { "type": "custom_webhook", "name": "my-custom-destination", "custom_webhook": { "path": "incomingwebhooks/123456-123456-XXXXXX", "header_params": { "Content-Type": "application/json" }, "scheme": "HTTPS", "port": 443, "query_params": { "token": "R2x1UlN4ZHF8MXxxVFJpelJNVDgzdGNwXXXXXXXXX" }, "host": "hooks.chime.aws" } } ``` #### Sample response ```json { "_id": "nO-yFmkB8NzS6aXjJdiI", "_version": 1, "destination": { "type": "slack", "name": "my-destination", "last_update_time": 1550863967624, "slack": { "url": "http://www.example.com" } } } ``` --- ## Update destination #### Request ```json PUT _plugins/_alerting/destinations/ { "name": "my-updated-destination", "type": "slack", "slack": { "url": "http://www.example.com" } } ``` #### Sample response ```json { "_id": "pe-1FmkB8NzS6aXjqvVY", "_version": 4, "destination": { "type": "slack", "name": "my-updated-destination", "last_update_time": 1550864289375, "slack": { "url": "http://www.example.com" } } } ``` --- ## Get destination Retrieve one destination. #### Requests ```json GET _plugins/_alerting/destinations/ ``` #### Sample response ```json { "totalDestinations": 1, "destinations": [{ "id": "1a2a3a4a5a6a7a", "type": "slack", "name": "sample-destination", "user": { "name": "psantos", "backend_roles": [ "human-resources" ], "roles": [ "alerting_full_access", "hr-role" ], "custom_attribute_names": [] }, "schema_version": 3, "seq_no": 0, "primary_term": 6, "last_update_time": 1603943261722, "slack": { "url": "https://example.com" } } ] } ``` --- ## Get destinations Retrieve all destinations. #### Requests ```json GET _plugins/_alerting/destinations ``` #### Sample response ```json { "totalDestinations": 1, "destinations": [{ "id": "1a2a3a4a5a6a7a", "type": "slack", "name": "sample-destination", "user": { "name": "psantos", "backend_roles": [ "human-resources" ], "roles": [ "alerting_full_access", "hr-role" ], "custom_attribute_names": [] }, "schema_version": 3, "seq_no": 0, "primary_term": 6, "last_update_time": 1603943261722, "slack": { "url": "https://example.com" } } ] } ``` --- ## Delete destination #### Request ``` DELETE _plugins/_alerting/destinations/ ``` #### Sample response ```json { "_index": ".opendistro-alerting-config", "_type": "_doc", "_id": "Zu-zFmkB8NzS6aXjLeBI", "_version": 2, "result": "deleted", "forced_refresh": true, "_shards": { "total": 2, "successful": 2, "failed": 0 }, "_seq_no": 8, "_primary_term": 1 } ``` --- ## Create email account #### Request ```json POST _plugins/_alerting/destinations/email_accounts { "name": "example_account", "email": "example@email.com", "host": "smtp.email.com", "port": 465, "method": "ssl" } ``` #### Sample response ```json { "_id" : "email_account_id", "_version" : 1, "_seq_no" : 7, "_primary_term" : 2, "email_account" : { "schema_version" : 2, "name" : "example_account", "email" : "example@email.com", "host" : "smtp.email.com", "port" : 465, "method" : "ssl" } } ``` ## Update email account #### Request ```json PUT _plugins/_alerting/destinations/email_accounts/ { "name": "example_account", "email": "example@email.com", "host": "smtp.email.com", "port": 465, "method": "ssl" } ``` #### Sample response ```json { "_id" : "email_account_id", "_version" : 3, "_seq_no" : 19, "_primary_term" : 2, "email_account" : { "schema_version" : 2, "name" : "example_account", "email" : "example@email.com", "host" : "smtp.email.com", "port" : 465, "method" : "ssl" } } ``` ## Get email account #### Request ```json GET _plugins/_alerting/destinations/email_accounts/ { "name": "example_account", "email": "example@email.com", "host": "smtp.email.com", "port": 465, "method": "ssl" } ``` #### Sample response ```json { "_id" : "email_account_id", "_version" : 2, "_seq_no" : 8, "_primary_term" : 2, "email_account" : { "schema_version" : 2, "name" : "test_account", "email" : "test@email.com", "host" : "smtp.test.com", "port" : 465, "method" : "ssl" } } ``` ## Delete email account #### Request ``` DELETE _plugins/_alerting/destinations/email_accounts/ ``` #### Sample response ```json { "_index" : ".opendistro-alerting-config", "_type" : "_doc", "_id" : "email_account_id", "_version" : 1, "result" : "deleted", "forced_refresh" : true, "_shards" : { "total" : 2, "successful" : 2, "failed" : 0 }, "_seq_no" : 12, "_primary_term" : 2 } ``` ## Search email account #### Request ```json POST _plugins/_alerting/destinations/email_accounts/_search { "from": 0, "size": 20, "sort": { "email_account.name.keyword": "desc" }, "query": { "bool": { "must": { "match_all": {} } } } } ``` #### Sample response ```json { "took" : 8, "timed_out" : false, "_shards" : { "total" : 1, "successful" : 1, "skipped" : 0, "failed" : 0 }, "hits" : { "total" : { "value" : 2, "relation" : "eq" }, "max_score" : null, "hits" : [ { "_index" : ".opendistro-alerting-config", "_type" : "_doc", "_id" : "email_account_id", "_seq_no" : 8, "_primary_term" : 2, "_score" : null, "_source" : { "schema_version" : 2, "name" : "example_account", "email" : "example@email.com", "host" : "smtp.email.com", "port" : 465, "method" : "ssl" }, "sort" : [ "example_account" ] }, ... ] } } ``` --- ## Create email group #### Request ```json POST _plugins/_alerting/destinations/email_groups { "name": "example_email_group", "emails": [{ "email": "example@email.com" }] } ``` #### Sample response ```json { "_id" : "email_group_id", "_version" : 1, "_seq_no" : 9, "_primary_term" : 2, "email_group" : { "schema_version" : 2, "name" : "example_email_group", "emails" : [ { "email" : "example@email.com" } ] } } ``` ## Update email group #### Request ```json PUT _plugins/_alerting/destinations/email_groups/ { "name": "example_email_group", "emails": [{ "email": "example@email.com" }] } ``` #### Sample response ```json { "_id" : "email_group_id", "_version" : 4, "_seq_no" : 17, "_primary_term" : 2, "email_group" : { "schema_version" : 2, "name" : "example_email_group", "emails" : [ { "email" : "example@email.com" } ] } } ``` ## Get email group #### Request ```json GET _plugins/_alerting/destinations/email_groups/ { "name": "example_email_group", "emails": [{ "email": "example@email.com" }] } ``` #### Sample response ```json { "_id" : "email_group_id", "_version" : 4, "_seq_no" : 17, "_primary_term" : 2, "email_group" : { "schema_version" : 2, "name" : "example_email_group", "emails" : [ { "email" : "example@email.com" } ] } } ``` ## Delete email group #### Request ``` DELETE _plugins/_alerting/destinations/email_groups/ ``` #### Sample response ```json { "_index" : ".opendistro-alerting-config", "_type" : "_doc", "_id" : "email_group_id", "_version" : 1, "result" : "deleted", "forced_refresh" : true, "_shards" : { "total" : 2, "successful" : 2, "failed" : 0 }, "_seq_no" : 11, "_primary_term" : 2 } ``` ## Search email group #### Request ```json POST _plugins/_alerting/destinations/email_groups/_search { "from": 0, "size": 20, "sort": { "email_group.name.keyword": "desc" }, "query": { "bool": { "must": { "match_all": {} } } } } ``` #### Sample response ```json { "took" : 7, "timed_out" : false, "_shards" : { "total" : 1, "successful" : 1, "skipped" : 0, "failed" : 0 }, "hits" : { "total" : { "value" : 5, "relation" : "eq" }, "max_score" : null, "hits" : [ { "_index" : ".opendistro-alerting-config", "_type" : "_doc", "_id" : "email_group_id", "_seq_no" : 10, "_primary_term" : 2, "_score" : null, "_source" : { "schema_version" : 2, "name" : "example_email_group", "emails" : [ { "email" : "example@email.com" } ] }, "sort" : [ "example_email_group" ] }, ... ] } } ``` ---