TwiN/gatus

Gatus is a developer-oriented health dashboard that gives you the ability to monitor your services using HTTP, ICMP, TCP, and even DNS queries as well as evaluate the result of said queries by using a list of conditions on values like the status code, the response time, the certificate expiration, the body and many others. The icing on top is that each of these health checks can be paired with alerting via Slack, Teams, PagerDuty, Discord, Twilio and many more.

I personally deploy it in my Kubernetes cluster and let it monitor the status of my core applications: https://status.twin.sh/

Looking for a managed solution? Check out Gatus.io.

docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus:stable

docker run -p 8080:8080 --name gatus twinproduction/gatus:stable

❤ Like this project? Please consider sponsoring me.

Have any feedback or questions? Create a discussion.

Table of Contents

• Table of Contents
• Why Gatus?
• Features
• Usage
• Configuration
  • Endpoints
  • External Endpoints
  • Suites (ALPHA)
  • Conditions
    • Placeholders
    • Functions
  • Web
  • UI
  • Announcements
  • Storage
  • Client configuration
  • Tunneling
  • Alerting
    • Configuring AWS SES alerts
    • Configuring ClickUp alerts
    • Configuring Datadog alerts
    • Configuring Discord alerts
    • Configuring Email alerts
    • Configuring Gitea alerts
    • Configuring GitHub alerts
    • Configuring GitLab alerts
    • Configuring Google Chat alerts
    • Configuring Gotify alerts
    • Configuring HomeAssistant alerts
    • Configuring IFTTT alerts
    • Configuring Ilert alerts
    • Configuring Incident.io alerts
    • Configuring Line alerts
    • Configuring Matrix alerts
    • Configuring Mattermost alerts
    • Configuring Messagebird alerts
    • Configuring n8n alerts
    • Configuring New Relic alerts
    • Configuring Ntfy alerts
    • Configuring Opsgenie alerts
    • Configuring PagerDuty alerts
    • Configuring Plivo alerts
    • Configuring Pushover alerts
    • Configuring Resend alerts
    • Configuring Rocket.Chat alerts
    • Configuring SendGrid alerts
    • Configuring Signal alerts
    • Configuring SIGNL4 alerts
    • Configuring Slack alerts
    • Configuring Splunk alerts
    • Configuring Squadcast alerts
    • Configuring Teams alerts (Deprecated)
    • Configuring Teams Workflow alerts
    • Configuring Telegram alerts
    • Configuring Twilio alerts
    • Configuring Vonage alerts
    • Configuring Webex alerts
    • Configuring Zapier alerts
    • Configuring Zulip alerts
    • Configuring custom alerts
    • Setting a default alert
  • Maintenance
  • Security
    • Basic Authentication
    • OIDC
  • TLS Encryption
  • Metrics
    • Custom Labels
  • Connectivity
  • Remote instances (EXPERIMENTAL)
• Deployment
  • Docker
  • Helm Chart
  • Terraform
    • Kubernetes
• Running the tests
• Using in Production
• FAQ
  • Sending a GraphQL request
  • Recommended interval
  • Default timeouts
  • Monitoring a TCP endpoint
  • Monitoring a UDP endpoint
  • Monitoring a SCTP endpoint
  • Monitoring a WebSocket endpoint
  • Monitoring an endpoint using gRPC
  • Monitoring an endpoint using ICMP
  • Monitoring an endpoint using DNS queries
  • Monitoring an endpoint using SSH
  • Monitoring an endpoint using STARTTLS
  • Monitoring an endpoint using TLS
  • Monitoring domain expiration
  • Concurrency
  • Reloading configuration on the fly
  • Endpoint groups
  • How do I sort by group by default?
  • Exposing Gatus on a custom path
  • Exposing Gatus on a custom port
  • Use environment variables in config files
  • Configuring a startup delay
  • Keeping your configuration small
  • Proxy client configuration
  • How to fix 431 Request Header Fields Too Large error
  • Badges
    • Uptime
    • Health
    • Health (Shields.io)
    • Response time
    • Response time (chart)
      • How to change the color thresholds of the response time badge
  • API
    • Interacting with the API programmatically
    • Raw Data
      • Uptime
      • Response Time
  • Installing as binary
  • High level design overview

Why Gatus?

Before getting into the specifics, I want to address the most common question:

Why would I use Gatus when I can just use Prometheus’ Alertmanager, Cloudwatch or even Splunk?

Neither of these can tell you that there’s a problem if there are no clients actively calling the endpoint. In other words, it's because monitoring metrics mostly rely on existing traffic, which effectively means that unless your clients are already experiencing a problem, you won't be notified.

Gatus, on the other hand, allows you to configure health checks for each of your features, which in turn allows it to monitor these features and potentially alert you before any clients are impacted.

A sign you may want to look into Gatus is by simply asking yourself whether you'd receive an alert if your load balancer was to go down right now. Will any of your existing alerts be triggered? Your metrics won’t report an increase in errors if no traffic makes it to your applications. This puts you in a situation where your clients are the ones that will notify you about the degradation of your services rather than you reassuring them that you're working on fixing the issue before they even know about it.

Features

The main features of Gatus are:

• 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.
• Ability to use Gatus for user acceptance tests: Thanks to the point above, you can leverage this application to create automated user acceptance tests.
• 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.
• 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.
• Metrics
• Low resource consumption: As with most Go applications, the resource footprint that this application requires is negligibly small.
• Badges:
• Dark mode

Usage

docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus:stable

You can also use Docker Hub if you prefer:

docker run -p 8080:8080 --name gatus twinproduction/gatus:stable

If you want to create your own configuration, see Docker for information on how to mount a configuration file.

Here's a simple example:

endpoints:
  - name: website                 # Name of your endpoint, can be anything
    url: "https://twin.sh/health"
    interval: 5m                  # Duration to wait between every status check (default: 60s)
    conditions:
      - "[STATUS] == 200"         # Status must be 200
      - "[BODY].status == UP"     # The json path "$.status" must be equal to UP
      - "[RESPONSE_TIME] < 300"   # Response time must be under 300ms

  - name: make-sure-header-is-rendered
    url: "https://example.org/"
    interval: 60s
    conditions:
      - "[STATUS] == 200"                          # Status must be 200
      - "[BODY] == pat(*<h1>Example Domain</h1>*)" # Body must contain the specified header

This example would look similar to this:

If you want to test it locally, see Docker.

Configuration

By default, the configuration file is expected to be at config/config.yaml.

You can specify a custom path by setting the GATUS_CONFIG_PATH environment variable.

If GATUS_CONFIG_PATH points to a directory, all *.yaml and *.yml files inside said directory and its subdirectories are merged like so:

• All maps/objects are deep merged (i.e. you could define alerting.slack in one file and alerting.pagerduty in another file)
• 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)
• Parameters with a primitive value (e.g. metrics, alerting.slack.webhook-url, etc.) may only be defined once to forcefully avoid any ambiguity
  • 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.

💡 You can also use environment variables in the configuration file (e.g. $DOMAIN, ${DOMAIN})

⚠️ When your configuration parameter contains a $ symbol, you have to escape $ with $$.

See Use environment variables in config files or examples/docker-compose-postgres-storage/config/config.yaml for examples.

If you want to test it locally, see Docker.

Configuration

If you want more verbose logging, you may set the GATUS_LOG_LEVEL environment variable to DEBUG. Conversely, if you want less verbose logging, you can set the aforementioned environment variable to WARN, ERROR or FATAL. The default value for GATUS_LOG_LEVEL is INFO.

Endpoints

Endpoints are URLs, applications, or services that you want to monitor. Each endpoint has a list of conditions that are evaluated on an interval that you define. If any condition fails, the endpoint is considered as unhealthy. You can then configure alerts to be triggered when an endpoint is unhealthy once a certain threshold is reached.

You may use the following placeholders in the body (endpoints[].body):

• [ENDPOINT_NAME] (resolved from endpoints[].name)
• [ENDPOINT_GROUP] (resolved from endpoints[].group)
• [ENDPOINT_URL] (resolved from endpoints[].url)
• [LOCAL_ADDRESS] (resolves to the local IP and port like 192.0.2.1:25 or [2001:db8::1]:80)
• [RANDOM_STRING_N] (resolves to a random string of numbers and letters of length N (max: 8192))

External Endpoints

Unlike regular endpoints, external endpoints are not monitored by Gatus, but they are instead pushed programmatically. This 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.

For instance:

• 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
• You can monitor services that are not supported by Gatus
• You can implement your own monitoring system while using Gatus as the dashboard

Example:

external-endpoints:
  - name: ext-ep-test
    group: core
    token: "potato"
    heartbeat:
      interval: 30m  # Automatically create a failure if no update is received within 30 minutes
    alerts:
      - type: discord
        description: "healthcheck failed"
        send-on-resolved: true

To push the status of an external endpoint, you can use gatus-cli:

gatus-cli external-endpoint push --url https://status.example.org --key "core_ext-ep-test" --token "potato" --success

