Get an alert by identifier | Kibana API (v8)

Get an alert by identifier Deprecated

GET /api/alerts/alert/{alertId}

Deprecated in 7.13.0. Use the get rule API instead.

Path parameters

alertId string Required

The identifier for the alert.

Responses

200 application/json; Elastic-Api-Version=2023-10-31

Indicates a successful call.
Hide response attributes Show response attributes object
- actions array[object]
  
  Additional properties are allowed.
- alertTypeId string
- apiKeyOwner string | null
- createdAt string(date-time)
  
  The date and time that the alert was created.
- createdBy string
  
  The identifier for the user that created the alert.
- enabled boolean
  
  Indicates whether the alert is currently enabled.
- executionStatus object
  
  Additional properties are allowed.
  
  Hide executionStatus attributes Show executionStatus attributes object
  
  lastExecutionDate string(date-time)
  
  status string
- id string
  
  The identifier for the alert.
- muteAll boolean
- mutedInstanceIds array[string] | null
- name string
  
  The name of the alert.
- notifyWhen string
- params object
  
  Additional properties are allowed.
- schedule object
  
  Additional properties are allowed.
  
  Hide schedule attribute Show schedule attribute object
  
  interval string
- scheduledTaskId string
- tags array[string]
- throttle string | null
- updatedAt string
- updatedBy string | null
  
  The identifier for the user that updated this alert most recently.
401 application/json; Elastic-Api-Version=2023-10-31

Authorization information is missing or invalid.
Hide response attributes Show response attributes object
- error string
  
  Value is Unauthorized.
- message string
- statusCode integer
  
  Value is 401.

GET /api/alerts/alert/{alertId}

curl \
 -X GET https://localhost:5601/api/alerts/alert/41893910-6bca-11eb-9e0d-85d233e3ee35

Response examples (200)

{
  "actions": [
    {}
  ],
  "alertTypeId": ".index-threshold",
  "apiKeyOwner": "elastic",
  "createdAt": "2022-12-05T23:36:58.284Z",
  "createdBy": "elastic",
  "enabled": true,
  "executionStatus": {
    "lastExecutionDate": "2022-12-06T00:13:43.890Z",
    "status": "ok"
  },
  "id": "b530fed0-74f5-11ed-9801-35303b735aef",
  "muteAll": false,
  "mutedInstanceIds": [
    "string"
  ],
  "name": "my alert",
  "notifyWhen": "onActionGroupChange",
  "params": {},
  "schedule": {
    "interval": "string"
  },
  "scheduledTaskId": "b530fed0-74f5-11ed-9801-35303b735aef",
  "tags": [
    "string"
  ],
  "throttle": "string",
  "updatedAt": "2022-12-05T23:36:58.284Z",
  "updatedBy": "elastic"
}

Response examples (401)

{
  "error": "Unauthorized",
  "message": "string",
  "statusCode": 401
}