New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Update alert API Delete alert API »
Elastic Docs ›Kibana Guide [7.11] ›REST API ›Alerts APIs

Get alert API

edit

Get alert API

edit

Retrieve an alert by ID.

Request

edit

GET <kibana host>:<port>/api/alerts/alert/<id>

GET <kibana host>:<port>/s/<space_id>/api/alerts/alert/<id>

Path parameters

edit
id
(Required, string) The ID of the alert to retrieve.
space_id
(Optional, string) An identifier for the space. If space_id is not provided in the URL, the default space is used.

Response code

edit
200
Indicates a successful call.

Example

edit

Retrieve the alert object with the ID 41893910-6bca-11eb-9e0d-85d233e3ee35:

$ curl -X GET api/alerts/alert/41893910-6bca-11eb-9e0d-85d233e3ee35
Copy as curl 

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"
  }
}
« Update alert API Delete alert API »

On this page

Was this helpful?
Feedback