or send an HTTP request:

POST /api/v1/endpoints/{key}/external?success={success}&error={error}&duration={duration}

Where:

• {key} has the pattern <GROUP_NAME>_<ENDPOINT_NAME> in which both variables have , /, _, ,, ., #, + and & replaced by -.
  • Using the example configuration above, the key would be core_ext-ep-test.
• {success} is a boolean (true or false) value indicating whether the health check was successful or not.
• {error} (optional): 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, this will be ignored.
• {duration} (optional): the time that the request took as a duration string (e.g. 10s).

You must also pass the token as a Bearer token in the Authorization header.

Suites (ALPHA)

Suites are collections of endpoints that are executed sequentially with a shared context. This allows you to create complex monitoring scenarios where the result from one endpoint can be used in subsequent endpoints, enabling workflow-style monitoring.

Here are a few cases in which suites could be useful:

• Testing multi-step authentication flows (login -> access protected resource -> logout)
• API workflows where you need to chain requests (create resource -> update -> verify -> delete)
• Monitoring business processes that span multiple services
• Validating data consistency across multiple endpoints

Note: Suite-level alerts are not supported yet. Configure alerts on individual endpoints within the suite instead.

Using Context in Endpoints

Once values are stored in the context, they can be referenced in subsequent endpoints:

• In the URL: https://api.example.com/users/[CONTEXT].user_id
• In headers: Authorization: Bearer [CONTEXT].auth_token
• In the body: {"user_id": "[CONTEXT].user_id"}
• In conditions: [BODY].server_ip == [CONTEXT].server_ip

Note that context/store keys are limited to A-Z, a-z, 0-9, underscores (_), and hyphens (-).

Example Suite Configuration

suites:
  - name: item-crud-workflow
    group: api-tests
    interval: 5m
    context:
      price: "19.99"  # Initial static value in context
    endpoints:
      # Step 1: Create an item and store the item ID
      - name: create-item
        url: https://api.example.com/items
        method: POST
        body: '{"name": "Test Item", "price": "[CONTEXT].price"}'
        conditions:
          - "[STATUS] == 201"
          - "len([BODY].id) > 0"
          - "[BODY].price == [CONTEXT].price"
        store:
          itemId: "[BODY].id"
        alerts:
          - type: slack
            description: "Failed to create item"

      # Step 2: Update the item using the stored item ID
      - name: update-item
        url: https://api.example.com/items/[CONTEXT].itemId
        method: PUT
        body: '{"price": "24.99"}'
        conditions:
          - "[STATUS] == 200"
        alerts:
          - type: slack
            description: "Failed to update item"

      # Step 3: Fetch the item and validate the price
      - name: get-item
        url: https://api.example.com/items/[CONTEXT].itemId
        method: GET
        conditions:
          - "[STATUS] == 200"
          - "[BODY].price == 24.99"
        alerts:
          - type: slack
            description: "Item price did not update correctly"

      # Step 4: Delete the item (always-run: true to ensure cleanup even if step 2 or 3 fails)
      - name: delete-item
        url: https://api.example.com/items/[CONTEXT].itemId
        method: DELETE
        always-run: true
        conditions:
          - "[STATUS] == 204"
        alerts:
          - type: slack
            description: "Failed to delete item"

The suite will be considered successful only if all required endpoints pass their conditions.

Conditions

Here are some examples of conditions you can use:

Placeholders

Functions

💡 Use pat only when you need to. [STATUS] == pat(2*) is a lot more expensive than [STATUS] < 300.

💡 Because an unquoted dot always separates two keys, object keys that contain dots must be wrapped in single or double quotes between brackets. For instance, given the body {"status": {"core.integrations.key_1": "ok"}}, the condition to use is [BODY].status["core.integrations.key_1"] == ok.

Web

Allows you to configure how and where the dashboard is being served.

UI

Allows you to configure the application wide defaults for the dashboard's UI. Some of these parameters can be overridden locally by users using the local storage of their browser.

Announcements

System-wide announcements allow you to display important messages at the top of the status page. These can be used to inform users about planned maintenance, ongoing issues, or general information. You can use markdown to format your announcements.

This is essentially what some status page calls "incident communications".

Types:

• outage: Indicates service disruptions or critical issues (red theme)
• warning: Indicates potential issues or important notices (yellow theme)
• information: General information or updates (blue theme)
• operational: Indicates resolved issues or normal operations (green theme)
• none: Neutral announcements with no specific severity (gray theme, default if none are specified)

Example Configuration:

announcements:
  - timestamp: 2025-11-07T14:00:00Z
    type: outage
    message: "Scheduled maintenance on database servers from 14:00 to 16:00 UTC"
  - timestamp: 2025-11-07T16:15:00Z
    type: operational
    message: "Database maintenance completed successfully. All systems operational."
  - timestamp: 2025-11-07T12:00:00Z
    type: information
    message: "New monitoring dashboard features will be deployed next week"
  - timestamp: 2025-11-06T09:00:00Z
    type: warning
    message: "Elevated API response times observed for US customers"
    archived: true

If at least one announcement is archived, a Past Announcements section will be rendered at the bottom of the status page:

Storage

The results for each endpoint health check as well as the data for uptime and the past events must be persisted so that they can be displayed on the dashboard. These parameters allow you to configure the storage in question.

• If storage.type is memory (default):

# Note that this is the default value, and you can omit the storage configuration altogether to achieve the same result.
# Because the data is stored in memory, the data will not survive a restart.
storage:
  type: memory
  maximum-number-of-results: 200
  maximum-number-of-events: 5

• If storage.type is sqlite, storage.path must not be blank:

storage:
  type: sqlite
  path: data.db

See examples/docker-compose-sqlite-storage for an example.

• If storage.type is postgres, storage.path must be the connection URL:

storage:
  type: postgres
  path: "postgres://user:[email protected]:5432/gatus?sslmode=disable"

See examples/docker-compose-postgres-storage for an example.

Client configuration

In order to support a wide range of environments, each monitored endpoint has a unique configuration for the client used to send the request.

📝 Some of these parameters are ignored based on the type of endpoint. For instance, there's no certificate involved in ICMP requests (ping), therefore, setting client.insecure to true for an endpoint of that type will not do anything.

This default configuration is as follows:

client:
  insecure: false
  ignore-redirect: false
  timeout: 10s
  store-cookies: false

Note that this configuration is only available under endpoints[], alerting.mattermost and alerting.custom.

Here's an example with the client configuration under endpoints[]:

endpoints:
  - name: website
    url: "https://twin.sh/health"
    client:
      insecure: false
      ignore-redirect: false
      timeout: 10s
    conditions:
      - "[STATUS] == 200"

This example shows how you can specify a custom DNS resolver:

endpoints:
  - name: with-custom-dns-resolver
    url: "https://your.health.api/health"
    client:
      dns-resolver: "tcp://8.8.8.8:53"
    conditions:
      - "[STATUS] == 200"

This example shows how you can use the client.oauth2 configuration to query a backend API with Bearer token:

endpoints:
  - name: with-custom-oauth2
    url: "https://your.health.api/health"
    client:
      oauth2:
        token-url: https://your-token-server/token
        client-id: 00000000-0000-0000-0000-000000000000
        client-secret: your-client-secret
        scopes: ['https://your.health.api/.default']
    conditions:
      - "[STATUS] == 200"

This 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:

endpoints:
  - name: with-custom-iap
    url: "https://my.iap.protected.app/health"
    client:
      identity-aware-proxy:
        audience: "XXXXXXXX-XXXXXXXXXXXX.apps.googleusercontent.com"
    conditions:
      - "[STATUS] == 200"

📝 Note that Gatus will use the gcloud default credentials within its environment to generate the token.

This example shows you how you can use the client.tls configuration to perform an mTLS query to a backend API:

endpoints:
  - name: website
    url: "https://your.mtls.protected.app/health"
    client:
      tls:
        certificate-file: /path/to/user_cert.pem
        private-key-file: /path/to/user_key.pem
        renegotiation: once
    conditions:
      - "[STATUS] == 200"

📝 Note that if running in a container, you must volume mount the certificate and key into the container.

Tunneling

Gatus supports SSH tunneling to monitor internal services through jump hosts or bastion servers. This is particularly useful for monitoring services that are not directly accessible from where Gatus is deployed.

SSH tunnels are defined globally in the tunneling section and then referenced by name in endpoint client configurations.

tunneling:
  production:
    type: SSH
    host: "jumphost.example.com"
    username: "monitoring"
    private-key: |
      -----BEGIN RSA PRIVATE KEY-----
      MIIEpAIBAAKCAQEA...
      -----END RSA PRIVATE KEY-----

endpoints:
  - name: "internal-api"
    url: "http://internal-api.example.com:8080/health"
    client:
      tunnel: "production"
    conditions:
      - "[STATUS] == 200"

[!NOTE] As with SSH endpoints, password authentication also works with servers that only offer the keyboard-interactive authentication method.

