{"id":15029500,"url":"https://github.com/twin/gatus","last_synced_at":"2025-05-11T03:49:30.237Z","repository":{"id":37214763,"uuid":"206214867","full_name":"TwiN/gatus","owner":"TwiN","description":"⛑ Automated developer-oriented status page","archived":false,"fork":false,"pushed_at":"2025-05-10T18:06:35.000Z","size":33889,"stargazers_count":7421,"open_issues_count":214,"forks_count":499,"subscribers_count":38,"default_branch":"master","last_synced_at":"2025-05-11T03:49:17.714Z","etag":null,"topics":["alerting","container","dashboard","devops","docker","go","golang","health","monitor","monitoring","monitoring-tool","notifications","self-hosted","selfhosted","slack","status","status-page","statuspage","uptime","uptime-monitoring"],"latest_commit_sha":null,"homepage":"https://gatus.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TwiN.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"security/basic.go","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["TwiN"]}},"created_at":"2019-09-04T02:35:40.000Z","updated_at":"2025-05-11T01:52:54.000Z","dependencies_parsed_at":"2023-10-03T05:39:13.026Z","dependency_job_id":"ef42567c-a4e0-4f3a-bfa4-0f82042e166b","html_url":"https://github.com/TwiN/gatus","commit_stats":{"total_commits":1245,"total_committers":83,"mean_commits":15.0,"dds":0.3991967871485944,"last_synced_commit":"714dd4ba099e05c941e706becfc06e2ad2fd9148"},"previous_names":["twinproduction/gatus"],"tags_count":101,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TwiN%2Fgatus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TwiN%2Fgatus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TwiN%2Fgatus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TwiN%2Fgatus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TwiN","download_url":"https://codeload.github.com/TwiN/gatus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253514559,"owners_count":21920334,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alerting","container","dashboard","devops","docker","go","golang","health","monitor","monitoring","monitoring-tool","notifications","self-hosted","selfhosted","slack","status","status-page","statuspage","uptime","uptime-monitoring"],"created_at":"2024-09-24T20:10:50.763Z","updated_at":"2025-05-11T03:49:30.219Z","avatar_url":"https://github.com/TwiN.png","language":"Go","funding_links":["https://github.com/sponsors/TwiN"],"categories":[],"sub_categories":[],"readme":"[![Gatus](.github/assets/logo-with-dark-text.png)](https://gatus.io)\n\n![test](https://github.com/TwiN/gatus/actions/workflows/test.yml/badge.svg)\n[![Go Report Card](https://goreportcard.com/badge/github.com/TwiN/gatus?)](https://goreportcard.com/report/github.com/TwiN/gatus)\n[![codecov](https://codecov.io/gh/TwiN/gatus/branch/master/graph/badge.svg)](https://codecov.io/gh/TwiN/gatus)\n[![Go version](https://img.shields.io/github/go-mod/go-version/TwiN/gatus.svg)](https://github.com/TwiN/gatus)\n[![Docker pulls](https://img.shields.io/docker/pulls/twinproduction/gatus.svg)](https://cloud.docker.com/repository/docker/twinproduction/gatus)\n[![Follow TwiN](https://img.shields.io/github/followers/TwiN?label=Follow\u0026style=social)](https://github.com/TwiN)\n\nGatus is a developer-oriented health dashboard that gives you the ability to monitor your services using HTTP, ICMP, TCP, and even DNS\nqueries as well as evaluate the result of said queries by using a list of conditions on values like the status code,\nthe response time, the certificate expiration, the body and many others. The icing on top is that each of these health\nchecks can be paired with alerting via Slack, Teams, PagerDuty, Discord, Twilio and many more.\n\nI personally deploy it in my Kubernetes cluster and let it monitor the status of my\ncore applications: https://status.twin.sh/\n\n_Looking for a managed solution? Check out [Gatus.io](https://gatus.io)._\n\n\u003cdetails\u003e\n \u003csummary\u003e\u003cb\u003eQuick start\u003c/b\u003e\u003c/summary\u003e\n\n```console\ndocker run -p 8080:8080 --name gatus twinproduction/gatus:stable\n```\nYou can also use GitHub Container Registry if you prefer:\n```console\ndocker run -p 8080:8080 --name gatus ghcr.io/twin/gatus:stable\n```\nFor more details, see [Usage](#usage)\n\u003c/details\u003e\n\n\u003e ❤ Like this project? Please consider [sponsoring me](https://github.com/sponsors/TwiN).\n\n![Gatus dashboard](.github/assets/dashboard-dark.png)\n\nHave any feedback or questions? [Create a discussion](https://github.com/TwiN/gatus/discussions/new).\n\n\n## Table of Contents\n- [Table of Contents](#table-of-contents)\n- [Why Gatus?](#why-gatus)\n- [Features](#features)\n- [Usage](#usage)\n- [Configuration](#configuration)\n - [Endpoints](#endpoints)\n - [External Endpoints](#external-endpoints)\n - [Conditions](#conditions)\n - [Placeholders](#placeholders)\n - [Functions](#functions)\n - [Storage](#storage)\n - [Client configuration](#client-configuration)\n - [Alerting](#alerting)\n - [Configuring AWS SES alerts](#configuring-aws-ses-alerts)\n - [Configuring Discord alerts](#configuring-discord-alerts)\n - [Configuring Email alerts](#configuring-email-alerts)\n - [Configuring Gitea alerts](#configuring-gitea-alerts)\n - [Configuring GitHub alerts](#configuring-github-alerts)\n - [Configuring GitLab alerts](#configuring-gitlab-alerts)\n - [Configuring Google Chat alerts](#configuring-google-chat-alerts)\n - [Configuring Gotify alerts](#configuring-gotify-alerts)\n - [Configuring Incident.io alerts](#configuring-incidentio-alerts)\n - [Configuring JetBrains Space alerts](#configuring-jetbrains-space-alerts)\n - [Configuring Matrix alerts](#configuring-matrix-alerts)\n - [Configuring Mattermost alerts](#configuring-mattermost-alerts)\n - [Configuring Messagebird alerts](#configuring-messagebird-alerts)\n - [Configuring Ntfy alerts](#configuring-ntfy-alerts)\n - [Configuring Opsgenie alerts](#configuring-opsgenie-alerts)\n - [Configuring PagerDuty alerts](#configuring-pagerduty-alerts)\n - [Configuring Pushover alerts](#configuring-pushover-alerts)\n - [Configuring Slack alerts](#configuring-slack-alerts)\n - [Configuring Teams alerts *(Deprecated)*](#configuring-teams-alerts-deprecated)\n - [Configuring Teams Workflow alerts](#configuring-teams-workflow-alerts)\n - [Configuring Telegram alerts](#configuring-telegram-alerts)\n - [Configuring Twilio alerts](#configuring-twilio-alerts)\n - [Configuring Zulip alerts](#configuring-zulip-alerts)\n - [Configuring custom alerts](#configuring-custom-alerts)\n - [Setting a default alert](#setting-a-default-alert)\n - [Maintenance](#maintenance)\n - [Security](#security)\n - [Basic Authentication](#basic-authentication)\n - [OIDC](#oidc)\n - [TLS Encryption](#tls-encryption)\n - [Metrics](#metrics)\n - [Connectivity](#connectivity)\n - [Remote instances (EXPERIMENTAL)](#remote-instances-experimental)\n- [Deployment](#deployment)\n - [Docker](#docker)\n - [Helm Chart](#helm-chart)\n - [Terraform](#terraform)\n- [Running the tests](#running-the-tests)\n- [Using in Production](#using-in-production)\n- [FAQ](#faq)\n - [Sending a GraphQL request](#sending-a-graphql-request)\n - [Recommended interval](#recommended-interval)\n - [Default timeouts](#default-timeouts)\n - [Monitoring a TCP endpoint](#monitoring-a-tcp-endpoint)\n - [Monitoring a UDP endpoint](#monitoring-a-udp-endpoint)\n - [Monitoring a SCTP endpoint](#monitoring-a-sctp-endpoint)\n - [Monitoring a WebSocket endpoint](#monitoring-a-websocket-endpoint)\n - [Monitoring an endpoint using ICMP](#monitoring-an-endpoint-using-icmp)\n - [Monitoring an endpoint using DNS queries](#monitoring-an-endpoint-using-dns-queries)\n - [Monitoring an endpoint using SSH](#monitoring-an-endpoint-using-ssh)\n - [Monitoring an endpoint using STARTTLS](#monitoring-an-endpoint-using-starttls)\n - [Monitoring an endpoint using TLS](#monitoring-an-endpoint-using-tls)\n - [Monitoring domain expiration](#monitoring-domain-expiration)\n - [disable-monitoring-lock](#disable-monitoring-lock)\n - [Reloading configuration on the fly](#reloading-configuration-on-the-fly)\n - [Endpoint groups](#endpoint-groups)\n - [Exposing Gatus on a custom path](#exposing-gatus-on-a-custom-path)\n - [Exposing Gatus on a custom port](#exposing-gatus-on-a-custom-port)\n - [Configuring a startup delay](#configuring-a-startup-delay)\n - [Keeping your configuration small](#keeping-your-configuration-small)\n - [Proxy client configuration](#proxy-client-configuration)\n - [How to fix 431 Request Header Fields Too Large error](#how-to-fix-431-request-header-fields-too-large-error)\n - [Badges](#badges)\n - [Uptime](#uptime)\n - [Health](#health)\n - [Health (Shields.io)](#health-shieldsio)\n - [Response time](#response-time)\n - [Response time (chart)](#response-time-chart)\n - [How to change the color thresholds of the response time badge](#how-to-change-the-color-thresholds-of-the-response-time-badge)\n - [API](#api)\n - [Raw Data](#raw-data)\n - [Uptime](#uptime-1)\n - [Response Time](#response-time-1)\n - [Installing as binary](#installing-as-binary)\n - [High level design overview](#high-level-design-overview)\n\n\n## Why Gatus?\nBefore getting into the specifics, I want to address the most common question:\n\u003e Why would I use Gatus when I can just use Prometheus’ Alertmanager, Cloudwatch or even Splunk?\n\nNeither of these can tell you that there’s a problem if there are no clients actively calling the endpoint.\nIn other words, it's because monitoring metrics mostly rely on existing traffic, which effectively means that unless\nyour clients are already experiencing a problem, you won't be notified.\n\nGatus, on the other hand, allows you to configure health checks for each of your features, which in turn allows it to\nmonitor these features and potentially alert you before any clients are impacted.\n\nA sign you may want to look into Gatus is by simply asking yourself whether you'd receive an alert if your load balancer\nwas to go down right now. Will any of your existing alerts be triggered? Your metrics won’t report an increase in errors\nif no traffic makes it to your applications. This puts you in a situation where your clients are the ones\nthat will notify you about the degradation of your services rather than you reassuring them that you're working on\nfixing the issue before they even know about it.\n\n\n## Features\nThe main features of Gatus are:\n\n- **Highly flexible health check conditions**: While checking the response status may be enough for some use cases, Gatus goes much further and allows you to add conditions on the response time, the response body and even the IP address.\n- **Ability to use Gatus for user acceptance tests**: Thanks to the point above, you can leverage this application to create automated user acceptance tests.\n- **Very easy to configure**: Not only is the configuration designed to be as readable as possible, it's also extremely easy to add a new service or a new endpoint to monitor.\n- **Alerting**: While having a pretty visual dashboard is useful to keep track of the state of your application(s), you probably don't want to stare at it all day. Thus, notifications via Slack, Mattermost, Messagebird, PagerDuty, Twilio, Google chat and Teams are supported out of the box with the ability to configure a custom alerting provider for any needs you might have, whether it be a different provider or a custom application that manages automated rollbacks.\n- **Metrics**\n- **Low resource consumption**: As with most Go applications, the resource footprint that this application requires is negligibly small.\n- **[Badges](#badges)**: ![Uptime 7d](https://status.twin.sh/api/v1/endpoints/core_blog-external/uptimes/7d/badge.svg) ![Response time 24h](https://status.twin.sh/api/v1/endpoints/core_blog-external/response-times/24h/badge.svg)\n- **Dark mode**\n\n![Gatus dashboard conditions](.github/assets/dashboard-conditions.png)\n\n\n## Usage\n\n\u003cdetails\u003e\n \u003csummary\u003e\u003cb\u003eQuick start\u003c/b\u003e\u003c/summary\u003e\n\n```console\ndocker run -p 8080:8080 --name gatus twinproduction/gatus\n```\nYou can also use GitHub Container Registry if you prefer:\n```console\ndocker run -p 8080:8080 --name gatus ghcr.io/twin/gatus\n```\nIf you want to create your own configuration, see [Docker](#docker) for information on how to mount a configuration file.\n\u003c/details\u003e\n\nHere's a simple example:\n```yaml\nendpoints:\n - name: website # Name of your endpoint, can be anything\n url: \"https://twin.sh/health\"\n interval: 5m # Duration to wait between every status check (default: 60s)\n conditions:\n - \"[STATUS] == 200\" # Status must be 200\n - \"[BODY].status == UP\" # The json path \"$.status\" must be equal to UP\n - \"[RESPONSE_TIME] \u003c 300\" # Response time must be under 300ms\n\n - name: make-sure-header-is-rendered\n url: \"https://example.org/\"\n interval: 60s\n conditions:\n - \"[STATUS] == 200\" # Status must be 200\n - \"[BODY] == pat(*\u003ch1\u003eExample Domain\u003c/h1\u003e*)\" # Body must contain the specified header\n```\n\nThis example would look similar to this:\n\n![Simple example](.github/assets/example.png)\n\nBy default, the configuration file is expected to be at `config/config.yaml`.\n\nYou can specify a custom path by setting the `GATUS_CONFIG_PATH` environment variable.\n\nIf `GATUS_CONFIG_PATH` points to a directory, all `*.yaml` and `*.yml` files inside said directory and its\nsubdirectories are merged like so:\n- All maps/objects are deep merged (i.e. you could define `alerting.slack` in one file and `alerting.pagerduty` in another file)\n- All slices/arrays are appended (i.e. you can define `endpoints` in multiple files and each endpoint will be added to the final list of endpoints)\n- Parameters with a primitive value (e.g. `metrics`, `alerting.slack.webhook-url`, etc.) may only be defined once to forcefully avoid any ambiguity\n - To clarify, this also means that you could not define `alerting.slack.webhook-url` in two files with different values. All files are merged into one before they are processed. This is by design.\n\n\u003e 💡 You can also use environment variables in the configuration file (e.g. `$DOMAIN`, `${DOMAIN}`)\n\u003e\n\u003e See [examples/docker-compose-postgres-storage/config/config.yaml](.examples/docker-compose-postgres-storage/config/config.yaml) for an example.\n\nIf you want to test it locally, see [Docker](#docker).\n\n\n## Configuration\n| Parameter | Description | Default |\n|:-----------------------------|:-------------------------------------------------------------------------------------------------------------------------------------|:---------------------------|\n| `metrics` | Whether to expose metrics at `/metrics`. | `false` |\n| `storage` | [Storage configuration](#storage). | `{}` |\n| `alerting` | [Alerting configuration](#alerting). | `{}` |\n| `endpoints` | [Endpoints configuration](#endpoints). | Required `[]` |\n| `external-endpoints` | [External Endpoints configuration](#external-endpoints). | `[]` |\n| `security` | [Security configuration](#security). | `{}` |\n| `disable-monitoring-lock` | Whether to [disable the monitoring lock](#disable-monitoring-lock). | `false` |\n| `skip-invalid-config-update` | Whether to ignore invalid configuration update. \u003cbr /\u003eSee [Reloading configuration on the fly](#reloading-configuration-on-the-fly). | `false` |\n| `web` | Web configuration. | `{}` |\n| `web.address` | Address to listen on. | `0.0.0.0` |\n| `web.port` | Port to listen on. | `8080` |\n| `web.read-buffer-size` | Buffer size for reading requests from a connection. Also limit for the maximum header size. | `8192` |\n| `web.tls.certificate-file` | Optional public certificate file for TLS in PEM format. | `` |\n| `web.tls.private-key-file` | Optional private key file for TLS in PEM format. | `` |\n| `ui` | UI configuration. | `{}` |\n| `ui.title` | [Title of the document](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title). | `Health Dashboard ǀ Gatus` |\n| `ui.description` | Meta description for the page. | `Gatus is an advanced...`. |\n| `ui.header` | Header at the top of the dashboard. | `Health Status` |\n| `ui.logo` | URL to the logo to display. | `\"\"` |\n| `ui.link` | Link to open when the logo is clicked. | `\"\"` |\n| `ui.buttons` | List of buttons to display below the header. | `[]` |\n| `ui.buttons[].name` | Text to display on the button. | Required `\"\"` |\n| `ui.buttons[].link` | Link to open when the button is clicked. | Required `\"\"` |\n| `ui.custom-css` | Custom CSS | `\"\"` |\n| `ui.dark-mode` | Whether to enable dark mode by default. Note that this is superseded by the user's operating system theme preferences. | `true` |\n| `maintenance` | [Maintenance configuration](#maintenance). | `{}` |\n\nIf you want more verbose logging, you may set the `GATUS_LOG_LEVEL` environment variable to `DEBUG`.\nConversely, if you want less verbose logging, you can set the aforementioned environment variable to `WARN`, `ERROR` or `FATAL`.\nThe default value for `GATUS_LOG_LEVEL` is `INFO`.\n\n### Endpoints\nEndpoints are URLs, applications, or services that you want to monitor. Each endpoint has a list of conditions that are\nevaluated on an interval that you define. If any condition fails, the endpoint is considered as unhealthy.\nYou can then configure alerts to be triggered when an endpoint is unhealthy once a certain threshold is reached.\n\n| Parameter | Description | Default |\n|:------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------|\n| `endpoints` | List of endpoints to monitor. | Required `[]` |\n| `endpoints[].enabled` | Whether to monitor the endpoint. | `true` |\n| `endpoints[].name` | Name of the endpoint. Can be anything. | Required `\"\"` |\n| `endpoints[].group` | Group name. Used to group multiple endpoints together on the dashboard. \u003cbr /\u003eSee [Endpoint groups](#endpoint-groups). | `\"\"` |\n| `endpoints[].url` | URL to send the request to. | Required `\"\"` |\n| `endpoints[].method` | Request method. | `GET` |\n| `endpoints[].conditions` | Conditions used to determine the health of the endpoint. \u003cbr /\u003eSee [Conditions](#conditions). | `[]` |\n| `endpoints[].interval` | Duration to wait between every status check. | `60s` |\n| `endpoints[].graphql` | Whether to wrap the body in a query param (`{\"query\":\"$body\"}`). | `false` |\n| `endpoints[].body` | Request body. | `\"\"` |\n| `endpoints[].headers` | Request headers. | `{}` |\n| `endpoints[].dns` | Configuration for an endpoint of type DNS. \u003cbr /\u003eSee [Monitoring an endpoint using DNS queries](#monitoring-an-endpoint-using-dns-queries). | `\"\"` |\n| `endpoints[].dns.query-type` | Query type (e.g. MX). | `\"\"` |\n| `endpoints[].dns.query-name` | Query name (e.g. example.com). | `\"\"` |\n| `endpoints[].ssh` | Configuration for an endpoint of type SSH. \u003cbr /\u003eSee [Monitoring an endpoint using SSH](#monitoring-an-endpoint-using-ssh). | `\"\"` |\n| `endpoints[].ssh.username` | SSH username (e.g. example). | Required `\"\"` |\n| `endpoints[].ssh.password` | SSH password (e.g. password). | Required `\"\"` |\n| `endpoints[].alerts` | List of all alerts for a given endpoint. \u003cbr /\u003eSee [Alerting](#alerting). | `[]` |\n| `endpoints[].maintenance-windows` | List of all maintenance windows for a given endpoint. \u003cbr /\u003eSee [Maintenance](#maintenance). | `[]` |\n| `endpoints[].client` | [Client configuration](#client-configuration). | `{}` |\n| `endpoints[].ui` | UI configuration at the endpoint level. | `{}` |\n| `endpoints[].ui.hide-conditions` | Whether to hide conditions from the results. Note that this only hides conditions from results evaluated from the moment this was enabled. | `false` |\n| `endpoints[].ui.hide-hostname` | Whether to hide the hostname from the results. | `false` |\n| `endpoints[].ui.hide-port` | Whether to hide the port from the results. | `false` |\n| `endpoints[].ui.hide-url` | Whether to hide the URL from the results. Useful if the URL contains a token. | `false` |\n| `endpoints[].ui.dont-resolve-failed-conditions` | Whether to resolve failed conditions for the UI. | `false` |\n| `endpoints[].ui.badge.response-time` | List of response time thresholds. Each time a threshold is reached, the badge has a different color. | `[50, 200, 300, 500, 750]` |\n\n\n### External Endpoints\nUnlike regular endpoints, external endpoints are not monitored by Gatus, but they are instead pushed programmatically.\nThis allows you to monitor anything you want, even when what you want to check lives in an environment that would not normally be accessible by Gatus.\n\nFor instance:\n- You can create your own agent that lives in a private network and pushes the status of your services to a publicly-exposed Gatus instance\n- You can monitor services that are not supported by Gatus\n- You can implement your own monitoring system while using Gatus as the dashboard\n\n| Parameter | Description | Default |\n|:-------------------------------|:-----------------------------------------------------------------------------------------------------------------------|:--------------|\n| `external-endpoints` | List of endpoints to monitor. | `[]` |\n| `external-endpoints[].enabled` | Whether to monitor the endpoint. | `true` |\n| `external-endpoints[].name` | Name of the endpoint. Can be anything. | Required `\"\"` |\n| `external-endpoints[].group` | Group name. Used to group multiple endpoints together on the dashboard. \u003cbr /\u003eSee [Endpoint groups](#endpoint-groups). | `\"\"` |\n| `external-endpoints[].token` | Bearer token required to push status to. | Required `\"\"` |\n| `external-endpoints[].alerts` | List of all alerts for a given endpoint. \u003cbr /\u003eSee [Alerting](#alerting). | `[]` |\n\nExample:\n```yaml\nexternal-endpoints:\n - name: ext-ep-test\n group: core\n token: \"potato\"\n alerts:\n - type: discord\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\nTo push the status of an external endpoint, the request would have to look like this:\n```\nPOST /api/v1/endpoints/{key}/external?success={success}\u0026error={error}\n```\nWhere:\n- `{key}` has the pattern `\u003cGROUP_NAME\u003e_\u003cENDPOINT_NAME\u003e` in which both variables have ` `, `/`, `_`, `,` and `.` replaced by `-`.\n - Using the example configuration above, the key would be `core_ext-ep-test`.\n- `{success}` is a boolean (`true` or `false`) value indicating whether the health check was successful or not.\n- `{error}`: a string describing the reason for a failed health check. If {success} is false, this should contain the error message; if the check is successful, it can be omitted or left empty.\n\nYou must also pass the token as a `Bearer` token in the `Authorization` header.\n\n\n### Conditions\nHere are some examples of conditions you can use:\n\n| Condition | Description | Passing values | Failing values |\n|:---------------------------------|:----------------------------------------------------|:---------------------------|------------------|\n| `[STATUS] == 200` | Status must be equal to 200 | 200 | 201, 404, ... |\n| `[STATUS] \u003c 300` | Status must lower than 300 | 200, 201, 299 | 301, 302, ... |\n| `[STATUS] \u003c= 299` | Status must be less than or equal to 299 | 200, 201, 299 | 301, 302, ... |\n| `[STATUS] \u003e 400` | Status must be greater than 400 | 401, 402, 403, 404 | 400, 200, ... |\n| `[STATUS] == any(200, 429)` | Status must be either 200 or 429 | 200, 429 | 201, 400, ... |\n| `[CONNECTED] == true` | Connection to host must've been successful | true | false |\n| `[RESPONSE_TIME] \u003c 500` | Response time must be below 500ms | 100ms, 200ms, 300ms | 500ms, 501ms |\n| `[IP] == 127.0.0.1` | Target IP must be 127.0.0.1 | 127.0.0.1 | 0.0.0.0 |\n| `[BODY] == 1` | The body must be equal to 1 | 1 | `{}`, `2`, ... |\n| `[BODY].user.name == john` | JSONPath value of `$.user.name` is equal to `john` | `{\"user\":{\"name\":\"john\"}}` | |\n| `[BODY].data[0].id == 1` | JSONPath value of `$.data[0].id` is equal to 1 | `{\"data\":[{\"id\":1}]}` | |\n| `[BODY].age == [BODY].id` | JSONPath value of `$.age` is equal JSONPath `$.id` | `{\"age\":1,\"id\":1}` | |\n| `len([BODY].data) \u003c 5` | Array at JSONPath `$.data` has less than 5 elements | `{\"data\":[{\"id\":1}]}` | |\n| `len([BODY].name) == 8` | String at JSONPath `$.name` has a length of 8 | `{\"name\":\"john.doe\"}` | `{\"name\":\"bob\"}` |\n| `has([BODY].errors) == false` | JSONPath `$.errors` does not exist | `{\"name\":\"john.doe\"}` | `{\"errors\":[]}` |\n| `has([BODY].users) == true` | JSONPath `$.users` exists | `{\"users\":[]}` | `{}` |\n| `[BODY].name == pat(john*)` | String at JSONPath `$.name` matches pattern `john*` | `{\"name\":\"john.doe\"}` | `{\"name\":\"bob\"}` |\n| `[BODY].id == any(1, 2)` | Value at JSONPath `$.id` is equal to `1` or `2` | 1, 2 | 3, 4, 5 |\n| `[CERTIFICATE_EXPIRATION] \u003e 48h` | Certificate expiration is more than 48h away | 49h, 50h, 123h | 1h, 24h, ... |\n| `[DOMAIN_EXPIRATION] \u003e 720h` | The domain must expire in more than 720h | 4000h | 1h, 24h, ... |\n\n\n#### Placeholders\n| Placeholder | Description | Example of resolved value |\n|:---------------------------|:------------------------------------------------------------------------------------------|:---------------------------------------------|\n| `[STATUS]` | Resolves into the HTTP status of the request | `404` |\n| `[RESPONSE_TIME]` | Resolves into the response time the request took, in ms | `10` |\n| `[IP]` | Resolves into the IP of the target host | `192.168.0.232` |\n| `[BODY]` | Resolves into the response body. Supports JSONPath. | `{\"name\":\"john.doe\"}` |\n| `[CONNECTED]` | Resolves into whether a connection could be established | `true` |\n| `[CERTIFICATE_EXPIRATION]` | Resolves into the duration before certificate expiration (valid units are \"s\", \"m\", \"h\".) | `24h`, `48h`, 0 (if not protocol with certs) |\n| `[DOMAIN_EXPIRATION]` | Resolves into the duration before the domain expires (valid units are \"s\", \"m\", \"h\".) | `24h`, `48h`, `1234h56m78s` |\n| `[DNS_RCODE]` | Resolves into the DNS status of the response | `NOERROR` |\n\n\n#### Functions\n| Function | Description | Example |\n|:---------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------------------|\n| `len` | If the given path leads to an array, returns its length. Otherwise, the JSON at the given path is minified and converted to a string, and the resulting number of characters is returned. Works only with the `[BODY]` placeholder. | `len([BODY].username) \u003e 8` |\n| `has` | Returns `true` or `false` based on whether a given path is valid. Works only with the `[BODY]` placeholder. | `has([BODY].errors) == false` |\n| `pat` | Specifies that the string passed as parameter should be evaluated as a pattern. Works only with `==` and `!=`. | `[IP] == pat(192.168.*)` |\n| `any` | Specifies that any one of the values passed as parameters is a valid value. Works only with `==` and `!=`. | `[BODY].ip == any(127.0.0.1, ::1)` |\n\n\u003e 💡 Use `pat` only when you need to. `[STATUS] == pat(2*)` is a lot more expensive than `[STATUS] \u003c 300`.\n\n\n### Storage\n| Parameter | Description | Default |\n|:------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:-----------|\n| `storage` | Storage configuration | `{}` |\n| `storage.path` | Path to persist the data in. Only supported for types `sqlite` and `postgres`. | `\"\"` |\n| `storage.type` | Type of storage. Valid types: `memory`, `sqlite`, `postgres`. | `\"memory\"` |\n| `storage.caching` | Whether to use write-through caching. Improves loading time for large dashboards. \u003cbr /\u003eOnly supported if `storage.type` is `sqlite` or `postgres` | `false` |\n\nThe results for each endpoint health check as well as the data for uptime and the past events must be persisted\nso that they can be displayed on the dashboard. These parameters allow you to configure the storage in question.\n\n- If `storage.type` is `memory` (default):\n```yaml\n# Note that this is the default value, and you can omit the storage configuration altogether to achieve the same result.\n# Because the data is stored in memory, the data will not survive a restart.\nstorage:\n type: memory\n```\n- If `storage.type` is `sqlite`, `storage.path` must not be blank:\n```yaml\nstorage:\n type: sqlite\n path: data.db\n```\nSee [examples/docker-compose-sqlite-storage](.examples/docker-compose-sqlite-storage) for an example.\n\n- If `storage.type` is `postgres`, `storage.path` must be the connection URL:\n```yaml\nstorage:\n type: postgres\n path: \"postgres://user:password@127.0.0.1:5432/gatus?sslmode=disable\"\n```\nSee [examples/docker-compose-postgres-storage](.examples/docker-compose-postgres-storage) for an example.\n\n\n### Client configuration\nIn order to support a wide range of environments, each monitored endpoint has a unique configuration for\nthe client used to send the request.\n\n| Parameter | Description | Default |\n|:---------------------------------------|:----------------------------------------------------------------------------|:----------------|\n| `client.insecure` | Whether to skip verifying the server's certificate chain and host name. | `false` |\n| `client.ignore-redirect` | Whether to ignore redirects (true) or follow them (false, default). | `false` |\n| `client.timeout` | Duration before timing out. | `10s` |\n| `client.dns-resolver` | Override the DNS resolver using the format `{proto}://{host}:{port}`. | `\"\"` |\n| `client.oauth2` | OAuth2 client configuration. | `{}` |\n| `client.oauth2.token-url` | The token endpoint URL | required `\"\"` |\n| `client.oauth2.client-id` | The client id which should be used for the `Client credentials flow` | required `\"\"` |\n| `client.oauth2.client-secret` | The client secret which should be used for the `Client credentials flow` | required `\"\"` |\n| `client.oauth2.scopes[]` | A list of `scopes` which should be used for the `Client credentials flow`. | required `[\"\"]` |\n| `client.proxy-url` | The URL of the proxy to use for the client | `\"\"` |\n| `client.identity-aware-proxy` | Google Identity-Aware-Proxy client configuration. | `{}` |\n| `client.identity-aware-proxy.audience` | The Identity-Aware-Proxy audience. (client-id of the IAP oauth2 credential) | required `\"\"` |\n| `client.tls.certificate-file` | Path to a client certificate (in PEM format) for mTLS configurations. | `\"\"` |\n| `client.tls.private-key-file` | Path to a client private key (in PEM format) for mTLS configurations. | `\"\"` |\n| `client.tls.renegotiation` | Type of renegotiation support to provide. (`never`, `freely`, `once`). | `\"never\"` |\n| `client.network` | The network to use for ICMP endpoint client (`ip`, `ip4` or `ip6`). | `\"ip\"` |\n\n\n\u003e 📝 Some of these parameters are ignored based on the type of endpoint. For instance, there's no certificate involved\n\u003e in ICMP requests (ping), therefore, setting `client.insecure` to `true` for an endpoint of that type will not do anything.\n\nThis default configuration is as follows:\n\n```yaml\nclient:\n insecure: false\n ignore-redirect: false\n timeout: 10s\n```\n\nNote that this configuration is only available under `endpoints[]`, `alerting.mattermost` and `alerting.custom`.\n\nHere's an example with the client configuration under `endpoints[]`:\n\n```yaml\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n client:\n insecure: false\n ignore-redirect: false\n timeout: 10s\n conditions:\n - \"[STATUS] == 200\"\n```\n\nThis example shows how you can specify a custom DNS resolver:\n\n```yaml\nendpoints:\n - name: with-custom-dns-resolver\n url: \"https://your.health.api/health\"\n client:\n dns-resolver: \"tcp://8.8.8.8:53\"\n conditions:\n - \"[STATUS] == 200\"\n```\n\nThis example shows how you can use the `client.oauth2` configuration to query a backend API with `Bearer token`:\n\n```yaml\nendpoints:\n - name: with-custom-oauth2\n url: \"https://your.health.api/health\"\n client:\n oauth2:\n token-url: https://your-token-server/token\n client-id: 00000000-0000-0000-0000-000000000000\n client-secret: your-client-secret\n scopes: ['https://your.health.api/.default']\n conditions:\n - \"[STATUS] == 200\"\n```\n\nThis example shows how you can use the `client.identity-aware-proxy` configuration to query a backend API with `Bearer token` using Google Identity-Aware-Proxy:\n\n```yaml\nendpoints:\n - name: with-custom-iap\n url: \"https://my.iap.protected.app/health\"\n client:\n identity-aware-proxy:\n audience: \"XXXXXXXX-XXXXXXXXXXXX.apps.googleusercontent.com\"\n conditions:\n - \"[STATUS] == 200\"\n```\n\n\u003e 📝 Note that Gatus will use the [gcloud default credentials](https://cloud.google.com/docs/authentication/application-default-credentials) within its environment to generate the token.\n\nThis example shows you how you can use the `client.tls` configuration to perform an mTLS query to a backend API:\n\n```yaml\nendpoints:\n - name: website\n url: \"https://your.mtls.protected.app/health\"\n client:\n tls:\n certificate-file: /path/to/user_cert.pem\n private-key-file: /path/to/user_key.pem\n renegotiation: once\n conditions:\n - \"[STATUS] == 200\"\n```\n\n\u003e 📝 Note that if running in a container, you must volume mount the certificate and key into the container.\n\n### Alerting\nGatus supports multiple alerting providers, such as Slack and PagerDuty, and supports different alerts for each\nindividual endpoints with configurable descriptions and thresholds.\n\nAlerts are configured at the endpoint level like so:\n\n| Parameter | Description | Default |\n|:-----------------------------|:-------------------------------------------------------------------------------|:--------------|\n| `alerts` | List of all alerts for a given endpoint. | `[]` |\n| `alerts[].type` | Type of alert. \u003cbr /\u003eSee table below for all valid types. | Required `\"\"` |\n| `alerts[].enabled` | Whether to enable the alert. | `true` |\n| `alerts[].failure-threshold` | Number of failures in a row needed before triggering the alert. | `3` |\n| `alerts[].success-threshold` | Number of successes in a row before an ongoing incident is marked as resolved. | `2` |\n| `alerts[].send-on-resolved` | Whether to send a notification once a triggered alert is marked as resolved. | `false` |\n| `alerts[].description` | Description of the alert. Will be included in the alert sent. | `\"\"` |\n| `alerts[].provider-override` | Alerting provider configuration override for the given alert type | `{}` |\n\nHere's an example of what an alert configuration might look like at the endpoint level:\n```yaml\nendpoints:\n - name: example\n url: \"https://example.org\"\n conditions:\n - \"[STATUS] == 200\"\n alerts:\n - type: slack\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\nYou can also override global provider configuration by using `alerts[].provider-override`, like so:\n```yaml\nendpoints:\n - name: example\n url: \"https://example.org\"\n conditions:\n - \"[STATUS] == 200\"\n alerts:\n - type: slack\n provider-override:\n webhook-url: \"https://hooks.slack.com/services/**********/**********/**********\"\n```\n\n\u003e 📝 If an alerting provider is not properly configured, all alerts configured with the provider's type will be\n\u003e ignored.\n\n| Parameter | Description | Default |\n|:---------------------------|:----------------------------------------------------------------------------------------------------------------------------------------|:--------|\n| `alerting.awsses` | Configuration for alerts of type `awsses`. \u003cbr /\u003eSee [Configuring AWS SES alerts](#configuring-aws-ses-alerts). | `{}` |\n| `alerting.custom` | Configuration for custom actions on failure or alerts. \u003cbr /\u003eSee [Configuring Custom alerts](#configuring-custom-alerts). | `{}` |\n| `alerting.discord` | Configuration for alerts of type `discord`. \u003cbr /\u003eSee [Configuring Discord alerts](#configuring-discord-alerts). | `{}` |\n| `alerting.email` | Configuration for alerts of type `email`. \u003cbr /\u003eSee [Configuring Email alerts](#configuring-email-alerts). | `{}` |\n| `alerting.gitea` | Configuration for alerts of type `gitea`. \u003cbr /\u003eSee [Configuring Gitea alerts](#configuring-gitea-alerts). | `{}` |\n| `alerting.github` | Configuration for alerts of type `github`. \u003cbr /\u003eSee [Configuring GitHub alerts](#configuring-github-alerts). | `{}` |\n| `alerting.gitlab` | Configuration for alerts of type `gitlab`. \u003cbr /\u003eSee [Configuring GitLab alerts](#configuring-gitlab-alerts). | `{}` |\n| `alerting.googlechat` | Configuration for alerts of type `googlechat`. \u003cbr /\u003eSee [Configuring Google Chat alerts](#configuring-google-chat-alerts). | `{}` |\n| `alerting.gotify` | Configuration for alerts of type `gotify`. \u003cbr /\u003eSee [Configuring Gotify alerts](#configuring-gotify-alerts). | `{}` |\n| `alerting.incident-io` | Configuration for alerts of type `incident-io`. \u003cbr /\u003eSee [Configuring Incident.io alerts](#configuring-incidentio-alerts). | `{}` |\n| `alerting.jetbrainsspace` | Configuration for alerts of type `jetbrainsspace`. \u003cbr /\u003eSee [Configuring JetBrains Space alerts](#configuring-jetbrains-space-alerts). | `{}` |\n| `alerting.matrix` | Configuration for alerts of type `matrix`. \u003cbr /\u003eSee [Configuring Matrix alerts](#configuring-matrix-alerts). | `{}` |\n| `alerting.mattermost` | Configuration for alerts of type `mattermost`. \u003cbr /\u003eSee [Configuring Mattermost alerts](#configuring-mattermost-alerts). | `{}` |\n| `alerting.messagebird` | Configuration for alerts of type `messagebird`. \u003cbr /\u003eSee [Configuring Messagebird alerts](#configuring-messagebird-alerts). | `{}` |\n| `alerting.ntfy` | Configuration for alerts of type `ntfy`. \u003cbr /\u003eSee [Configuring Ntfy alerts](#configuring-ntfy-alerts). | `{}` |\n| `alerting.opsgenie` | Configuration for alerts of type `opsgenie`. \u003cbr /\u003eSee [Configuring Opsgenie alerts](#configuring-opsgenie-alerts). | `{}` |\n| `alerting.pagerduty` | Configuration for alerts of type `pagerduty`. \u003cbr /\u003eSee [Configuring PagerDuty alerts](#configuring-pagerduty-alerts). | `{}` |\n| `alerting.pushover` | Configuration for alerts of type `pushover`. \u003cbr /\u003eSee [Configuring Pushover alerts](#configuring-pushover-alerts). | `{}` |\n| `alerting.slack` | Configuration for alerts of type `slack`. \u003cbr /\u003eSee [Configuring Slack alerts](#configuring-slack-alerts). | `{}` |\n| `alerting.teams` | Configuration for alerts of type `teams`. *(Deprecated)* \u003cbr /\u003eSee [Configuring Teams alerts](#configuring-teams-alerts-deprecated). | `{}` |\n| `alerting.teams-workflows` | Configuration for alerts of type `teams-workflows`. \u003cbr /\u003eSee [Configuring Teams Workflow alerts](#configuring-teams-workflow-alerts). | `{}` |\n| `alerting.telegram` | Configuration for alerts of type `telegram`. \u003cbr /\u003eSee [Configuring Telegram alerts](#configuring-telegram-alerts). | `{}` |\n| `alerting.twilio` | Settings for alerts of type `twilio`. \u003cbr /\u003eSee [Configuring Twilio alerts](#configuring-twilio-alerts). | `{}` |\n| `alerting.zulip` | Configuration for alerts of type `zulip`. \u003cbr /\u003eSee [Configuring Zulip alerts](#configuring-zulip-alerts). | `{}` |\n\n\n#### Configuring AWS SES alerts\n| Parameter | Description | Default |\n|:-------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|\n| `alerting.aws-ses` | Settings for alerts of type `aws-ses` | `{}` |\n| `alerting.aws-ses.access-key-id` | AWS Access Key ID | Optional `\"\"` |\n| `alerting.aws-ses.secret-access-key` | AWS Secret Access Key | Optional `\"\"` |\n| `alerting.aws-ses.region` | AWS Region | Required `\"\"` |\n| `alerting.aws-ses.from` | The Email address to send the emails from (should be registered in SES) | Required `\"\"` |\n| `alerting.aws-ses.to` | Comma separated list of email address to notify | Required `\"\"` |\n| `alerting.aws-ses.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n\n```yaml\nalerting:\n aws-ses:\n access-key-id: \"...\"\n secret-access-key: \"...\"\n region: \"us-east-1\"\n from: \"status@example.com\"\n to: \"user@example.com\"\n\nendpoints:\n - name: website\n interval: 30s\n url: \"https://twin.sh/health\"\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: aws-ses\n failure-threshold: 5\n send-on-resolved: true\n description: \"healthcheck failed\"\n```\n\nIf the `access-key-id` and `secret-access-key` are not defined Gatus will fall back to IAM authentication.\n\nMake sure you have the ability to use `ses:SendEmail`.\n\n\n#### Configuring Discord alerts\n| Parameter | Description | Default |\n|:-------------------------------------|:-------------------------------------------------------------------------------------------|:------------------------------------|\n| `alerting.discord` | Configuration for alerts of type `discord` | `{}` |\n| `alerting.discord.webhook-url` | Discord Webhook URL | Required `\"\"` |\n| `alerting.discord.title` | Title of the notification | `\":helmet_with_white_cross: Gatus\"` |\n| `alerting.discord.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n| `alerting.discord.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.discord.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.discord.overrides[].*` | See `alerting.discord.*` parameters | `{}` |\n\n```yaml\nalerting:\n discord:\n webhook-url: \"https://discord.com/api/webhooks/**********/**********\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: discord\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\n\n#### Configuring Email alerts\n| Parameter | Description | Default |\n|:-----------------------------------|:----------------------------------------------------------------------------------------------|:--------------|\n| `alerting.email` | Configuration for alerts of type `email` | `{}` |\n| `alerting.email.from` | Email used to send the alert | Required `\"\"` |\n| `alerting.email.username` | Username of the SMTP server used to send the alert. If empty, uses `alerting.email.from`. | `\"\"` |\n| `alerting.email.password` | Password of the SMTP server used to send the alert. If empty, no authentication is performed. | `\"\"` |\n| `alerting.email.host` | Host of the mail server (e.g. `smtp.gmail.com`) | Required `\"\"` |\n| `alerting.email.port` | Port the mail server is listening to (e.g. `587`) | Required `0` |\n| `alerting.email.to` | Email(s) to send the alerts to | Required `\"\"` |\n| `alerting.email.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n| `alerting.email.client.insecure` | Whether to skip TLS verification | `false` |\n| `alerting.email.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.email.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.email.overrides[].*` | See `alerting.email.*` parameters | `{}` |\n\n```yaml\nalerting:\n email:\n from: \"from@example.com\"\n username: \"from@example.com\"\n password: \"hunter2\"\n host: \"mail.example.com\"\n port: 587\n to: \"recipient1@example.com,recipient2@example.com\"\n client:\n insecure: false\n # You can also add group-specific to keys, which will\n # override the to key above for the specified groups\n overrides:\n - group: \"core\"\n to: \"recipient3@example.com,recipient4@example.com\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: email\n description: \"healthcheck failed\"\n send-on-resolved: true\n\n - name: back-end\n group: core\n url: \"https://example.org/\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[CERTIFICATE_EXPIRATION] \u003e 48h\"\n alerts:\n - type: email\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\n\u003e ⚠ Some mail servers are painfully slow.\n\n#### Configuring Gitea alerts\n\n| Parameter | Description | Default |\n|:--------------------------------|:-----------------------------------------------------------------------------------------------------------|:--------------|\n| `alerting.gitea` | Configuration for alerts of type `gitea` | `{}` |\n| `alerting.gitea.repository-url` | Gitea repository URL (e.g. `https://gitea.com/TwiN/example`) | Required `\"\"` |\n| `alerting.gitea.token` | Personal access token to use for authentication. \u003cbr /\u003eMust have at least RW on issues and RO on metadata. | Required `\"\"` |\n| `alerting.github.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert). | N/A |\n\nThe Gitea alerting provider creates an issue prefixed with `alert(gatus):` and suffixed with the endpoint's display\nname for each alert. If `send-on-resolved` is set to `true` on the endpoint alert, the issue will be automatically\nclosed when the alert is resolved.\n\n```yaml\nalerting:\n gitea:\n repository-url: \"https://gitea.com/TwiN/test\"\n token: \"349d63f16......\"\n\nendpoints:\n - name: example\n url: \"https://twin.sh/health\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 75\"\n alerts:\n - type: gitea\n failure-threshold: 2\n success-threshold: 3\n send-on-resolved: true\n description: \"Everything's burning AAAAAHHHHHHHHHHHHHHH\"\n```\n\n![Gitea alert](.github/assets/gitea-alerts.png)\n\n#### Configuring GitHub alerts\n\n| Parameter | Description | Default |\n|:---------------------------------|:-----------------------------------------------------------------------------------------------------------|:--------------|\n| `alerting.github` | Configuration for alerts of type `github` | `{}` |\n| `alerting.github.repository-url` | GitHub repository URL (e.g. `https://github.com/TwiN/example`) | Required `\"\"` |\n| `alerting.github.token` | Personal access token to use for authentication. \u003cbr /\u003eMust have at least RW on issues and RO on metadata. | Required `\"\"` |\n| `alerting.github.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert). | N/A |\n\nThe GitHub alerting provider creates an issue prefixed with `alert(gatus):` and suffixed with the endpoint's display\nname for each alert. If `send-on-resolved` is set to `true` on the endpoint alert, the issue will be automatically\nclosed when the alert is resolved.\n\n```yaml\nalerting:\n github:\n repository-url: \"https://github.com/TwiN/test\"\n token: \"github_pat_12345...\"\n\nendpoints:\n - name: example\n url: \"https://twin.sh/health\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 75\"\n alerts:\n - type: github\n failure-threshold: 2\n success-threshold: 3\n send-on-resolved: true\n description: \"Everything's burning AAAAAHHHHHHHHHHHHHHH\"\n```\n\n![GitHub alert](.github/assets/github-alerts.png)\n\n#### Configuring GitLab alerts\n| Parameter | Description | Default |\n|:------------------------------------|:--------------------------------------------------------------------------------------------------------------------|:--------------|\n| `alerting.gitlab` | Configuration for alerts of type `gitlab` | `{}` |\n| `alerting.gitlab.webhook-url` | GitLab alert webhook URL (e.g. `https://gitlab.com/yourusername/example/alerts/notify/gatus/xxxxxxxxxxxxxxxx.json`) | Required `\"\"` |\n| `alerting.gitlab.authorization-key` | GitLab alert authorization key. | Required `\"\"` |\n| `alerting.gitlab.severity` | Override default severity (critical), can be one of `critical, high, medium, low, info, unknown` | `\"\"` |\n| `alerting.gitlab.monitoring-tool` | Override the monitoring tool name (gatus) | `\"gatus\"` |\n| `alerting.gitlab.environment-name` | Set gitlab environment's name. Required to display alerts on a dashboard. | `\"\"` |\n| `alerting.gitlab.service` | Override endpoint display name | `\"\"` |\n| `alerting.gitlab.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert). | N/A |\n\nThe GitLab alerting provider creates an alert prefixed with `alert(gatus):` and suffixed with the endpoint's display\nname for each alert. If `send-on-resolved` is set to `true` on the endpoint alert, the alert will be automatically\nclosed when the alert is resolved. See\nhttps://docs.gitlab.com/ee/operations/incident_management/integrations.html#configuration to configure the endpoint.\n\n```yaml\nalerting:\n gitlab:\n webhook-url: \"https://gitlab.com/hlidotbe/example/alerts/notify/gatus/xxxxxxxxxxxxxxxx.json\"\n authorization-key: \"12345\"\n\nendpoints:\n - name: example\n url: \"https://twin.sh/health\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 75\"\n alerts:\n - type: gitlab\n failure-threshold: 2\n success-threshold: 3\n send-on-resolved: true\n description: \"Everything's burning AAAAAHHHHHHHHHHHHHHH\"\n```\n\n![GitLab alert](.github/assets/gitlab-alerts.png)\n\n\n#### Configuring Google Chat alerts\n| Parameter | Description | Default |\n|:----------------------------------------|:--------------------------------------------------------------------------------------------|:--------------|\n| `alerting.googlechat` | Configuration for alerts of type `googlechat` | `{}` |\n| `alerting.googlechat.webhook-url` | Google Chat Webhook URL | Required `\"\"` |\n| `alerting.googlechat.client` | Client configuration. \u003cbr /\u003eSee [Client configuration](#client-configuration). | `{}` |\n| `alerting.googlechat.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert). | N/A |\n| `alerting.googlechat.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.googlechat.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.googlechat.overrides[].*` | See `alerting.googlechat.*` parameters | `{}` |\n\n```yaml\nalerting:\n googlechat:\n webhook-url: \"https://chat.googleapis.com/v1/spaces/*******/messages?key=**********\u0026token=********\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: googlechat\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\n\n#### Configuring Gotify alerts\n| Parameter | Description | Default |\n|:----------------------------------------------|:--------------------------------------------------------------------------------------------|:----------------------|\n| `alerting.gotify` | Configuration for alerts of type `gotify` | `{}` |\n| `alerting.gotify.server-url` | Gotify server URL | Required `\"\"` |\n| `alerting.gotify.token` | Token that is used for authentication. | Required `\"\"` |\n| `alerting.gotify.priority` | Priority of the alert according to Gotify standards. | `5` |\n| `alerting.gotify.title` | Title of the notification | `\"Gatus: \u003cendpoint\u003e\"` |\n| `alerting.gotify.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert). | N/A |\n\n```yaml\nalerting:\n gotify:\n server-url: \"https://gotify.example\"\n token: \"**************\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: gotify\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\nHere's an example of what the notifications look like:\n\n![Gotify notifications](.github/assets/gotify-alerts.png)\n\n\n#### Configuring Incident.io alerts\n| Parameter | Description | Default |\n|:-----------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|\n| `alerting.incident-io` | Configuration for alerts of type `incident-io` | `{}` |\n| `alerting.incident-io.url` | url to trigger an alert event. | Required `\"\"` |\n| `alerting.incident-io.auth-token` | Token that is used for authentication. | Required `\"\"` |\n| `alerting.incident-io.source-url` | Source URL | `\"\"` |\n| `alerting.incident-io.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n| `alerting.incident-io.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.incident-io.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.incident-io.overrides[].*` | See `alerting.incident-io.*` parameters | `{}` |\n\n```yaml\nalerting:\n incident-io:\n url: \"*****************\"\n auth-token: \"********************************************\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 30s\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: incident-io\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\nIn order to get the required alert source config id and authentication token, you must configure an HTTP alert source.\n\n\u003e **_NOTE:_** the source config id is of the form `https://api.incident.io/v2/alert_events/http/$ID` and the token is expected to be passed as a bearer token like so: `Authorization: Bearer $TOKEN`\n\n\n#### Configuring JetBrains Space alerts\n| Parameter | Description | Default |\n|:--------------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|\n| `alerting.jetbrainsspace` | Configuration for alerts of type `jetbrainsspace` | `{}` |\n| `alerting.jetbrainsspace.project` | JetBrains Space project name | Required `\"\"` |\n| `alerting.jetbrainsspace.channel-id` | JetBrains Space Chat Channel ID | Required `\"\"` |\n| `alerting.jetbrainsspace.token` | Token that is used for authentication. | Required `\"\"` |\n| `alerting.jetbrainsspace.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n| `alerting.jetbrainsspace.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.jetbrainsspace.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.jetbrainsspace.overrides[].*` | See `alerting.jetbrainsspace.*` parameters | `{}` |\n\n```yaml\nalerting:\n jetbrainsspace:\n project: myproject\n channel-id: ABCDE12345\n token: \"**************\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n alerts:\n - type: jetbrainsspace\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\nHere's an example of what the notifications look like:\n\n![JetBrains Space notifications](.github/assets/jetbrains-space-alerts.png)\n\n\n#### Configuring Matrix alerts\n| Parameter | Description | Default |\n|:-----------------------------------------|:-------------------------------------------------------------------------------------------|:-----------------------------------|\n| `alerting.matrix` | Configuration for alerts of type `matrix` | `{}` |\n| `alerting.matrix.server-url` | Homeserver URL | `https://matrix-client.matrix.org` |\n| `alerting.matrix.access-token` | Bot user access token (see https://webapps.stackexchange.com/q/131056) | Required `\"\"` |\n| `alerting.matrix.internal-room-id` | Internal room ID of room to send alerts to (can be found in Room Settings \u003e Advanced) | Required `\"\"` |\n| `alerting.matrix.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n\n```yaml\nalerting:\n matrix:\n server-url: \"https://matrix-client.matrix.org\"\n access-token: \"123456\"\n internal-room-id: \"!example:matrix.org\"\n\nendpoints:\n - name: website\n interval: 5m\n url: \"https://twin.sh/health\"\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: matrix\n send-on-resolved: true\n description: \"healthcheck failed\"\n```\n\n\n#### Configuring Mattermost alerts\n| Parameter | Description | Default |\n|:----------------------------------------------|:--------------------------------------------------------------------------------------------|:--------------|\n| `alerting.mattermost` | Configuration for alerts of type `mattermost` | `{}` |\n| `alerting.mattermost.webhook-url` | Mattermost Webhook URL | Required `\"\"` |\n| `alerting.mattermost.channel` | Mattermost channel name override (optional) | `\"\"` |\n| `alerting.mattermost.client` | Client configuration. \u003cbr /\u003eSee [Client configuration](#client-configuration). | `{}` |\n| `alerting.mattermost.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert). | N/A |\n| `alerting.mattermost.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.mattermost.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.mattermost.overrides[].*` | See `alerting.mattermost.*` parameters | `{}` |\n\n```yaml\nalerting:\n mattermost:\n webhook-url: \"http://**********/hooks/**********\"\n client:\n insecure: true\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: mattermost\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\nHere's an example of what the notifications look like:\n\n![Mattermost notifications](.github/assets/mattermost-alerts.png)\n\n\n#### Configuring Messagebird alerts\n| Parameter | Description | Default |\n|:-------------------------------------|:-------------------------------------------------------------------------------------------|:--------------|\n| `alerting.messagebird` | Configuration for alerts of type `messagebird` | `{}` |\n| `alerting.messagebird.access-key` | Messagebird access key | Required `\"\"` |\n| `alerting.messagebird.originator` | The sender of the message | Required `\"\"` |\n| `alerting.messagebird.recipients` | The recipients of the message | Required `\"\"` |\n| `alerting.messagebird.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n\nExample of sending **SMS** text message alert using Messagebird:\n```yaml\nalerting:\n messagebird:\n access-key: \"...\"\n originator: \"31619191918\"\n recipients: \"31619191919,31619191920\"\n\nendpoints:\n - name: website\n interval: 5m\n url: \"https://twin.sh/health\"\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: messagebird\n failure-threshold: 3\n send-on-resolved: true\n description: \"healthcheck failed\"\n```\n\n\n#### Configuring Ntfy alerts\n| Parameter | Description | Default |\n|:-------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------|:------------------|\n| `alerting.ntfy` | Configuration for alerts of type `ntfy` | `{}` |\n| `alerting.ntfy.topic` | Topic at which the alert will be sent | Required `\"\"` |\n| `alerting.ntfy.url` | The URL of the target server | `https://ntfy.sh` |\n| `alerting.ntfy.token` | [Access token](https://docs.ntfy.sh/publish/#access-tokens) for restricted topics | `\"\"` |\n| `alerting.ntfy.email` | E-mail address for additional e-mail notifications | `\"\"` |\n| `alerting.ntfy.click` | Website opened when notification is clicked | `\"\"` |\n| `alerting.ntfy.priority` | The priority of the alert | `3` |\n| `alerting.ntfy.disable-firebase` | Whether message push delivery via firebase should be disabled. [ntfy.sh defaults to enabled](https://docs.ntfy.sh/publish/#disable-firebase) | `false` |\n| `alerting.ntfy.disable-cache` | Whether server side message caching should be disabled. [ntfy.sh defaults to enabled](https://docs.ntfy.sh/publish/#message-caching) | `false` |\n| `alerting.ntfy.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n| `alerting.ntfy.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.ntfy.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.ntfy.overrides[].*` | See `alerting.ntfy.*` parameters | `{}` |\n\n[ntfy](https://github.com/binwiederhier/ntfy) is an amazing project that allows you to subscribe to desktop\nand mobile notifications, making it an awesome addition to Gatus.\n\nExample:\n```yaml\nalerting:\n ntfy:\n topic: \"gatus-test-topic\"\n priority: 2\n token: faketoken\n default-alert:\n failure-threshold: 3\n send-on-resolved: true\n # You can also add group-specific to keys, which will\n # override the to key above for the specified groups\n overrides:\n - group: \"other\"\n topic: \"gatus-other-test-topic\"\n priority: 4\n click: \"https://example.com\"\n\nendpoints:\n - name: website\n interval: 5m\n url: \"https://twin.sh/health\"\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: ntfy\n - name: other example\n group: other\n interval: 30m\n url: \"https://example.com\"\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n alerts:\n - type: ntfy\n description: example\n```\n\n\n#### Configuring Opsgenie alerts\n| Parameter | Description | Default |\n|:----------------------------------|:-------------------------------------------------------------------------------------------|:---------------------|\n| `alerting.opsgenie` | Configuration for alerts of type `opsgenie` | `{}` |\n| `alerting.opsgenie.api-key` | Opsgenie API Key | Required `\"\"` |\n| `alerting.opsgenie.priority` | Priority level of the alert. | `P1` |\n| `alerting.opsgenie.source` | Source field of the alert. | `gatus` |\n| `alerting.opsgenie.entity-prefix` | Entity field prefix. | `gatus-` |\n| `alerting.opsgenie.alias-prefix` | Alias field prefix. | `gatus-healthcheck-` |\n| `alerting.opsgenie.tags` | Tags of alert. | `[]` |\n| `alerting.opsgenie.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n\nOpsgenie provider will automatically open and close alerts.\n\n```yaml\nalerting:\n opsgenie:\n api-key: \"00000000-0000-0000-0000-000000000000\"\n```\n\n\n#### Configuring PagerDuty alerts\n| Parameter | Description | Default |\n|:---------------------------------------|:-------------------------------------------------------------------------------------------|:--------|\n| `alerting.pagerduty` | Configuration for alerts of type `pagerduty` | `{}` |\n| `alerting.pagerduty.integration-key` | PagerDuty Events API v2 integration key | `\"\"` |\n| `alerting.pagerduty.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n| `alerting.pagerduty.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.pagerduty.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.pagerduty.overrides[].*` | See `alerting.pagerduty.*` parameters | `{}` |\n\nIt is highly recommended to set `endpoints[].alerts[].send-on-resolved` to `true` for alerts\nof type `pagerduty`, because unlike other alerts, the operation resulting from setting said\nparameter to `true` will not create another incident but mark the incident as resolved on\nPagerDuty instead.\n\nBehavior:\n- By default, `alerting.pagerduty.integration-key` is used as the integration key\n- If the endpoint being evaluated belongs to a group (`endpoints[].group`) matching the value of `alerting.pagerduty.overrides[].group`, the provider will use that override's integration key instead of `alerting.pagerduty.integration-key`'s\n\n```yaml\nalerting:\n pagerduty:\n integration-key: \"********************************\"\n # You can also add group-specific integration keys, which will\n # override the integration key above for the specified groups\n overrides:\n - group: \"core\"\n integration-key: \"********************************\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 30s\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: pagerduty\n failure-threshold: 3\n success-threshold: 5\n send-on-resolved: true\n description: \"healthcheck failed\"\n\n - name: back-end\n group: core\n url: \"https://example.org/\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[CERTIFICATE_EXPIRATION] \u003e 48h\"\n alerts:\n - type: pagerduty\n failure-threshold: 3\n success-threshold: 5\n send-on-resolved: true\n description: \"healthcheck failed\"\n```\n\n\n#### Configuring Pushover alerts\n| Parameter | Description | Default |\n|:--------------------------------------|:---------------------------------------------------------------------------------------------------------|:----------------------------|\n| `alerting.pushover` | Configuration for alerts of type `pushover` | `{}` |\n| `alerting.pushover.application-token` | Pushover application token | `\"\"` |\n| `alerting.pushover.user-key` | User or group key | `\"\"` |\n| `alerting.pushover.title` | Fixed title for all messages sent via Pushover | `\"Gatus: \u003cendpoint\u003e\"` |\n| `alerting.pushover.priority` | Priority of all messages, ranging from -2 (very low) to 2 (emergency) | `0` |\n| `alerting.pushover.resolved-priority` | Override the priority of messages on resolved, ranging from -2 (very low) to 2 (emergency) | `0` |\n| `alerting.pushover.sound` | Sound of all messages\u003cbr /\u003eSee [sounds](https://pushover.net/api#sounds) for all valid choices. | `\"\"` |\n| `alerting.pushover.ttl` | Set the Time-to-live of the message to be automatically deleted from pushover notifications | `0` |\n| `alerting.pushover.device` | Device to send the message to (optional)\u003cbr/\u003eSee [devices](https://pushover.net/api#identifiers) for details | `\"\"` (all devices)|\n| `alerting.pushover.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n\n```yaml\nalerting:\n pushover:\n application-token: \"******************************\"\n user-key: \"******************************\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 30s\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: pushover\n failure-threshold: 3\n success-threshold: 5\n send-on-resolved: true\n description: \"healthcheck failed\"\n```\n\n\n#### Configuring Slack alerts\n| Parameter | Description | Default |\n|:-----------------------------------|:-------------------------------------------------------------------------------------------|:--------------|\n| `alerting.slack` | Configuration for alerts of type `slack` | `{}` |\n| `alerting.slack.webhook-url` | Slack Webhook URL | Required `\"\"` |\n| `alerting.slack.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n| `alerting.slack.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.slack.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.slack.overrides[].*` | See `alerting.slack.*` parameters | `{}` |\n\n```yaml\nalerting:\n slack:\n webhook-url: \"https://hooks.slack.com/services/**********/**********/**********\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 30s\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: slack\n description: \"healthcheck failed 3 times in a row\"\n send-on-resolved: true\n - type: slack\n failure-threshold: 5\n description: \"healthcheck failed 5 times in a row\"\n send-on-resolved: true\n```\n\nHere's an example of what the notifications look like:\n\n![Slack notifications](.github/assets/slack-alerts.png)\n\n\n#### Configuring Teams alerts *(Deprecated)*\n\n\u003e [!CAUTION]\n\u003e **Deprecated:** Office 365 Connectors within Microsoft Teams are being retired ([Source: Microsoft DevBlog](https://devblogs.microsoft.com/microsoft365dev/retirement-of-office-365-connectors-within-microsoft-teams/)).\n\u003e Existing connectors will continue to work until December 2025. The new [Teams Workflow Alerts](#configuring-teams-workflow-alerts) should be used with Microsoft Workflows instead of this legacy configuration.\n\n| Parameter | Description | Default |\n|:-----------------------------------|:-------------------------------------------------------------------------------------------|:--------------------|\n| `alerting.teams` | Configuration for alerts of type `teams` | `{}` |\n| `alerting.teams.webhook-url` | Teams Webhook URL | Required `\"\"` |\n| `alerting.teams.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n| `alerting.teams.title` | Title of the notification | `\"\u0026#x1F6A8; Gatus\"` |\n| `alerting.teams.client.insecure` | Whether to skip TLS verification | `false` |\n| `alerting.teams.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.teams.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.teams.overrides[].*` | See `alerting.teams.*` parameters | `{}` |\n\n```yaml\nalerting:\n teams:\n webhook-url: \"https://********.webhook.office.com/webhookb2/************\"\n client:\n insecure: false\n # You can also add group-specific to keys, which will\n # override the to key above for the specified groups\n overrides:\n - group: \"core\"\n webhook-url: \"https://********.webhook.office.com/webhookb3/************\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 30s\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: teams\n description: \"healthcheck failed\"\n send-on-resolved: true\n\n - name: back-end\n group: core\n url: \"https://example.org/\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[CERTIFICATE_EXPIRATION] \u003e 48h\"\n alerts:\n - type: teams\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\nHere's an example of what the notifications look like:\n\n![Teams notifications](.github/assets/teams-alerts.png)\n\n#### Configuring Teams Workflow alerts\n\n\u003e [!NOTE]\n\u003e This alert is compatible with Workflows for Microsoft Teams. To setup the workflow and get the webhook URL, follow the [Microsoft Documentation](https://support.microsoft.com/en-us/office/create-incoming-webhooks-with-workflows-for-microsoft-teams-8ae491c7-0394-4861-ba59-055e33f75498).\n\n| Parameter | Description | Default |\n|:---------------------------------------------|:-------------------------------------------------------------------------------------------|:-------------------|\n| `alerting.teams-workflows` | Configuration for alerts of type `teams` | `{}` |\n| `alerting.teams-workflows.webhook-url` | Teams Webhook URL | Required `\"\"` |\n| `alerting.teams-workflows.title` | Title of the notification | `\"\u0026#x26D1; Gatus\"` |\n| `alerting.teams-workflows.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n| `alerting.teams-workflows.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.teams-workflows.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.teams-workflows.overrides[].*` | See `alerting.teams-workflows.*` parameters | `{}` |\n\n```yaml\nalerting:\n teams-workflows:\n webhook-url: \"https://********.webhook.office.com/webhookb2/************\"\n # You can also add group-specific to keys, which will\n # override the to key above for the specified groups\n overrides:\n - group: \"core\"\n webhook-url: \"https://********.webhook.office.com/webhookb3/************\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 30s\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: teams-workflows\n description: \"healthcheck failed\"\n send-on-resolved: true\n\n - name: back-end\n group: core\n url: \"https://example.org/\"\n interval: 5m\n conditions:\n - \"[STATUS] == 200\"\n - \"[CERTIFICATE_EXPIRATION] \u003e 48h\"\n alerts:\n - type: teams-workflows\n description: \"healthcheck failed\"\n send-on-resolved: true\n```\n\nHere's an example of what the notifications look like:\n\n![Teams Workflow notifications](.github/assets/teams-workflows-alerts.png)\n\n\n#### Configuring Telegram alerts\n| Parameter | Description | Default |\n|:--------------------------------------|:-------------------------------------------------------------------------------------------|:---------------------------|\n| `alerting.telegram` | Configuration for alerts of type `telegram` | `{}` |\n| `alerting.telegram.token` | Telegram Bot Token | Required `\"\"` |\n| `alerting.telegram.id` | Telegram User ID | Required `\"\"` |\n| `alerting.telegram.api-url` | Telegram API URL | `https://api.telegram.org` |\n| `alerting.telegram.client` | Client configuration. \u003cbr /\u003eSee [Client configuration](#client-configuration). | `{}` |\n| `alerting.telegram.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n| `alerting.telegram.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |\n| `alerting.telegram.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `\"\"` |\n| `alerting.telegram.overrides[].*` | See `alerting.telegram.*` parameters | `{}` |\n\n```yaml\nalerting:\n telegram:\n token: \"123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11\"\n id: \"0123456789\"\n\nendpoints:\n - name: website\n url: \"https://twin.sh/health\"\n interval: 30s\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n alerts:\n - type: telegram\n send-on-resolved: true\n```\n\nHere's an example of what the notifications look like:\n\n![Telegram notifications](.github/assets/telegram-alerts.png)\n\n\n#### Configuring Twilio alerts\n| Parameter | Description | Default |\n|:--------------------------------|:-------------------------------------------------------------------------------------------|:--------------|\n| `alerting.twilio` | Settings for alerts of type `twilio` | `{}` |\n| `alerting.twilio.sid` | Twilio account SID | Required `\"\"` |\n| `alerting.twilio.token` | Twilio auth token | Required `\"\"` |\n| `alerting.twilio.from` | Number to send Twilio alerts from | Required `\"\"` |\n| `alerting.twilio.to` | Number to send twilio alerts to | Required `\"\"` |\n| `alerting.twilio.default-alert` | Default alert configuration. \u003cbr /\u003eSee [Setting a default alert](#setting-a-default-alert) | N/A |\n\n```yaml\nalerting:\n twilio:\n sid: \"...\"\n token: \"...\"\n from: \"+1-234-567-8901\"\n to: \"+1-234-567-8901\"\n\nendpoints:\n - name: website\n interval: 30s\n url: \"https://twin.sh/health\"\n conditions:\n - \"[STATUS] == 200\"\n - \"[BODY].status == UP\"\n - \"[RESPONSE_TIME] \u003c 300\"\n alerts:\n - type: twilio\n failure-threshold: 5\n send-on-resolved: true\n description: \"healthcheck failed\"\n```\n\n\n#### Configuring Zulip alerts\n| Parameter | Description | Default |\n|:-----------------------------------|:------------------------------------------------------------------------------------|:--------------|\n| `alerting.zulip` | Configuration for alerts of type `discord` | `{}` |\n| `alerting.zulip.bot-email` | Bot Email | Required `\"\"` |\n| `alerting.zulip.bot-api-key` | Bot API key | Required `\"\"` |\n| `alerting.zulip.domain` | Full organization domain (e.g.: yourZulipDomain.zulipchat.com) | Required `\"\"` |\n| `alerting.zulip.channel-id` | The channel ID where Gatus will send the alerts | Required `\"\"` |\n| `alerting.zulip.overrides","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwin%2Fgatus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftwin%2Fgatus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwin%2Fgatus/lists"}