kibana/api_docs/alerting.mdx

73 lines
1.8 KiB
Text

---
####
#### 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.
####
id: kibAlertingPluginApi
slug: /kibana-dev-docs/api/alerting
title: "alerting"
image: https://source.unsplash.com/400x175/?github
description: API docs for the alerting plugin
date: 2023-04-26
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'alerting']
---
import alertingObj from './alerting.devdocs.json';
Contact [@elastic/response-ops](https://github.com/orgs/elastic/teams/response-ops) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 609 | 1 | 588 | 42 |
## Client
### Setup
<DocDefinitionList data={[alertingObj.client.setup]}/>
### Start
<DocDefinitionList data={[alertingObj.client.start]}/>
### Consts, variables and types
<DocDefinitionList data={alertingObj.client.misc}/>
## Server
### Objects
<DocDefinitionList data={alertingObj.server.objects}/>
### 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}/>