⚠️ WARNING:: Tunneling may introduce additional latency, especially if the connection to the tunnel is retried frequently. This may lead to inaccurate response time measurements.

Alerting

Gatus supports multiple alerting providers, such as Slack and PagerDuty, and supports different alerts for each individual endpoints with configurable descriptions and thresholds.

Alerts are configured at the endpoint level like so:

Here's an example of what an alert configuration might look like at the endpoint level:

endpoints:
  - name: example
    url: "https://example.org"
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: slack
        description: "healthcheck failed"
        send-on-resolved: true

You can also override global provider configuration by using alerts[].provider-override, like so:

endpoints:
  - name: example
    url: "https://example.org"
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: slack
        provider-override:
          webhook-url: "https://hooks.slack.com/services/**********/**********/**********"

📝 If an alerting provider is not properly configured, all alerts configured with the provider's type will be ignored.

Configuring AWS SES alerts

alerting:
  aws-ses:
    access-key-id: "..."
    secret-access-key: "..."
    region: "us-east-1"
    from: "[email protected]"
    to: "[email protected]"

endpoints:
  - name: website
    interval: 30s
    url: "https://twin.sh/health"
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: aws-ses
        failure-threshold: 5
        send-on-resolved: true
        description: "healthcheck failed"

If the access-key-id and secret-access-key are not defined Gatus will fall back to IAM authentication.

Make sure you have the ability to use ses:SendEmail.

Configuring ClickUp alerts

The ClickUp alerting provider creates tasks in a ClickUp list when alerts are triggered. If send-on-resolved is set to true on the endpoint alert, the task will be automatically closed when the alert is resolved.

The following placeholders are supported in name and content:

• [ENDPOINT_GROUP] - Resolved from endpoints[].group
• [ENDPOINT_NAME] - Resolved from endpoints[].name
• [ALERT_DESCRIPTION] - Resolved from endpoints[].alerts[].description
• [RESULT_ERRORS] - Resolved from the health evaluation errors

alerting:
  clickup:
    list-id: "123456789"
    token: "pk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    assignees:
      - "12345"
      - "67890"
    status: "in progress"
    priority: high
    name: "Health Check Alert: [ENDPOINT_GROUP] - [ENDPOINT_NAME]"
    content: "Alert triggered for [ENDPOINT_GROUP] - [ENDPOINT_NAME] - [ALERT_DESCRIPTION] - [RESULT_ERRORS]"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: clickup
        send-on-resolved: true

To get your ClickUp API token follow: Generate or regenerate a Personal API Token

To find your List ID:

1. Open the ClickUp list where you want tasks to be created
2. The List ID is in the URL: https://app.clickup.com/{workspace_id}/v/l/li/{list_id}

To find Assignee IDs:

1. Go to https://app.clickup.com/{workspace_id}/teams-pulse/teams/people
2. Hover over a team member
3. Click the 3 dots (overflow menu)
4. Click Copy member ID

Configuring Datadog alerts

⚠️ WARNING: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on #1223 with whether the provider works as intended. Thank you for your cooperation.

alerting:
  datadog:
    api-key: "YOUR_API_KEY"
    site: "datadoghq.com"  # or datadoghq.eu for EU region
    tags:
      - "environment:production"
      - "team:platform"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: datadog
        send-on-resolved: true

Configuring Discord alerts

alerting:
  discord:
    webhook-url: "https://discord.com/api/webhooks/**********/**********"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: discord
        description: "healthcheck failed"
        send-on-resolved: true

Configuring Email alerts

alerting:
  email:
    from: "[email protected]"
    username: "[email protected]"
    password: "hunter2"
    host: "mail.example.com"
    port: 587
    to: "[email protected],[email protected]"
    client:
      insecure: false
    # You can also add group-specific to keys, which will
    # override the to key above for the specified groups
    overrides:
      - group: "core"
        to: "[email protected],[email protected]"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: email
        description: "healthcheck failed"
        send-on-resolved: true

  - name: back-end
    group: core
    url: "https://example.org/"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[CERTIFICATE_EXPIRATION] > 48h"
    alerts:
      - type: email
        description: "healthcheck failed"
        send-on-resolved: true

⚠ Some mail servers are painfully slow.

Configuring Gitea alerts

The Gitea alerting provider creates an issue prefixed with alert(gatus): and suffixed with the endpoint's display name for each alert. If send-on-resolved is set to true on the endpoint alert, the issue will be automatically closed when the alert is resolved.

alerting:
  gitea:
    repository-url: "https://gitea.com/TwiN/test"
    token: "349d63f16......"

endpoints:
  - name: example
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 75"
    alerts:
      - type: gitea
        failure-threshold: 2
        success-threshold: 3
        send-on-resolved: true
        description: "Everything's burning AAAAAHHHHHHHHHHHHHHH"

Configuring GitHub alerts

The GitHub alerting provider creates an issue prefixed with alert(gatus): and suffixed with the endpoint's display name for each alert. If send-on-resolved is set to true on the endpoint alert, the issue will be automatically closed when the alert is resolved.

alerting:
  github:
    repository-url: "https://github.com/TwiN/test"
    token: "github_pat_12345..."

endpoints:
  - name: example
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 75"
    alerts:
      - type: github
        failure-threshold: 2
        success-threshold: 3
        send-on-resolved: true
        description: "Everything's burning AAAAAHHHHHHHHHHHHHHH"

Configuring GitLab alerts

The GitLab alerting provider creates an alert prefixed with alert(gatus): and suffixed with the endpoint's display name for each alert. If send-on-resolved is set to true on the endpoint alert, the alert will be automatically closed when the alert is resolved. See https://docs.gitlab.com/ee/operations/incident_management/integrations.html#configuration to configure the endpoint.

alerting:
  gitlab:
    webhook-url: "https://gitlab.com/hlidotbe/example/alerts/notify/gatus/xxxxxxxxxxxxxxxx.json"
    authorization-key: "12345"

endpoints:
  - name: example
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 75"
    alerts:
      - type: gitlab
        failure-threshold: 2
        success-threshold: 3
        send-on-resolved: true
        description: "Everything's burning AAAAAHHHHHHHHHHHHHHH"

Configuring Google Chat alerts

alerting:
  googlechat:
    webhook-url: "https://chat.googleapis.com/v1/spaces/*******/messages?key=**********&token=********"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: googlechat
        description: "healthcheck failed"
        send-on-resolved: true

Configuring Gotify alerts

alerting:
  gotify:
    server-url: "https://gotify.example"
    token: "**************"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: gotify
        description: "healthcheck failed"
        send-on-resolved: true

Here's an example of what the notifications look like:

Configuring HomeAssistant alerts

[!NOTE] It is recommended to use the native Home Assistant integration instead (see below).

alerting:
  homeassistant:
    url: "http://homeassistant:8123"  # URL of your HomeAssistant instance
    token: "YOUR_LONG_LIVED_ACCESS_TOKEN"  # Long-lived access token from HomeAssistant

endpoints:
  - name: my-service
    url: "https://my-service.com"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: homeassistant
        enabled: true
        send-on-resolved: true
        description: "My service health check"
        failure-threshold: 3
        success-threshold: 2

The alerts will be sent as events to HomeAssistant with the event type gatus_alert. The event data includes:

• status: "triggered" or "resolved"
• endpoint: The name of the monitored endpoint
• description: The alert description if provided
• conditions: List of conditions and their results
• failure_count: Number of consecutive failures (when triggered)
• success_count: Number of consecutive successes (when resolved)

You can use these events in HomeAssistant automations to:

• Send notifications
• Control devices
• Trigger scenes
• Log to history
• And more

Example HomeAssistant automation:

automation:
  - alias: "Gatus Alert Handler"
    trigger:
      platform: event
      event_type: gatus_alert
    action:
      - service: notify.notify
        data_template:
          title: "Gatus Alert: {{ trigger.event.data.event_data.endpoint }}"
          message: >
            Status: {{ trigger.event.data.event_data.status }}
            {% if trigger.event.data.event_data.description %}
            Description: {{ trigger.event.data.event_data.description }}
            {% endif %}
            {% for condition in trigger.event.data.event_data.conditions %}
            {{ '✅' if condition.success else '❌' }} {{ condition.condition }}
            {% endfor %}

To get your HomeAssistant long-lived access token:

1. Open HomeAssistant
2. Click on your profile name (bottom left)
3. Scroll down to "Long-Lived Access Tokens"
4. Click "Create Token"
5. Give it a name (e.g., "Gatus")
6. Copy the token - you'll only see it once!

Native Home Assistant Integration

Gatus can be integrated into Home Assistant to monitor the status of your endpoints directly from your home automation dashboard.

alias: "Notify when Gatus endpoint goes down"
description: "Sends a mobile notification if a Gatus endpoint goes down"
trigger:
  - platform: state
    entity_id:
      - binary_sensor.website
      - binary_sensor.make_sure_header_is_rendered
    to: "off"
action:
  - action: notify.mobile_app_your_device_name
    data:
      title: "Gatus Alert"
      message: "The endpoint {{ trigger.to_state.name }} is down!"

