> ## Documentation Index
> Fetch the complete documentation index at: https://docs.keephq.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Kibana

> Kibana provider allows you get alerts from Kibana Alerting via webhooks.

<Card title="Kibana Webhooks" icon="lightbulb" iconType="duotone" color="#ca8b04">
  Please note that when installing Kibana with Webhook auto instrumentation,
  Keep installs itself as a Connector, adds itself as an Action to all available
  Kibana Alert Rules (For each alert, On status changes, when: Alert/No
  Data/Recovered) and to all available Kibana Watcher rules as a Webhook action.

  For more information, feel free to reach out on our Slack Community.
</Card>

## Authentication

This provider requires authentication.

* **api\_key**: Kibana API Key (required: True, sensitive: True)
* **kibana\_host**: Kibana Host (required: True, sensitive: False)
* **kibana\_port**: Kibana Port (defaults to 9243) (required: False, sensitive: False)

Certain scopes may be required to perform specific actions or queries via the provider. Below is a summary of relevant scopes and their use cases:

* **rulesSettings:read**: Read alerts (mandatory)
* **rulesSettings:write**: Modify alerts (mandatory)
* **actions:read**: Read connectors (mandatory)
* **actions:write**: Write connectors (mandatory)

## In workflows

This provider can't be used as a "step" or "action" in workflows. If you want to use it, please let us know by creating an issue in the [GitHub repository](https://github.com/keephq/keep/issues).

## Connecting with the Provider

### Kibana Host

Simply copy the hostname from the URL bar in your browser:

<img src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/kibana/kibana_host.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=0b5444d944487a62305c05f6133ca4a1" alt="Kibana Host" width="379" height="34" data-path="images/kibana/kibana_host.png" />

### API Key

To obtain a Kibana API key, follow these steps:

1. Log in to your Kibana account.
2. Click Stack Management
3. Click on Security
4. Click on API Keys

<img src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/kibana/api-keys.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=18c62fcf2eef9baa52ed59216fd60cfc" alt="Kibana API Keys" width="2318" height="1390" data-path="images/kibana/api-keys.png" />

1. Click on the top right `Create API key` button
2. Give the API key and indicative name (e.g. keep-api-key)
3. Make sure the `Restrict Permissions` toggle is not toggeled
4. On the bottom right corner, click on `Create API key`

<img src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/kibana/create-api-key.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=10b03ceb3bdbdd9b34d0ef17594f235c" alt="Create Kibana API Key" width="2292" height="1182" data-path="images/kibana/create-api-key.png" />

6. Copy the newly created encoded API key and you're set!

<img src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/kibana/copy-created-key.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=fe06b587a817ca16b65596b5db16af26" alt="Copy Kibana API Key" width="1458" height="465" data-path="images/kibana/copy-created-key.png" />

## Fingerprinting

Fingerprints in Kibana are simply the alert instance ID.

## Useful Links

* [Kibana Alerting](https://www.elastic.co/guide/en/kibana/current/alerting-getting-started.html)
* [Kibana Connectors](https://www.elastic.co/guide/en/kibana/current/action-types.html)