List alert types API
editList alert types API
editRetrieve a list of all alert types.
Request
editGET <kibana host>:<port>/api/alerts/list_alert_types
GET <kibana host>:<port>/s/<space_id>/api/alerts/list_alert_types
Path parameters
edit-
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$ curl -X GET api/alerts/list_alert_types
The API returns the following:
[ { "id":".index-threshold", "name":"Index threshold", "actionGroups":[ { "id":"threshold met", "name":"Threshold met" }, { "id":"recovered", "name":"Recovered" } ], "recoveryActionGroup":{ "id":"recovered", "name":"Recovered" }, "defaultActionGroupId":"threshold met", "actionVariables":{ "context":[ { "name":"message", "description":"A pre-constructed message for the alert." }, ], "state":[], "params":[ { "name":"threshold", "description":"An array of values to use as the threshold; 'between' and 'notBetween' require two values, the others require one." }, { "name":"index", "description":"index" }, ] }, "producer":"stackAlerts", "minimumLicenseRequired":"basic", "enabledInLicense":true, "authorizedConsumers":{ "alerts":{ "read":true, "all":true }, "stackAlerts":{ "read":true, "all":true }, "uptime":{ "read":true, "all":true } } } ]
Each alert type contains the following properties:
|
The descriptive name of the alert type. |
|
The unique ID of the alert type. |
|
The license required to use the alert type. |
|
Whether the alert type is enabled or disabled based on the license. |
|
An explicit list of groups for which the alert type can schedule actions, each with the action group’s unique ID and human readable name. Alert |
|
An action group to use when an alert instance goes from an active state, to an inactive one. Do not specify this action group under the |
|
The default ID for the alert type group. |
|
An explicit list of action variables that the alert type makes available via context and state in action parameter templates, and a short human readable description. The Alert UI will use this information to prompt users for these variables in action parameter editors. Use |
|
The ID of the application producing this alert type. |
|
The list of the plugins IDs that have access to the alert type. |