68 lines
1.7 KiB
Plaintext
68 lines
1.7 KiB
Plaintext
---
|
|
id: kibAlertingPluginApi
|
|
slug: /kibana-dev-docs/api/alerting
|
|
title: "alerting"
|
|
image: https://source.unsplash.com/400x175/?github
|
|
summary: API docs for the alerting plugin
|
|
date: 2020-11-16
|
|
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
|
|
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
|
|
---
|
|
import alertingObj from './alerting.json';
|
|
|
|
|
|
|
|
Contact [Kibana Alerting](https://github.com/orgs/elastic/teams/kibana-alerting-services) for questions regarding this plugin.
|
|
|
|
**Code health stats**
|
|
|
|
| Public API count | Any count | Items lacking comments | Missing exports |
|
|
|-------------------|-----------|------------------------|-----------------|
|
|
| 258 | 0 | 250 | 17 |
|
|
|
|
## Client
|
|
|
|
### Setup
|
|
<DocDefinitionList data={[alertingObj.client.setup]}/>
|
|
|
|
### Start
|
|
<DocDefinitionList data={[alertingObj.client.start]}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={alertingObj.client.misc}/>
|
|
|
|
## Server
|
|
|
|
### Functions
|
|
<DocDefinitionList data={alertingObj.server.functions}/>
|
|
|
|
### Classes
|
|
<DocDefinitionList data={alertingObj.server.classes}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={alertingObj.server.interfaces}/>
|
|
|
|
### Enums
|
|
<DocDefinitionList data={alertingObj.server.enums}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={alertingObj.server.misc}/>
|
|
|
|
## Common
|
|
|
|
### Objects
|
|
<DocDefinitionList data={alertingObj.common.objects}/>
|
|
|
|
### Functions
|
|
<DocDefinitionList data={alertingObj.common.functions}/>
|
|
|
|
### Interfaces
|
|
<DocDefinitionList data={alertingObj.common.interfaces}/>
|
|
|
|
### Enums
|
|
<DocDefinitionList data={alertingObj.common.enums}/>
|
|
|
|
### Consts, variables and types
|
|
<DocDefinitionList data={alertingObj.common.misc}/>
|
|
|