- Kibana Guide: other versions:
- What is Kibana?
- What’s new in 8.2
- Kibana concepts
- Quick start
- Set up
- Install Kibana
- Configure Kibana
- Alerting and action settings
- APM settings
- Banners settings
- Enterprise Search settings
- Fleet settings
- i18n settings
- Logging settings
- Logs settings
- Metrics settings
- Monitoring settings
- Reporting settings
- Search sessions settings
- Secure settings
- Security settings
- Spaces settings
- Task Manager settings
- Telemetry settings
- URL drilldown settings
- Start and stop Kibana
- Access Kibana
- Securing access to Kibana
- Add data
- Upgrade Kibana
- Configure security
- Configure reporting
- Configure logging
- Configure monitoring
- Command line tools
- Production considerations
- Discover
- Dashboard and visualizations
- Canvas
- Maps
- Build a map to compare metrics by country or region
- Track, visualize, and alert on assets in real time
- Map custom regions with reverse geocoding
- Heat map layer
- Tile layer
- Vector layer
- Plot big data
- Search geographic data
- Configure map settings
- Connect to Elastic Maps Service
- Import geospatial data
- Troubleshoot
- Reporting and sharing
- Machine learning
- Graph
- Alerting
- Observability
- APM
- Security
- Dev Tools
- Fleet
- Osquery
- Stack Monitoring
- Stack Management
- REST API
- Get features API
- Kibana spaces APIs
- Kibana role management APIs
- User session management APIs
- Saved objects APIs
- Data views API
- Index patterns APIs
- Alerting APIs
- Action and connector APIs
- Cases APIs
- Import and export dashboard APIs
- Logstash configuration management APIs
- Machine learning APIs
- Short URLs APIs
- Get Task Manager health
- Upgrade assistant APIs
- Kibana plugins
- Troubleshooting
- Accessibility
- Release notes
- Developer guide
List rule types API
editList rule types API
editRetrieve a list of 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
editGET <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", "is_exportable":true, "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:
|
The descriptive name of the rule type. |
|
The unique ID of the rule type. |
|
The license required to use the rule type. |
|
Whether the rule type is exportable through the Saved Objects Management UI. |
|
Whether the rule type is enabled or disabled based on the license. |
|
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 |
|
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 |
|
The default ID for the rule type group. |
|
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 |
|
The ID of the application producing this rule type. |
|
The list of the plugins IDs that have access to the rule type. |
On this page