Configuring IFTTT alerts

⚠️ WARNING: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on #1223 with whether the provider works as intended. Thank you for your cooperation.

alerting:
  ifttt:
    webhook-key: "YOUR_WEBHOOK_KEY"
    event-name: "gatus_alert"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: ifttt
        send-on-resolved: true

Configuring Ilert alerts

It is highly recommended to set endpoints[].alerts[].send-on-resolved to true for alerts of type ilert, because unlike other alerts, the operation resulting from setting said parameter to true will not create another alert but mark the alert as resolved on ilert instead.

Behavior:

• By default, alerting.ilert.integration-key is used as the integration key
• If the endpoint being evaluated belongs to a group (endpoints[].group) matching the value of alerting.ilert.overrides[].group, the provider will use that override's integration key instead of alerting.ilert.integration-key's

alerting:
  ilert:
    integration-key: "********************************"
    # You can also add group-specific integration keys, which will
    # override the integration key above for the specified groups
    overrides:
      - group: "core"
        integration-key: "********************************"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 30s
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: ilert
        failure-threshold: 3
        success-threshold: 5
        send-on-resolved: true
        description: "healthcheck failed"

Configuring Incident.io alerts

alerting:
  incident-io:
    url: "*****************"
    auth-token: "********************************************"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 30s
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: incident-io
        description: "healthcheck failed"
        send-on-resolved: true

In order to get the required alert source config id and authentication token, you must configure an HTTP alert source.

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

Configuring Line alerts

alerting:
  line:
    channel-access-token: "YOUR_CHANNEL_ACCESS_TOKEN"
    user-ids:
      - "U1234567890abcdef" # This can be a group id, room id or user id
      - "U2345678901bcdefg"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: line
        send-on-resolved: true

Configuring Matrix alerts

alerting:
  matrix:
    server-url: "https://matrix-client.matrix.org"
    access-token: "123456"
    internal-room-id: "!example:matrix.org"

endpoints:
  - name: website
    interval: 5m
    url: "https://twin.sh/health"
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: matrix
        send-on-resolved: true
        description: "healthcheck failed"

Configuring Mattermost alerts

alerting:
  mattermost:
    webhook-url: "http://**********/hooks/**********"
    client:
      insecure: true

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: mattermost
        description: "healthcheck failed"
        send-on-resolved: true

Here's an example of what the notifications look like:

Configuring Messagebird alerts

Example of sending SMS text message alert using Messagebird:

alerting:
  messagebird:
    access-key: "..."
    originator: "31619191918"
    recipients: "31619191919,31619191920"

endpoints:
  - name: website
    interval: 5m
    url: "https://twin.sh/health"
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: messagebird
        failure-threshold: 3
        send-on-resolved: true
        description: "healthcheck failed"

Configuring New Relic alerts

⚠️ WARNING: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on #1223 with whether the provider works as intended. Thank you for your cooperation.

alerting:
  newrelic:
    api-key: "YOUR_API_KEY"
    account-id: "1234567"
    region: "US"  # or "EU" for European region

endpoints:
  - name: example
    url: "https://example.org"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: newrelic
        send-on-resolved: true

Configuring n8n alerts

n8n is a workflow automation platform that allows you to automate tasks across different applications and services using webhooks.

See n8n-nodes-gatus-trigger for a n8n community node that can be used as trigger.

Example:

alerting:
  n8n:
    webhook-url: "https://your-n8n-instance.com/webhook/your-webhook-id"
    title: "Gatus Monitoring"
    default-alert:
      send-on-resolved: true

endpoints:
  - name: example
    url: "https://example.org"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: n8n
        description: "Health check alert"

The JSON payload sent to the n8n webhook will include:

• title: The configured title
• endpoint_name: Name of the endpoint
• endpoint_group: Group of the endpoint (if any)
• endpoint_url: URL being monitored
• alert_description: Custom alert description
• resolved: Boolean indicating if the alert is resolved
• message: Human-readable alert message
• condition_results: Array of condition results with their success status

Configuring Ntfy alerts

ntfy is an amazing project that allows you to subscribe to desktop and mobile notifications, making it an awesome addition to Gatus.

Example:

alerting:
  ntfy:
    topic: "gatus-test-topic"
    priority: 2
    token: faketoken
    default-alert:
      failure-threshold: 3
      send-on-resolved: true
    # You can also add group-specific to keys, which will
    # override the to key above for the specified groups
    overrides:
      - group: "other"
        topic: "gatus-other-test-topic"
        priority: 4
        click: "https://example.com"

endpoints:
  - name: website
    interval: 5m
    url: "https://twin.sh/health"
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: ntfy
  - name: other example
    group: other
    interval: 30m
    url: "https://example.com"
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
    alerts:
      - type: ntfy
        description: example

Configuring Opsgenie alerts

Opsgenie provider will automatically open and close alerts.

alerting:
  opsgenie:
    api-key: "00000000-0000-0000-0000-000000000000"

Configuring PagerDuty alerts

It is highly recommended to set endpoints[].alerts[].send-on-resolved to true for alerts of type pagerduty, because unlike other alerts, the operation resulting from setting said parameter to true will not create another incident but mark the incident as resolved on PagerDuty instead.

Behavior:

• By default, alerting.pagerduty.integration-key is used as the integration key
• 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

alerting:
  pagerduty:
    integration-key: "********************************"
    # You can also add group-specific integration keys, which will
    # override the integration key above for the specified groups
    overrides:
      - group: "core"
        integration-key: "********************************"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 30s
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: pagerduty
        failure-threshold: 3
        success-threshold: 5
        send-on-resolved: true
        description: "healthcheck failed"

  - name: back-end
    group: core
    url: "https://example.org/"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[CERTIFICATE_EXPIRATION] > 48h"
    alerts:
      - type: pagerduty
        failure-threshold: 3
        success-threshold: 5
        send-on-resolved: true
        description: "healthcheck failed"

Configuring Plivo alerts

⚠️ WARNING: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on #1223 with whether the provider works as intended. Thank you for your cooperation.

alerting:
  plivo:
    auth-id: "MAXXXXXXXXXXXXXXXXXX"
    auth-token: "your-auth-token"
    from: "+1234567890"
    to:
      - "+0987654321"
      - "+1122334455"

endpoints:
  - name: website
    interval: 30s
    url: "https://twin.sh/health"
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: plivo
        failure-threshold: 5
        send-on-resolved: true
        description: "healthcheck failed"

Configuring Pushover alerts

alerting:
  pushover:
    application-token: "******************************"
    user-key: "******************************"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 30s
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: pushover
        failure-threshold: 3
        success-threshold: 5
        send-on-resolved: true
        description: "healthcheck failed"

Configuring Resend alerts

The from address must belong to a domain that has been verified in your Resend account.

alerting:
  resend:
    api-key: "re_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    from: "Gatus <[email protected]>"
    to: "[email protected],[email protected]"
    # You can also add group-specific to keys, which will
    # override the to key above for the specified groups
    overrides:
      - group: "core"
        to: "[email protected]"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: resend
        send-on-resolved: true
        description: "healthcheck failed"

Configuring Rocket.Chat alerts

⚠️ WARNING: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on #1223 with whether the provider works as intended. Thank you for your cooperation.

alerting:
  rocketchat:
    webhook-url: "https://your-rocketchat.com/hooks/YOUR_WEBHOOK_ID/YOUR_TOKEN"
    channel: "#alerts"  # Optional

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: rocketchat
        send-on-resolved: true

Configuring SendGrid alerts

⚠️ WARNING: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on #1223 with whether the provider works as intended. Thank you for your cooperation.

alerting:
  sendgrid:
    api-key: "SG.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    from: "[email protected]"
    to: "[email protected],[email protected]"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: sendgrid
        send-on-resolved: true

Configuring Signal alerts

⚠️ WARNING: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on #1223 with whether the provider works as intended. Thank you for your cooperation.

alerting:
  signal:
    api-url: "http://localhost:8080"
    number: "+1234567890"
    recipients:
      - "+0987654321"
      - "+1122334455"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: signal
        send-on-resolved: true

Configuring SIGNL4 alerts

SIGNL4 is a mobile alerting and incident management service that sends critical alerts to team members via mobile push, SMS, voice calls, and email.

alerting:
  signl4:
    team-secret: "your-team-secret-here"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: signl4
        send-on-resolved: true

Configuring Slack alerts

alerting:
  slack:
    webhook-url: "https://hooks.slack.com/services/**********/**********/**********"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 30s
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: slack
        description: "healthcheck failed 3 times in a row"
        send-on-resolved: true
      - type: slack
        failure-threshold: 5
        description: "healthcheck failed 5 times in a row"
        send-on-resolved: true

Here's an example of what the notifications look like:

Configuring Splunk alerts

alerting:
  splunk:
    hec-url: "https://splunk.example.com:8088"
    hec-token: "YOUR_HEC_TOKEN"
    index: "main"  # Optional

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: splunk
        send-on-resolved: true

