Keep

Platform

Update Role

Location

Message

Error Type

ValidationError

Role

API Key

HTTPBasic

OAuth2PasswordBearer

HTTPValidationError

Keep is an open-source alert management and automation tool that provides everything you need to collect, enrich and manange alerts effectively.

Introduction

Use cases

Comparison

Key concepts

Alerts correlations

Presets

Extraction

Mapping

Maintenance Windows

Alert Deduplication

Examples

Getting started

Keep with an external URL

Configuration

Overview

No Authentication

DB Authentication

Auth0 Authentication

Keycloak Authentication

OAuth2Proxy Authentication

Providers Provisioning

Workflow Provisioning

Dashboard Provisioning

Secret Manager

Docker

Kubernetes

Openshift

AWS ECS

Specifications

Alerts

Alerts Severity and Status

Settings

Support

A Provider is a component of Keep that enables it to interact with third-party products. It is implemented as extensible Python code, making it easy to enhance and customize.

Fingerprints are unique identifiers associated with alert instances in Keep. Every provider declares the fields fingerprints are calculated upon

Fingerprints

Adding a New Provider

Adding a new Provider

Providers

We tried our best to cover all common providers.

Getting Started

What is a Provider?

❓ What is a Provider

Azure AKS provider to view kubernetes resources.

Azure AKS

AppDynamics provider allows you to get AppDynamics `alerts/actions` via webhook installation

AppDynamics Provider

AppDynamics

Auth0 provider allows interaction with Auth0 APIs for authentication and user management.

Auth0 Provider

Auth0

Axiom Provider is a class that allows to ingest/digest data from Axiom.

Axiom Provider

Azure Monitorg provider allows you to get alerts from Azure Monitor via webhooks.

Azure Monitor Provider

Azure Monitor

Bash provider allows executing Bash commands in a workflow, with a limitation for cloud execution.

Bash Provider

Bash

BigQuery provider allows interaction with Google BigQuery for querying and managing datasets.

BigQuery Provider

BigQuery

Centreon allows you to monitor your infrastructure with ease.

Centreon Provider

Centreon

ClickHouse provider allows you to interact with ClickHouse database.

ClickHouse Provider

ClickHouse

CloudWatch provider enables seamless integration with AWS CloudWatch for alerting and monitoring, directly pushing alarms into Keep.

CloudWatch Provider

CloudWatch

Console provider is sort of a mock provider that projects given alert message to the console.

Console Provider

Console

Coralogix provider allows you to send alerts from Coralogix to Keep using webhooks.

Coralogix Provider

Coralogix

Datadog provider allows you to query Datadog metrics and logs for monitoring and analytics.

Datadog Provider

Datadog

Discord provider is a provider that allows to send notifications to Discord

Discord Provider

Discord

Dynatrace provider allows integration with Dynatrace for monitoring, alerting, and collecting metrics.

Dynatrace Provider

Dynatrace

Elastic provider is a provider used to query Elastic Search (tested with elastic.co)

Elastic Provider

Elastic

GCP Monitoringing provider allows you to get alerts from Azure Monitoring via webhooks.

GCP Monitoring Provider

GCP Monitoring

GitHub provider allows integration with GitHub for managing repositories, issues, pull requests, and more.

GitHub Provider

GitHub

GithubWorkflowProvider is a provider that interacts with Github Workflows API.

Github Workflows Provider

Github Workflows

GitLab provider is a provider used for creating issues in GitLab

GitLab Provider

GitlabPipelinesProvider is a provider that interacts with GitLab Pipelines API.

Gitlab Pipelines Provider

Gitlab Pipelines

GKE provider allows managing Google Kubernetes Engine clusters and related resources.

GKE Provider

Google Chat provider is a provider that allows to send messages to Google Chat

Google Chat Provider

Google Chat

Grafana Provider allows either pull/push alerts from Grafana to Keep.

Grafana Provider

Grafana Incident Provider alows you to query all incidents from Grafana Incident.

Grafana Incident Provider

Grafana Oncall Provider is a class that allows to ingest/digest data from Grafana OnCall.

Grafana OnCall Provider

HTTP Provider is a provider used to query/notify using HTTP requests

HTTP Provider

The ilert provider enables the creation, updating, and resolution of events or incidents on ilert, leveraging both incident management and event notification capabilities for effective incident response.

ilert Provider

The Incident.io provider enables the querying of incidents on Incident.io, leveraging incident management capabilities for effective response.

Incident.io Provider

Incident Manager Provider

Jira On-Prem Provider is a provider used to query data and creating issues in Jira

Jira On-Prem Provider

Jira Cloud provider is a provider used to query data and creating issues in Jira

Jira Cloud Provider

Kafka provider allows integration with Apache Kafka for producing and consuming messages.

Kafka Provider

Kafka

Keep provider allows you to query and manage alerts in Keep.

Keep Provider

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

Kibana Provider

Kibana

Kubernetes provider to perform rollout restart or list pods action.

Linear Provider is a provider for fetching data and creating issues in Linear app.

Linear Provider

The LinearB provider enables integration with LinearB's API to manage and notify incidents directly through webhooks.

LinearB Provider

LinearB

Mailchimp Provider

Mailchimp

Mailgun Provider allows sending alerts to Keep via email.

Mailgun Provider

Mattermost provider is used to send messages to Mattermost.

Mattermost Provider

Microsoft Planner Provider for creating tasks in Planner.

Microsoft Planner Provider

Template Provider is a template for newly added provider's documentation

Mock Provider

Mock

MongoDB Provider is a provider used to query MongoDB databases

MongoDB Provider

MongoDB

MySQL Provider is a provider used to query MySQL databases

MySQL Provider

MySQL

Netdata provider allows you to get alerts from Netdata via webhooks.

Netdata Provider

Netdata

New Relic Provider enables querying AI alerts and registering webhooks.

New Relic Provider

New Relic

Ntfy.sh allows you to send notifications to your devices

Ntfy.sh Provider

Ntfy.sh

OpenObserve provider allows you to get OpenObserve `alerts/actions` via webhook installation

OpenObserve Provider

OpenObserve

Openshift provider to perform rollout restart action on specific resources.

OpsGenie Provider is a provider that allows to create alerts in OpsGenie.

Opsgenie Provider

Pagerduty Provider is a provider that allows to create incidents or post events to Pagerduty.

Pagerduty Provider

The Pagertree Provider facilitates interactions with the Pagertree API, allowing the retrieval and management of alerts.

Pagertree Provider

Parseable provider allows integration with Parseable, a tool for collecting and querying logs.

Parseable Provider

Parseable

Pingdom provider allows you to pull alerts from Pingdom or install Keep as webhook.

Pingdom Provider

Pingdom

Microsoft Planner Provider to create task in planner.

PostgreSQL Provider is a provider used to query POSTGRES databases

PostgreSQL Provider

PostgreSQL

Prometheus provider allows integration with Prometheus for monitoring and alerting purposes.

Overview

Development

Deployment

Platform

Providers

Workflows

Keep API

Keep CLI

Update Role

Authorizations

Path Parameters

Body

Response