Get alert APIedit
Retrieve an alert by ID.
Requestedit
GET <kibana host>:<port>/api/alerts/alert/<id>
Path parametersedit
-
id
- (Required, string) The ID of the alert to retrieve.
Response codeedit
-
200
- Indicates a successful call.
Exampleedit
Retrieve the alert object with the ID 41893910-6bca-11eb-9e0d-85d233e3ee35
:
$ curl -X GET api/alerts/alert/41893910-6bca-11eb-9e0d-85d233e3ee35
The API returns the following:
{ "id": "0a037d60-6b62-11eb-9e0d-85d233e3ee35", "notifyWhen": "onActionGroupChange", "params": { "aggType": "avg", }, "consumer": "alerts", "alertTypeId": "test.alert.type", "schedule": { "interval": "1m" }, "actions": [], "tags": [], "name": "test alert", "enabled": true, "throttle": null, "apiKeyOwner": "elastic", "createdBy": "elastic", "updatedBy": "elastic", "muteAll": false, "mutedInstanceIds": [], "updatedAt": "2021-02-10T05:37:19.086Z", "createdAt": "2021-02-10T05:37:19.086Z", "scheduledTaskId": "0b092d90-6b62-11eb-9e0d-85d233e3ee35", "executionStatus": { "lastExecutionDate": "2021-02-10T17:55:14.262Z", "status": "ok" } }