Configuring Squadcast alerts

⚠️ WARNING: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on #1223 with whether the provider works as intended. Thank you for your cooperation.

alerting:
  squadcast:
    webhook-url: "https://api.squadcast.com/v3/incidents/api/YOUR_API_KEY"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: squadcast
        send-on-resolved: true

Configuring Teams alerts (Deprecated)

[!CAUTION] Deprecated: Office 365 Connectors within Microsoft Teams are being retired (Source: Microsoft DevBlog). Existing connectors will continue to work until December 2025. The new Teams Workflow Alerts should be used with Microsoft Workflows instead of this legacy configuration.

alerting:
  teams:
    webhook-url: "https://********.webhook.office.com/webhookb2/************"
    client:
      insecure: false
    # You can also add group-specific to keys, which will
    # override the to key above for the specified groups
    overrides:
      - group: "core"
        webhook-url: "https://********.webhook.office.com/webhookb3/************"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 30s
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: teams
        description: "healthcheck failed"
        send-on-resolved: true

  - name: back-end
    group: core
    url: "https://example.org/"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[CERTIFICATE_EXPIRATION] > 48h"
    alerts:
      - type: teams
        description: "healthcheck failed"
        send-on-resolved: true

Here's an example of what the notifications look like:

Configuring Teams Workflow alerts

[!NOTE] This alert is compatible with Workflows for Microsoft Teams. To setup the workflow and get the webhook URL, follow the Microsoft Documentation.

alerting:
  teams-workflows:
    webhook-url: "https://********.webhook.office.com/webhookb2/************"
    # You can also add group-specific to keys, which will
    # override the to key above for the specified groups
    overrides:
      - group: "core"
        webhook-url: "https://********.webhook.office.com/webhookb3/************"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 30s
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: teams-workflows
        description: "healthcheck failed"
        send-on-resolved: true

  - name: back-end
    group: core
    url: "https://example.org/"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[CERTIFICATE_EXPIRATION] > 48h"
    alerts:
      - type: teams-workflows
        description: "healthcheck failed"
        send-on-resolved: true

Here's an example of what the notifications look like:

Configuring Telegram alerts

alerting:
  telegram:
    token: "123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11"
    id: "0123456789"
    topic-id: "7"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 30s
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
    alerts:
      - type: telegram
        send-on-resolved: true

Here's an example of what the notifications look like:

Configuring Twilio alerts

Custom message templates are supported via the following additional parameters:

alerting:
  twilio:
    sid: "..."
    token: "..."
    from: "+1-234-567-8901"
    to: "+1-234-567-8901"
    # Custom message templates using placeholders (optional)
    # Supports both old format {endpoint}/{description} and new format [ENDPOINT]/[ALERT_DESCRIPTION]
    text-twilio-triggered: "🚨 ALERT: [ENDPOINT] is down! [ALERT_DESCRIPTION]"
    text-twilio-resolved: "✅ RESOLVED: [ENDPOINT] is back up! [ALERT_DESCRIPTION]"

endpoints:
  - name: website
    interval: 30s
    url: "https://twin.sh/health"
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: twilio
        failure-threshold: 5
        send-on-resolved: true
        description: "healthcheck failed"

Configuring Vonage alerts

⚠️ WARNING: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on #1223 with whether the provider works as intended. Thank you for your cooperation.

alerting:
  vonage:
    api-key: "YOUR_API_KEY"
    api-secret: "YOUR_API_SECRET"
    from: "Gatus"
    to: "+1234567890"

Example of sending alerts to Vonage:

endpoints:
  - name: website
    url: "https://example.org"
    alerts:
      - type: vonage
        failure-threshold: 5
        send-on-resolved: true
        description: "healthcheck failed"

Configuring Webex alerts

⚠️ WARNING: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on #1223 with whether the provider works as intended. Thank you for your cooperation.

alerting:
  webex:
    webhook-url: "https://webexapis.com/v1/webhooks/incoming/YOUR_WEBHOOK_ID"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: webex
        send-on-resolved: true

Configuring Zapier alerts

⚠️ WARNING: This alerting provider has not been tested yet. If you've tested it and confirmed that it works, please remove this warning and create a pull request, or comment on #1223 with whether the provider works as intended. Thank you for your cooperation.

alerting:
  zapier:
    webhook-url: "https://hooks.zapier.com/hooks/catch/YOUR_WEBHOOK_ID/"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: zapier
        send-on-resolved: true

Configuring Zulip alerts

alerting:
  zulip:
    bot-email: [email protected]
    bot-api-key: "********************************"
    domain: some.zulip.org
    channel-id: 123456
    topic: "[ENDPOINT_NAME]" # Optional; groups each endpoint's alerts under its own topic. Defaults to "Gatus"

endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: zulip
        description: "healthcheck failed"
        send-on-resolved: true

Configuring custom alerts

While they're called alerts, you can use this feature to call anything.

For instance, you could automate rollbacks by having an application that keeps tracks of new deployments, and by leveraging Gatus, you could have Gatus call that application endpoint when an endpoint starts failing. Your application would then check if the endpoint that started failing was part of the recently deployed application, and if it was, then automatically roll it back.

Furthermore, you may use the following placeholders in the body (alerting.custom.body) and in the url (alerting.custom.url):

• [ALERT_DESCRIPTION] (resolved from endpoints[].alerts[].description)
• [ENDPOINT_NAME] (resolved from endpoints[].name)
• [ENDPOINT_GROUP] (resolved from endpoints[].group)
• [ENDPOINT_URL] (resolved from endpoints[].url)
• [RESULT_ERRORS] (resolved from the health evaluation of a given health check)
• [RESULT_CONDITIONS] (condition results from the health evaluation of a given health check)

If you have an alert using the custom provider with send-on-resolved set to true, you can use the [ALERT_TRIGGERED_OR_RESOLVED] placeholder to differentiate the notifications. The aforementioned placeholder will be replaced by TRIGGERED or RESOLVED accordingly, though it can be modified (details at the end of this section).

For all intents and purposes, we'll configure the custom alert with a Slack webhook, but you can call anything you want.

alerting:
  custom:
    url: "https://hooks.slack.com/services/**********/**********/**********"
    method: "POST"
    body: |
      {
        "text": "[ALERT_TRIGGERED_OR_RESOLVED]: [ENDPOINT_GROUP] - [ENDPOINT_NAME] - [ALERT_DESCRIPTION] - [RESULT_ERRORS]"
      }
endpoints:
  - name: website
    url: "https://twin.sh/health"
    interval: 30s
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 300"
    alerts:
      - type: custom
        failure-threshold: 10
        success-threshold: 3
        send-on-resolved: true
        description: "health check failed"

Note that you can customize the resolved values for the [ALERT_TRIGGERED_OR_RESOLVED] placeholder like so:

alerting:
  custom:
    placeholders:
      ALERT_TRIGGERED_OR_RESOLVED:
        TRIGGERED: "partial_outage"
        RESOLVED: "operational"

As a result, the [ALERT_TRIGGERED_OR_RESOLVED] in the body of first example of this section would be replaced by partial_outage when an alert is triggered and operational when an alert is resolved.

Setting a default alert

⚠ You must still specify the type of the alert in the endpoint configuration even if you set the default alert of a provider.

While you can specify the alert configuration directly in the endpoint definition, it's tedious and may lead to a very long configuration file.

To avoid such problem, you can use the default-alert parameter present in each provider configuration:

alerting:
  slack:
    webhook-url: "https://hooks.slack.com/services/**********/**********/**********"
    default-alert:
      description: "health check failed"
      send-on-resolved: true
      failure-threshold: 5
      success-threshold: 5

As a result, your Gatus configuration looks a lot tidier:

endpoints:
  - name: example
    url: "https://example.org"
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: slack

  - name: other-example
    url: "https://example.com"
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: slack

It also allows you to do things like this:

endpoints:
  - name: example
    url: "https://example.org"
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: slack
        failure-threshold: 5
      - type: slack
        failure-threshold: 10
      - type: slack
        failure-threshold: 15

Of course, you can also mix alert types:

alerting:
  slack:
    webhook-url: "https://hooks.slack.com/services/**********/**********/**********"
    default-alert:
      failure-threshold: 3
  pagerduty:
    integration-key: "********************************"
    default-alert:
      failure-threshold: 5

endpoints:
  - name: endpoint-1
    url: "https://example.org"
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: slack
      - type: pagerduty

  - name: endpoint-2
    url: "https://example.org"
    conditions:
      - "[STATUS] == 200"
    alerts:
      - type: slack
      - type: pagerduty

Maintenance

If you have maintenance windows, you may not want to be annoyed by alerts. To do that, you'll have to use the maintenance configuration:

Here's an example:

maintenance:
  start: 23:00
  duration: 1h
  timezone: "Europe/Amsterdam"
  every: [Monday, Thursday]

Note that you can also specify each day on separate lines:

maintenance:
  start: 23:00
  duration: 1h
  timezone: "Europe/Amsterdam"
  every:
    - Monday
    - Thursday

