Keep

Platform

API Key

HTTPBasic

OAuth2PasswordBearer

Response Get Workflow By Id Workflows  Workflow Id  Get

HTTPValidationError

Get Workflow By Id

Keep is an open-source alert management and automation tool that provides everything you need to create and manage alerts effectively.

Introduction

Key concepts

Use cases

Alert grouping

Presets

Extraction

Mapping

Examples

Comparison

Getting started

Keep with Internet URL

Authentication

Secret Manager

Docker

Kubernetes

Openshift

AWS ECS

Overview

Providers

Alerts

Alerts Severity and Status

Workflows

Workflow builder

Settings

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

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

AppDynamics Provider

AppDynamics

Azure AKS provider to view kubernetes resources.

Azure AKS

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

Axiom Provider

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

Azure Monitoring Provider

Azure Monitoring

Centreon allows you to monitor your infrastructure with ease.

Centreon Provider

Centreon

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

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

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

GitLab provider is a provider used for creating issues in GitLab

GitLab Provider

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

Google Chat Provider

Google Chat

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 On-Call.

Grafana Oncall Provider

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

Grafana 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

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

Jira 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.

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

LinearB Provider

LinearB

Mailchimp Provider

Mailchimp

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

Mock Provider

Mock

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

PostgreSQL Provider is a provider used to query POSTGRES databases

PostgreSQL Provider

PostgreSQL

Pushover Provider

Pushover

Redmine Provider

Redmine

Resend Provider

Resend

Rollbar provides real-time error tracking and debugging tools for developers.

Rollbar Provider

Rollbar

Sentry provider allows you to query Sentry events and to pull/push alerts from Sentry

Sentry Provider

Sentry

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

SignalFX Provider

SignalFX

SIGNL4 offers critical alerting, incident response and service dispatching for operating critical infrastructure. It alerts you persistently via app push, SMS text and voice calls including tracking, escalation, collaboration and duty planning. Find out more at [signl4.com](https://www.signl4.com/)

SIGNL4 Provider

The Site24x7 Provider allows you to install webhooks and receive alerts in Site24x7. It manages authentication, setup of webhooks, and retrieval of alert logs from Site24x7.

Site24x7 Provider

Enhance your Keep workflows with direct Slack notifications. Simplify communication with timely updates and alerts directly within Slack.

Integration for Slack

Keep's integration for Slack

Snowflake Provider

Snowflake

StatusCake allows you to monitor your website and APIs and send alert to keep

StatusCake Provider

StatusCake

Splunk provider allows you to get Splunk `saved searches` via webhook installation

Splunk Provider

Splunk

Squadcast provider is a provider used for creating issues in Squadcast

Squadcast Provider

The `SSH Provider` is a provider that provides a way to execute SSH commands and get their output.

SSH Provider

Teams Provider is a provider that allows to notify alerts to Microsoft Teams chats.

Teams Provider

Telegram Provider is a provider that allows to notify alerts to telegram chats.

Telegram Provider

Trello provider is a provider used to query data from Trello

Trello Provider

Trello

Twilio Provider is a provider that allows to notify alerts via SMS using Twilio.

Twilio Provider

UptimeKuma allows you to monitor your website and APIs and send alert to keep

UptimeKuma Provider

UptimeKuma

The VictoriametricsProvider allows you to fetch alerts in Victoriametrics.

Victoriametrics Provider

Websocket

Incident Manager Provider

Zabbix provider allows you to pull/push alerts from Zabbix

Zabbix Provider

Zabbix

Zenduty Provider

Zenduty

At Keep, we view alerts as workflows, which consist of a series of steps executed in sequence, each with its own specific input and output. To keep our approach simple, Keep's syntax is designed to closely resemble the syntax used in GitHub Actions. We believe that GitHub Actions has a well-established syntax, and there is no need to reinvent the wheel.

Basic Syntax

Foreach syntax add the flexability of running action per result instead of only once on all results.

Foreach Syntax

Foreach

Keep uses [Mustache](https://mustache.github.io/) syntax to inject context at runtime, supporting functions, dictionaries, lists, and nested access.

Content Syntax

Working with context

What is a Condition?

❓ What is a Condition

Threshold

🎯 Threshold

Assert

The 'stddev' condition implements standard deviation logic. It takes a list or a list of lists, along with a standard deviation threshold ('compare_to'), and returns all values that are farther away from the mean than the standard deviation.

stddev

🎯 Stddev (Standard Deviation)

In Keep's context, functions extend the power of context injection. For example, if a step returns a list, you can use the `keep.len` function to count and use the number of results instead of the actual results.

Overview

Development

Deployment

Platform

Providers

Workflows

Keep API

Keep CLI

Get workflow by id

Authorizations

Path Parameters

Response