IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

List rule types API

edit

List rule types API

edit

Retrieve a list of alerting rule types that the user is authorized to access.

Each rule type includes a list of consumer features. Within these features, users are authorized to perform either read or all operations on rules of that type. This helps determine which rule types users can read, but not create or modify.

Some rule types are limited to specific features. These rule types are not available when defining rules in Stack Management.

Request

edit

GET <kibana host>:<port>/api/alerting/rule_types

GET <kibana host>:<port>/s/<space_id>/api/alerting/rule_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/alerting/rule_types

The API returns the following:

[
   {
      "id":".index-threshold",
      "name":"Index threshold",
      "action_groups":[
         {
            "id":"threshold met",
            "name":"Threshold met"
         },
         {
            "id":"recovered",
            "name":"Recovered"
         }
      ],
      "recovery_action_group":{
         "id":"recovered",
         "name":"Recovered"
      },
      "default_action_group_id":"threshold met",
      "action_variables":{
         "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",
      "minimum_license_required":"basic",
      "enabled_in_license":true,
      "authorized_consumers":{
         "alerts":{
            "read":true,
            "all":true
         },
         "stackAlerts":{
            "read":true,
            "all":true
         },
         "uptime":{
            "read":true,
            "all":true
         }
      }
   }
]

Each rule type contains the following properties:

`name`	The descriptive name of the rule type.
`id`	The unique ID of the rule type.
`minimum_license_required`	The license required to use the rule type.
`enabled_in_license`	Whether the rule type is enabled or disabled based on the license.
`action_groups`	An explicit list of groups for which the rule type can schedule actions, each with the action group’s unique ID and human readable name. Rule `actions` validation will use this configuration to ensure that groups are valid. Use `kbn-i18n` to translate the names of the action group when registering the rule type.
`recovery_action_group`	An action group to use when an alert goes from an active state, to an inactive one. Do not specify this action group under the `action_groups` property. If `recovery_action_group` is not specified, the default `recovered` action group is used.
`default_action_group_od`	The default ID for the rule type group.
`action_variables`	An explicit list of action variables that the rule type makes available via context and state in action parameter templates, and a short human readable description. The Rule UI will use this information to prompt users for these variables in action parameter editors. Use `kbn-i18n` to translate the descriptions.
`producer`	The ID of the application producing this rule type.
`authorized_consumers`	The list of the plugins IDs that have access to the rule type.

« Find rules API Enable rule API »