You can also specify maintenance windows on a per-endpoint basis:

endpoints:
  - name: endpoint-1
    url: "https://example.org"
    maintenance-windows:
      - start: "07:30"
        duration: 40m
        timezone: "Europe/Berlin"
      - start: "14:30"
        duration: 1h
        timezone: "Europe/Berlin"

Security

Basic Authentication

The example below will require that you authenticate with the username john.doe and the password hunter2:

security:
  basic:
    username: "john.doe"
    password-bcrypt-base64: "JDJhJDEwJHRiMnRFakxWazZLdXBzRERQazB1TE8vckRLY05Yb1hSdnoxWU0yQ1FaYXZRSW1McmladDYu"

⚠ Make sure to carefully select the cost of the bcrypt hash. The higher the cost, the longer it takes to compute the hash, and basic auth verifies the password against the hash on every request. As of 2023-01-06, I suggest a cost of 9.

OIDC

security:
  oidc:
    issuer-url: "https://example.okta.com"
    redirect-url: "https://status.example.com/authorization-code/callback"
    client-id: "123456789"
    client-secret: "abcdefghijk"
    scopes: ["openid"]
    # You may optionally specify a list of allowed subjects. If this is not specified, all subjects will be allowed.
    #allowed-subjects: ["[email protected]"]
    # You may optionally specify a session time-to-live. If this is not specified, defaults to 8 hours.
    #session-ttl: 8h

Confused? Read Securing Gatus with OIDC using Auth0.

TLS Encryption

Gatus supports basic encryption with TLS. To enable this, certificate files in PEM format have to be provided.

The example below shows an example configuration which makes gatus respond on port 4443 to HTTPS requests:

web:
  port: 4443
  tls:
    certificate-file: "certificate.crt"
    private-key-file: "private.key"

Metrics

To enable metrics, you must set metrics to true. Doing so will expose Prometheus-friendly metrics at the /metrics endpoint on the same port your application is configured to run on (web.port).

See examples/docker-compose-grafana-prometheus for further documentation as well as an example.

Custom Labels

You can add custom labels to your endpoints’ Prometheus metrics by defining key–value pairs under the extra-labels field. For example:

endpoints:
  - name: front-end
    group: core
    url: "https://twin.sh/health"
    interval: 5m
    conditions:
      - "[STATUS] == 200"
      - "[BODY].status == UP"
      - "[RESPONSE_TIME] < 150"
    extra-labels:
      environment: staging

Connectivity

While Gatus is used to monitor other services, it is possible for Gatus itself to lose connectivity to the internet. In order to prevent Gatus from reporting endpoints as unhealthy when Gatus itself is unhealthy, you may configure Gatus to periodically check for internet connectivity.

All endpoint executions are skipped while the connectivity checker deems connectivity to be down.

connectivity:
  checker:
    target: 1.1.1.1:53
    interval: 60s

Remote instances (EXPERIMENTAL)

This feature allows you to retrieve endpoint statuses from a remote Gatus instance.

There are two main use cases for this:

• You have multiple Gatus instances running on different machines, and you wish to visually expose the statuses through a single dashboard
• You have one or more Gatus instances that are not publicly accessible (e.g. behind a firewall), and you wish to retrieve

This is an experimental feature. It may be removed or updated in a breaking manner at any time. Furthermore, there are known issues with this feature. If you'd like to provide some feedback, please write a comment in #64. Use at your own risk.

remote:
  instances:
    - endpoint-prefix: "status.example.org-"
      url: "https://status.example.org/api/v1/endpoints/statuses"

Deployment

Many examples can be found in the .examples folder, but this section will focus on the most popular ways of deploying Gatus.

Docker

To run Gatus locally with Docker:

docker run -p 8080:8080 --name gatus ghcr.io/twin/gatus:stable

Other than using one of the examples provided in the .examples folder, you can also try it out locally by creating a configuration file, we'll call it config.yaml for this example, and running the following command:

docker run -p 8080:8080 --mount type=bind,source="$(pwd)"/config.yaml,target=/config/config.yaml --name gatus ghcr.io/twin/gatus:stable

If you're on Windows, replace "$(pwd)" by the absolute path to your current directory, e.g.:

docker run -p 8080:8080 --mount type=bind,source=C:/Users/Chris/Desktop/config.yaml,target=/config/config.yaml --name gatus ghcr.io/twin/gatus:stable

To build the image locally:

docker build . -t ghcr.io/twin/gatus:stable

Helm Chart

Helm must be installed to use the chart. Please refer to Helm's documentation to get started.

Once Helm is set up properly, add the repository as follows:

helm repo add twin https://twin.github.io/helm-charts
helm repo update
helm install gatus twin/gatus

To get more details, please check chart's configuration.

Terraform

Kubernetes

Gatus can be deployed on Kubernetes using Terraform by using the following module: terraform-kubernetes-gatus.

Running the tests

go test -v ./...

Using in Production

See the Deployment section.

FAQ

Sending a GraphQL request

By setting endpoints[].graphql to true, the body will automatically be wrapped by the standard GraphQL query parameter.

For instance, the following configuration:

endpoints:
  - name: filter-users-by-gender
    url: http://localhost:8080/playground
    method: POST
    graphql: true
    body: |
      {
        users(gender: "female") {
          id
          name
          gender
          avatar
        }
      }
    conditions:
      - "[STATUS] == 200"
      - "[BODY].data.users[0].gender == female"

will send a POST request to http://localhost:8080/playground with the following body:

{"query":"      {\n        users(gender: \"female\") {\n          id\n          name\n          gender\n          avatar\n        }\n      }"}

Recommended interval

To ensure that Gatus provides reliable and accurate results (i.e. response time), Gatus limits the number of endpoints/suites that can be evaluated at the same time. In other words, even if you have multiple endpoints with the same interval, they are not guaranteed to run at the same time.

The number of concurrent evaluations is determined by the concurrency configuration parameter, which defaults to 3.

You can test this yourself by running Gatus with several endpoints configured with a very short, unrealistic interval, such as 1ms. You'll notice that the response time does not fluctuate - that is because while endpoints are evaluated on different goroutines, there's a semaphore that controls how many endpoints/suites from running at the same time.

Unfortunately, there is a drawback. If you have a lot of endpoints, including some that are very slow or prone to timing out (the default timeout is 10s), those slow evaluations may prevent other endpoints/suites from being evaluated.

The interval does not include the duration of the request itself, which means that if an endpoint has an interval of 30s and the request takes 2s to complete, the timestamp between two evaluations will be 32s, not 30s.

While this does not prevent Gatus' from performing health checks on all other endpoints, it may cause Gatus to be unable to respect the configured interval, for instance, assuming concurrency is set to 1:

• Endpoint A has an interval of 5s, and times out after 10s to complete
• Endpoint B has an interval of 5s, and takes 1ms to complete
• Endpoint B will be unable to run every 5s, because endpoint A's health evaluation takes longer than its interval

To sum it up, while Gatus can handle any interval you throw at it, you're better off having slow requests with higher interval.

As a rule of thumb, I personally set the interval for more complex health checks to 5m (5 minutes) and simple health checks used for alerting (PagerDuty/Twilio) to 30s.

Default timeouts

To modify the timeout, see Client configuration.

Monitoring a TCP endpoint

By prefixing endpoints[].url with tcp://, you can monitor TCP endpoints at a very basic level:

endpoints:
  - name: redis
    url: "tcp://127.0.0.1:6379"
    interval: 30s
    conditions:
      - "[CONNECTED] == true"

If endpoints[].body is set then it is sent and the first 1024 bytes of the response will be in [BODY].

Placeholder [STATUS] as well as the fields endpoints[].headers, endpoints[].method and endpoints[].graphql are not supported for TCP endpoints.

This works for applications such as databases (Postgres, MySQL, etc.) and caches (Redis, Memcached, etc.).

📝 [CONNECTED] == true does not guarantee that the endpoint itself is healthy - it only guarantees that there's something at the given address listening to the given port, and that a connection to that address was successfully established.

Monitoring a UDP endpoint

By prefixing endpoints[].url with udp://, you can monitor UDP endpoints at a very basic level:

endpoints:
  - name: example
    url: "udp://example.org:80"
    conditions:
      - "[CONNECTED] == true"

If endpoints[].body is set then it is sent and the first 1024 bytes of the response will be in [BODY].

Placeholder [STATUS] as well as the fields endpoints[].headers, endpoints[].method and endpoints[].graphql are not supported for UDP endpoints.

This works for UDP based application.

Monitoring a SCTP endpoint

By prefixing endpoints[].url with sctp://, you can monitor Stream Control Transmission Protocol (SCTP) endpoints at a very basic level:

endpoints:
  - name: example
    url: "sctp://127.0.0.1:38412"
    conditions:
      - "[CONNECTED] == true"

Placeholders [STATUS] and [BODY] as well as the fields endpoints[].body, endpoints[].headers, endpoints[].method and endpoints[].graphql are not supported for SCTP endpoints.

