kibana/api_docs/osquery.mdx
Stacey Gammon 6723fa583f
Add packages to our API documentation (#113564)
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
2021-10-06 17:02:57 -04:00

44 lines
1.1 KiB
Plaintext

---
id: kibOsqueryPluginApi
slug: /kibana-dev-docs/api/osquery
title: "osquery"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the osquery plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'osquery']
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 osqueryObj from './osquery.json';
Contact [Security asset management](https://github.com/orgs/elastic/teams/security-asset-management) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 11 | 0 | 11 | 0 |
## Client
### Setup
<DocDefinitionList data={[osqueryObj.client.setup]}/>
### Start
<DocDefinitionList data={[osqueryObj.client.start]}/>
## Server
### Setup
<DocDefinitionList data={[osqueryObj.server.setup]}/>
### Start
<DocDefinitionList data={[osqueryObj.server.start]}/>
## Common
### Consts, variables and types
<DocDefinitionList data={osqueryObj.common.misc}/>