This works for SCTP based application.

Monitoring a WebSocket endpoint

By prefixing endpoints[].url with ws:// or wss://, you can monitor WebSocket endpoints:

endpoints:
  - name: example
    url: "wss://echo.websocket.org/"
    body: "status"
    conditions:
      - "[CONNECTED] == true"
      - "[BODY] == pat(*served by*)"

The [BODY] placeholder contains the output of the query, and [CONNECTED] shows whether the connection was successfully established. You can use Go template syntax.

Monitoring an endpoint using gRPC

You can monitor gRPC services by prefixing endpoints[].url with grpc:// or grpcs://. Gatus executes the standard grpc.health.v1.Health/Check RPC against the target.

endpoints:
  - name: my-grpc
    url: grpc://localhost:50051
    interval: 30s
    conditions:
      - "[CONNECTED] == true"
      - "[BODY].status == SERVING"  # BODY is read only when referenced
    client:
      timeout: 5s

For TLS-enabled servers, use grpcs:// and configure client TLS if necessary:

endpoints:
  - name: my-grpcs
    url: grpcs://example.com:443
    conditions:
      - "[CONNECTED] == true"
      - "[BODY].status == SERVING"
    client:
      timeout: 5s
      insecure: false          # set true to skip cert verification (not recommended)
      tls:
        certificate-file: /path/to/cert.pem      # optional mTLS client cert
        private-key-file: /path/to/key.pem       # optional mTLS client key

Notes:

• The health check targets the default service (service: ""). Support for a custom service name can be added later if needed.
• The response body is exposed as a minimal JSON object like {"status":"SERVING"} only when required by conditions or suite store mappings.
• Timeouts, custom DNS resolvers and SSH tunnels are honored via the existing client configuration.

Monitoring an endpoint using ICMP

By prefixing endpoints[].url with icmp://, you can monitor endpoints at a very basic level using ICMP, or more commonly known as "ping" or "echo":

endpoints:
  - name: ping-example
    url: "icmp://example.com"
    conditions:
      - "[CONNECTED] == true"

Only the placeholders [CONNECTED], [IP] and [RESPONSE_TIME] are supported for endpoints of type ICMP. You can specify a domain prefixed by icmp://, or an IP address prefixed by icmp://.

If you run Gatus on Linux, please read the Linux section on [https://github.com/prometheus-community/pro-bing#linux] if you encounter any problems.

Prior to v5.31.0, some environment setups required adding CAP_NET_RAW capabilities to allow pings to work. As of v5.31.0, this is no longer necessary, and ICMP checks will work with unprivileged pings unless running as root. See #1346 for details.

Monitoring an endpoint using DNS queries

Defining a dns configuration in an endpoint will automatically mark said endpoint as an endpoint of type DNS:

endpoints:
  - name: example-dns-query
    url: "8.8.8.8" # Address of the DNS server to use
    dns:
      query-name: "example.com"
      query-type: "A"
    conditions:
      - "[BODY] == 93.184.215.14"
      - "[DNS_RCODE] == NOERROR"

There are two placeholders that can be used in the conditions for endpoints of type DNS:

• The placeholder [BODY] resolves to the output of the query. For instance, a query of type A would return an IPv4.
• The placeholder [DNS_RCODE] resolves to the name associated to the response code returned by the query, such as NOERROR, FORMERR, SERVFAIL, NXDOMAIN, etc.

Monitoring an endpoint using SSH

You can monitor endpoints using SSH by prefixing endpoints[].url with ssh://:

endpoints:
  # Password-based SSH example
  - name: ssh-example-password
    url: "ssh://example.com:22" # port is optional. Default is 22.
    ssh:
      username: "username"
      password: "password"
    body: |
      {
        "command": "echo '{\"memory\": {\"used\": 512}}'"
      }
    interval: 1m
    conditions:
      - "[CONNECTED] == true"
      - "[STATUS] == 0"
      - "[BODY].memory.used > 500"

  # Key-based SSH example
  - name: ssh-example-key
    url: "ssh://example.com:22" # port is optional. Default is 22.
    ssh:
      username: "username"
      private-key: |
        -----BEGIN RSA PRIVATE KEY-----
        TESTRSAKEY...
        -----END RSA PRIVATE KEY-----
    interval: 1m
    conditions:
      - "[CONNECTED] == true"
      - "[STATUS] == 0"

[!NOTE] When a password is provided, Gatus authenticates using both the password and the keyboard-interactive SSH authentication methods, using whichever the server offers. This means servers with PasswordAuthentication no but KbdInteractiveAuthentication yes (e.g. PAM-based password prompts) are supported, just like with the OpenSSH CLI. Every keyboard-interactive prompt is answered with the configured password, so multi-factor prompts (e.g. OTP) are not supported.

you can also use no authentication to monitor the endpoint by not specifying the username, password and private key fields.

endpoints:
  - name: ssh-example
    url: "ssh://example.com:22" # port is optional. Default is 22.
    ssh:
      username: ""
      password: ""
      private-key: ""

    interval: 1m
    conditions:
      - "[CONNECTED] == true"
      - "[STATUS] == 0"

The following placeholders are supported for endpoints of type SSH:

• [CONNECTED] resolves to true if the SSH connection was successful, false otherwise
• [STATUS] resolves the exit code of the command executed on the remote server (e.g. 0 for success)
• [BODY] resolves to the stdout output of the command executed on the remote server
• [IP] resolves to the IP address of the server
• [RESPONSE_TIME] resolves to the time it took to establish the connection and execute the command

Monitoring an endpoint using STARTTLS

If you have an email server that you want to ensure there are no problems with, monitoring it through STARTTLS will serve as a good initial indicator:

endpoints:
  - name: starttls-smtp-example
    url: "starttls://smtp.gmail.com:587"
    interval: 30m
    client:
      timeout: 5s
    conditions:
      - "[CONNECTED] == true"
      - "[CERTIFICATE_EXPIRATION] > 48h"

Monitoring an endpoint using TLS

Monitoring endpoints using SSL/TLS encryption, such as LDAP over TLS, can help detect certificate expiration:

endpoints:
  - name: tls-ldaps-example
    url: "tls://ldap.example.com:636"
    interval: 30m
    client:
      timeout: 5s
    conditions:
      - "[CONNECTED] == true"
      - "[CERTIFICATE_EXPIRATION] > 48h"

If endpoints[].body is set then it is sent and the first 1024 bytes of the response will be in [BODY].

Placeholder [STATUS] as well as the fields endpoints[].headers, endpoints[].method and endpoints[].graphql are not supported for TLS endpoints.

Monitoring domain expiration

You can monitor the expiration of a domain with all endpoint types except for DNS by using the [DOMAIN_EXPIRATION] placeholder:

endpoints:
  - name: check-domain-and-certificate-expiration
    url: "https://example.org"
    interval: 1h
    conditions:
      - "[DOMAIN_EXPIRATION] > 720h"
      - "[CERTIFICATE_EXPIRATION] > 240h"

⚠ The usage of the [DOMAIN_EXPIRATION] placeholder requires Gatus to use RDAP, or as a fallback, send a request to the official IANA WHOIS service through a library and in some cases, a secondary request to a TLD-specific WHOIS server (e.g. whois.nic.sh). To prevent the WHOIS service from throttling your IP address if you send too many requests, Gatus will prevent you from using the [DOMAIN_EXPIRATION] placeholder on an endpoint with an interval of less than 5m.

Concurrency

By default, Gatus allows up to 3 endpoints/suites to be monitored concurrently. This provides a balance between performance and resource usage while maintaining accurate response time measurements.

You can configure the concurrency level using the concurrency parameter:

# Allow 10 endpoints/suites to be monitored concurrently
concurrency: 10

# Allow unlimited concurrent monitoring
concurrency: 0

# Use default concurrency (3)
# concurrency: 3

Important considerations:

• Higher concurrency can improve monitoring performance when you have many endpoints
• Conditions using the [RESPONSE_TIME] placeholder may be less accurate with very high concurrency due to system resource contention
• Set to 0 for unlimited concurrency (equivalent to the deprecated disable-monitoring-lock: true)

Use cases for higher concurrency:

• You have a large number of endpoints to monitor
• You want to monitor endpoints at very short intervals (< 5s)
• You're using Gatus for load testing scenarios

Legacy configuration: The disable-monitoring-lock parameter is deprecated but still supported for backward compatibility. It's equivalent to setting concurrency: 0.

Reloading configuration on the fly

For the sake of convenience, Gatus automatically reloads the configuration on the fly if the loaded configuration file is updated while Gatus is running.

By default, the application will exit if the updating configuration is invalid, but you can configure Gatus to continue running if the configuration file is updated with an invalid configuration by setting skip-invalid-config-update to true.

Keep in mind that it is in your best interest to ensure the validity of the configuration file after each update you apply to the configuration file while Gatus is running by looking at the log and making sure that you do not see the following message:

The configuration file was updated, but it is not valid. The old configuration will continue being used.

Failure to do so may result in Gatus being unable to start if the application is restarted for whatever reason.

I recommend not setting skip-invalid-config-update to true to avoid a situation like this, but the choice is yours to make.

If you are not using a file storage, updating the configuration while Gatus is running is effectively the same as restarting the application.

📝 Updates may not be detected if the config file is bound instead of the config folder. See #151.

Endpoint groups

Endpoint groups are used for grouping multiple endpoints together on the dashboard.

endpoints:
  - name: frontend
    group: core
    url: "https://example.org/"
    interval: 5m
    conditions:
      - "[STATUS] == 200"

  - name: backend
    group: core
    url: "https://example.org/"
    interval: 5m
    conditions:
      - "[STATUS] == 200"

  - name: monitoring
    group: internal
    url: "https://example.org/"
    interval: 5m
    conditions:
      - "[STATUS] == 200"

  - name: nas
    group: internal
    url: "https://example.org/"
    interval: 5m
    conditions:
      - "[STATUS] == 200"

  - name: random endpoint that is not part of a group
    url: "https://example.org/"
    interval: 5m
    conditions:
      - "[STATUS] == 200"

The configuration above will result in a dashboard that looks like this when sorting by group:

How do I sort by group by default?

Set ui.default-sort-by to group in the configuration file:

ui:
  default-sort-by: group

Note that if a user has already sorted the dashboard by a different field, the default sort will not be applied unless the user clears their browser's localstorage.

Exposing Gatus on a custom path

Currently, you can expose the Gatus UI using a fully qualified domain name (FQDN) such as status.example.org. However, it does not support path-based routing, which means you cannot expose it through a URL like example.org/status/.

For more information, see https://github.com/TwiN/gatus/issues/88.

Exposing Gatus on a custom port

By default, Gatus is exposed on port 8080, but you may specify a different port by setting the web.port parameter:

web:
  port: 8081

If you're using a PaaS like Heroku that doesn't let you set a custom port and exposes it through an environment variable instead see Use environment variables in config files.

Use environment variables in config files

You can use environment variables directly in the configuration file which will be substituted from the environment:

web:
  port: ${PORT}

ui:
  title: $TITLE

⚠️ When your configuration parameter contains a $ symbol, you have to escape $ with $$.

Configuring a startup delay

If, for any reason, you need Gatus to wait for a given amount of time before monitoring the endpoints on application start, you can use the GATUS_DELAY_START_SECONDS environment variable to make Gatus sleep on startup.

Keeping your configuration small

While not specific to Gatus, you can leverage YAML anchors to create a default configuration. If you have a large configuration file, this should help you keep things clean.

default-endpoint: &defaults
  group: core
  interval: 5m
  client:
    insecure: true
    timeout: 30s
  conditions:
    - "[STATUS] == 200"

endpoints:
  - name: anchor-example-1
    <<: *defaults               # This will merge the configuration under &defaults with this endpoint
    url: "https://example.org"

  - name: anchor-example-2
    <<: *defaults
    group: example              # This will override the group defined in &defaults
    url: "https://example.com"

  - name: anchor-example-3
    <<: *defaults
    url: "https://twin.sh/health"
    conditions:                # This will override the conditions defined in &defaults
      - "[STATUS] == 200"
      - "[BODY].status == UP"

Proxy client configuration

You can configure a proxy for the client to use by setting the proxy-url parameter in the client configuration.

endpoints:
  - name: website
    url: "https://twin.sh/health"
    client:
      proxy-url: http://proxy.example.com:8080
    conditions:
      - "[STATUS] == 200"

How to fix 431 Request Header Fields Too Large error

Depending on where your environment is deployed and what kind of middleware or reverse proxy sits in front of Gatus, you may run into this issue. This could be because the request headers are too large, e.g. big cookies.

By default, web.read-buffer-size is set to 8192, but increasing this value like so will increase the read buffer size:

web:
  read-buffer-size: 32768

Badges

Uptime

Gatus can automatically generate an SVG badge for one of your monitored endpoints. This allows you to put badges in your individual applications' README or even create your own status page if you desire.

The path to generate a badge is the following:

/api/v1/endpoints/{key}/uptimes/{duration}/badge.svg

Where:

• {duration} is 30d, 7d, 24h or 1h
• {key} has the pattern <GROUP_NAME>_<ENDPOINT_NAME> in which both variables have , /, _, ,, ., #, + and & replaced by -.

For instance, if you want the uptime during the last 24 hours from the endpoint frontend in the group core, the URL would look like this:

https://example.com/api/v1/endpoints/core_frontend/uptimes/7d/badge.svg

If you want to display an endpoint that is not part of a group, you must leave the group value empty:

https://example.com/api/v1/endpoints/_frontend/uptimes/7d/badge.svg

Example:

![Uptime 24h](https://status.twin.sh/api/v1/endpoints/core_blog-external/uptimes/24h/badge.svg)

If you'd like to see a visual example of each badge available, you can simply navigate to the endpoint's detail page.

Health

The path to generate a badge is the following:

/api/v1/endpoints/{key}/health/badge.svg

Where:

• {key} has the pattern <GROUP_NAME>_<ENDPOINT_NAME> in which both variables have , /, _, ,, ., #, + and & replaced by -.

For instance, if you want the current status of the endpoint frontend in the group core, the URL would look like this:

https://example.com/api/v1/endpoints/core_frontend/health/badge.svg

Health (Shields.io)

The path to generate a badge is the following:

/api/v1/endpoints/{key}/health/badge.shields

Where:

• {key} has the pattern <GROUP_NAME>_<ENDPOINT_NAME> in which both variables have , /, _, ,, ., #, + and & replaced by -.

For instance, if you want the current status of the endpoint frontend in the group core, the URL would look like this:

https://example.com/api/v1/endpoints/core_frontend/health/badge.shields

See more information about the Shields.io badge endpoint here.

Response time

The endpoint to generate a badge is the following:

/api/v1/endpoints/{key}/response-times/{duration}/badge.svg

Where:

• {duration} is 30d, 7d, 24h or 1h
• {key} has the pattern <GROUP_NAME>_<ENDPOINT_NAME> in which both variables have , /, _, ,, ., #, + and & replaced by -.

Response time (chart)

The endpoint to generate a response time chart is the following:

/api/v1/endpoints/{key}/response-times/{duration}/chart.svg

Where:

• {duration} is 30d, 7d, or 24h
• {key} has the pattern <GROUP_NAME>_<ENDPOINT_NAME> in which both variables have , /, _, ,, ., #, + and & replaced by -.

How to change the color thresholds of the response time badge

To change the response time badges' threshold, a corresponding configuration can be added to an endpoint. The values in the array correspond to the levels [Awesome, Great, Good, Passable, Bad] All five values must be given in milliseconds (ms).

endpoints:
- name: nas
  group: internal
  url: "https://example.org/"
  interval: 5m
  conditions:
    - "[STATUS] == 200"
  ui:
    badge:
      response-time:
        thresholds: [550, 850, 1350, 1650, 1750]

API

Gatus provides a simple read-only API that can be queried in order to programmatically determine endpoint status and history.

All endpoints are available via a GET request to the following endpoint:

/api/v1/endpoints/statuses

Example: https://status.twin.sh/api/v1/endpoints/statuses

Specific endpoints can also be queried by using the following pattern:

/api/v1/endpoints/{group}_{endpoint}/statuses

Example: https://status.twin.sh/api/v1/endpoints/core_blog-home/statuses

Gzip compression will be used if the Accept-Encoding HTTP header contains gzip.

The API will return a JSON payload with the Content-Type response header set to application/json. No such header is required to query the API.

Interacting with the API programmatically

See TwiN/gatus-sdk

Raw Data

Gatus exposes the raw data for one of your monitored endpoints. This allows you to track and aggregate data in your own applications for monitored endpoints. For instance if you want to track uptime for a period longer than 7 days.

Uptime

The path to get raw uptime data for an endpoint is:

/api/v1/endpoints/{key}/uptimes/{duration}

Where:

• {duration} is 30d, 7d, 24h or 1h
• {key} has the pattern <GROUP_NAME>_<ENDPOINT_NAME> in which both variables have , /, _, ,, ., #, + and & replaced by -.

For instance, if you want the raw uptime data for the last 24 hours from the endpoint frontend in the group core, the URL would look like this:

https://example.com/api/v1/endpoints/core_frontend/uptimes/24h

Response Time

The path to get raw response time data for an endpoint is:

/api/v1/endpoints/{key}/response-times/{duration}

Where:

• {duration} is 30d, 7d, 24h or 1h
• {key} has the pattern <GROUP_NAME>_<ENDPOINT_NAME> in which both variables have , /, _, ,, ., #, + and & replaced by -.

For instance, if you want the raw response time data for the last 24 hours from the endpoint frontend in the group core, the URL would look like this:

https://example.com/api/v1/endpoints/core_frontend/response-times/24h

Installing as binary

You can download Gatus as a binary using the following command:

go install github.com/TwiN/gatus/v5@latest

High level design overview