bestofgithub.dev: the best of GitHub, one command away

Parameter	Description	Default
`metrics`	Whether to expose metrics at `/metrics`.	`false`
`storage`	Storage configuration.	`{}`
`alerting`	Alerting configuration.	`{}`
`announcements`	Announcements configuration.	`[]`
`endpoints`	Endpoints configuration.	Required `[]`
`external-endpoints`	External Endpoints configuration.	`[]`
`security`	Security configuration.	`{}`
`concurrency`	Maximum number of endpoints/suites to monitor concurrently. Set to `0` for unlimited. See Concurrency.	`3`
`disable-monitoring-lock`	Whether to disable the monitoring lock. Deprecated: Use `concurrency: 0` instead.	`false`
`skip-invalid-config-update`	Whether to ignore invalid configuration update. See Reloading configuration on the fly.	`false`
`web`	Web configuration.	`{}`
`ui`	UI configuration.	`{}`
`maintenance`	Maintenance configuration.	`{}`

Parameter	Description	Default
`endpoints`	List of endpoints to monitor.	Required `[]`
`endpoints[].enabled`	Whether to monitor the endpoint.	`true`
`endpoints[].name`	Name of the endpoint. Can be anything.	Required `""`
`endpoints[].group`	Group name. Used to group multiple endpoints together on the dashboard. See Endpoint groups.	`""`
`endpoints[].url`	URL to send the request to.	Required `""`
`endpoints[].method`	Request method.	`GET`
`endpoints[].conditions`	Conditions used to determine the health of the endpoint. See Conditions.	`[]`
`endpoints[].interval`	Duration to wait between every status check.	`60s`
`endpoints[].graphql`	Whether to wrap the body in a query param (`{"query":"$body"}`).	`false`
`endpoints[].body`	Request body.	`""`
`endpoints[].headers`	Request headers.	`{}`
`endpoints[].dns`	Configuration for an endpoint of type DNS. See Monitoring an endpoint using DNS queries.	`""`
`endpoints[].dns.query-type`	Query type (e.g. MX).	`""`
`endpoints[].dns.query-name`	Query name (e.g. example.com).	`""`
`endpoints[].ssh`	Configuration for an endpoint of type SSH. See Monitoring an endpoint using SSH.	`""`
`endpoints[].ssh.username`	SSH username (e.g. example).	Required `""`
`endpoints[].ssh.password`	SSH password (e.g. password).	Required `""`
`endpoints[].alerts`	List of all alerts for a given endpoint. See Alerting.	`[]`
`endpoints[].maintenance-windows`	List of all maintenance windows for a given endpoint. See Maintenance.	`[]`
`endpoints[].client`	Client configuration.	`{}`
`endpoints[].ui`	UI configuration at the endpoint level.	`{}`
`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`
`endpoints[].ui.hide-hostname`	Whether to hide the hostname from the results.	`false`
`endpoints[].ui.hide-port`	Whether to hide the port from the results.	`false`
`endpoints[].ui.hide-url`	Whether to hide the URL from the results. Useful if the URL contains a token.	`false`
`endpoints[].ui.hide-errors`	Whether to hide errors from the results.	`false`
`endpoints[].ui.dont-resolve-failed-conditions`	Whether to resolve failed conditions for the UI.	`false`
`endpoints[].ui.resolve-successful-conditions`	Whether to resolve successful conditions for the UI (helpful to expose body assertions even when checks pass).	`false`
`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]`
`endpoints[].extra-labels`	Extra labels to add to the metrics. Useful for grouping endpoints together.	`{}`
`endpoints[].always-run`	(SUITES ONLY) Whether to execute this endpoint even if previous endpoints in the suite failed.	`false`
`endpoints[].store`	(SUITES ONLY) Map of values to extract from the response and store in the suite context (stored even on failure).	`{}`

Parameter	Description	Default
`external-endpoints`	List of endpoints to monitor.	`[]`
`external-endpoints[].enabled`	Whether to monitor the endpoint.	`true`
`external-endpoints[].name`	Name of the endpoint. Can be anything.	Required `""`
`external-endpoints[].group`	Group name. Used to group multiple endpoints together on the dashboard. See Endpoint groups.	`""`
`external-endpoints[].token`	Bearer token required to push status to.	Required `""`
`external-endpoints[].alerts`	List of all alerts for a given endpoint. See Alerting.	`[]`
`external-endpoints[].heartbeat`	Heartbeat configuration for monitoring when the external endpoint stops sending updates.	`{}`
`external-endpoints[].heartbeat.interval`	Expected interval between updates. If no update is received within this interval, alerts will be triggered. Must be at least 10s.	`0` (disabled)

Parameter	Description	Default
`suites`	List of suites to monitor.	`[]`
`suites[].enabled`	Whether to monitor the suite.	`true`
`suites[].name`	Name of the suite. Must be unique.	Required `""`
`suites[].group`	Group name. Used to group multiple suites together on the dashboard.	`""`
`suites[].interval`	Duration to wait between suite executions.	`10m`
`suites[].timeout`	Maximum duration for the entire suite execution.	`5m`
`suites[].context`	Initial context values that can be referenced by endpoints.	`{}`
`suites[].endpoints`	List of endpoints to execute sequentially.	Required `[]`
`suites[].endpoints[].store`	Map of values to extract from the response and store in the suite context (stored even on failure).	`{}`
`suites[].endpoints[].always-run`	Whether to execute this endpoint even if previous endpoints in the suite failed.	`false`

Condition	Description	Passing values	Failing values
`[STATUS] == 200`	Status must be equal to 200	200	201, 404, ...
`[STATUS] < 300`	Status must lower than 300	200, 201, 299	301, 302, ...
`[STATUS] <= 299`	Status must be less than or equal to 299	200, 201, 299	301, 302, ...
`[STATUS] > 400`	Status must be greater than 400	401, 402, 403, 404	400, 200, ...
`[STATUS] == any(200, 429)`	Status must be either 200 or 429	200, 429	201, 400, ...
`[CONNECTED] == true`	Connection to host must've been successful	true	false
`[RESPONSE_TIME] < 500`	Response time must be below 500ms	100ms, 200ms, 300ms	500ms, 501ms
`[IP] == 127.0.0.1`	Target IP must be 127.0.0.1	127.0.0.1	0.0.0.0
`[BODY] == 1`	The body must be equal to 1	1	`{}`, `2`, ...
`[BODY].user.name == john`	JSONPath value of `$.user.name` is equal to `john`	`{"user":{"name":"john"}}`
`[BODY].data[0].id == 1`	JSONPath value of `$.data[0].id` is equal to 1	`{"data":[{"id":1}]}`
`[BODY]["a.b"] == ok`	JSONPath value of `$["a.b"]` is equal to `ok`	`{"a.b":"ok"}`
`[BODY].age == [BODY].id`	JSONPath value of `$.age` is equal JSONPath `$.id`	`{"age":1,"id":1}`
`len([BODY].data) < 5`	Array at JSONPath `$.data` has less than 5 elements	`{"data":[{"id":1}]}`
`len([BODY].name) == 8`	String at JSONPath `$.name` has a length of 8	`{"name":"john.doe"}`	`{"name":"bob"}`
`has([BODY].errors) == false`	JSONPath `$.errors` does not exist	`{"name":"john.doe"}`	`{"errors":[]}`
`has([BODY].users) == true`	JSONPath `$.users` exists	`{"users":[]}`	`{}`
`[BODY].name == pat(john*)`	String at JSONPath `$.name` matches pattern `john*`	`{"name":"john.doe"}`	`{"name":"bob"}`
`[BODY].id == any(1, 2)`	Value at JSONPath `$.id` is equal to `1` or `2`	1, 2	3, 4, 5
`[CERTIFICATE_EXPIRATION] > 48h`	Certificate expiration is more than 48h away	49h, 50h, 123h	1h, 24h, ...
`[DOMAIN_EXPIRATION] > 720h`	The domain must expire in more than 720h	4000h	1h, 24h, ...

Placeholder	Description	Example of resolved value
`[STATUS]`	Resolves into the HTTP status of the request	`404`
`[RESPONSE_TIME]`	Resolves into the response time the request took, in ms	`10`
`[IP]`	Resolves into the IP of the target host	`192.168.0.232`
`[BODY]`	Resolves into the response body. Supports JSONPath.	`{"name":"john.doe"}`
`[CONNECTED]`	Resolves into whether a connection could be established	`true`
`[CERTIFICATE_EXPIRATION]`	Resolves into the duration before certificate expiration (valid units are "s", "m", "h".)	`24h`, `48h`, 0 (if not protocol with certs)
`[DOMAIN_EXPIRATION]`	Resolves into the duration before the domain expires (valid units are "s", "m", "h".)	`24h`, `48h`, `1234h56m78s`
`[DNS_RCODE]`	Resolves into the DNS status of the response	`NOERROR`

Function	Description	Example
`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) > 8`
`has`	Returns `true` or `false` based on whether a given path is valid. Works only with the `[BODY]` placeholder.	`has([BODY].errors) == false`
`pat`	Specifies that the string passed as parameter should be evaluated as a pattern. Works only with `==` and `!=`.	`[IP] == pat(192.168.*)`
`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)`

Parameter	Description	Default
`web`	Web configuration	`{}`
`web.address`	Address to listen on.	`0.0.0.0`
`web.port`	Port to listen on.	`8080`
`web.read-buffer-size`	Buffer size for reading requests from a connection. Also limit for the maximum header size.	`8192`
`web.tls.certificate-file`	Optional public certificate file for TLS in PEM format.	`""`
`web.tls.private-key-file`	Optional private key file for TLS in PEM format.	`""`

Parameter	Description	Default
`ui`	UI configuration	`{}`
`ui.title`	Title of the document.	`Health Dashboard ǀ Gatus`
`ui.description`	Meta description for the page.	`Gatus is an advanced...`.
`ui.dashboard-heading`	Dashboard title between header and endpoints	`Health Dashboard`
`ui.dashboard-subheading`	Dashboard description between header and endpoints	`Monitor the health of your endpoints in real-time`
`ui.header`	Header at the top of the dashboard. Also used as the title on the OIDC login page.	`Gatus`
`ui.logo`	URL to the logo to display. When set, shown alongside the Gatus logo on the OIDC login page.	`""`
`ui.link`	Link to open when the logo is clicked.	`""`
`ui.favicon.default`	Favourite default icon to display in web browser tab or address bar.	`/favicon.ico`
`ui.favicon.size16x16`	Favourite icon to display in web browser for 16x16 size.	`/favicon-16x16.png`
`ui.favicon.size32x32`	Favourite icon to display in web browser for 32x32 size.	`/favicon-32x32.png`
`ui.buttons`	List of buttons to display below the header.	`[]`
`ui.buttons[].name`	Text to display on the button.	Required `""`
`ui.buttons[].link`	Link to open when the button is clicked.	Required `""`
`ui.custom-css`	Custom CSS	`""`
`ui.dark-mode`	Whether to enable dark mode by default. Note that this is superseded by the user's operating system theme preferences.	`true`
`ui.default-sort-by`	Default sorting option for endpoints in the dashboard. Can be `name`, `group`, or `health`. Note that user preferences override this.	`name`
`ui.default-filter-by`	Default filter option for endpoints in the dashboard. Can be `none`, `failing`, or `unstable`. Note that user preferences override this.	`none`
`ui.login-subtitle`	Subtitle displayed on the OIDC login page.	`System Monitoring Dashboard`

Parameter	Description	Default
`announcements`	List of announcements to display	`[]`
`announcements[].timestamp`	UTC timestamp when the announcement was made (RFC3339 format)	Required
`announcements[].type`	Type of announcement. Valid values: `outage`, `warning`, `information`, `operational`, `none`	`"none"`
`announcements[].message`	The message to display to users	Required
`announcements[].archived`	Whether to archive the announcement. Archived announcements show at the bottom of the status page instead of at the top.	`false`

Parameter	Description	Default
`storage`	Storage configuration	`{}`
`storage.path`	Path to persist the data in. Only supported for types `sqlite` and `postgres`.	`""`
`storage.type`	Type of storage. Valid types: `memory`, `sqlite`, `postgres`.	`"memory"`
`storage.caching`	Whether to use write-through caching. Improves loading time for large dashboards. Only supported if `storage.type` is `sqlite` or `postgres`	`false`
`storage.maximum-number-of-results`	The maximum number of results that an endpoint can have	`100`
`storage.maximum-number-of-events`	The maximum number of events that an endpoint can have	`50`

Parameter	Description	Default
`client.insecure`	Whether to skip verifying the server's certificate chain and host name.	`false`
`client.ignore-redirect`	Whether to ignore redirects (true) or follow them (false, default).	`false`
`client.timeout`	Duration before timing out.	`10s`
`client.dns-resolver`	Override the DNS resolver using the format `{proto}://{host}:{port}`.	`""`
`client.oauth2`	OAuth2 client configuration.	`{}`
`client.oauth2.token-url`	The token endpoint URL	required `""`
`client.oauth2.client-id`	The client id which should be used for the `Client credentials flow`	required `""`
`client.oauth2.client-secret`	The client secret which should be used for the `Client credentials flow`	required `""`
`client.oauth2.scopes[]`	A list of `scopes` which should be used for the `Client credentials flow`.	required `[""]`
`client.proxy-url`	The URL of the proxy to use for the client	`""`
`client.identity-aware-proxy`	Google Identity-Aware-Proxy client configuration.	`{}`
`client.identity-aware-proxy.audience`	The Identity-Aware-Proxy audience. (client-id of the IAP oauth2 credential)	required `""`
`client.tls.certificate-file`	Path to a client certificate (in PEM format) for mTLS configurations.	`""`
`client.tls.private-key-file`	Path to a client private key (in PEM format) for mTLS configurations.	`""`
`client.tls.renegotiation`	Type of renegotiation support to provide. (`never`, `freely`, `once`).	`"never"`
`client.network`	The network to use for ICMP endpoint client (`ip`, `ip4` or `ip6`).	`"ip"`
`client.tunnel`	Name of the SSH tunnel to use for this endpoint. See Tunneling.	`""`
`client.store-cookies`	Whether to store cookies between requests.	`false`

Parameter	Description	Default
`tunneling`	SSH tunnel configurations	`{}`
`tunneling.<tunnel-name>`	Configuration for a named SSH tunnel	`{}`
`tunneling.<tunnel-name>.type`	Type of tunnel (currently only `SSH` is supported)	Required `""`
`tunneling.<tunnel-name>.host`	SSH server hostname or IP address	Required `""`
`tunneling.<tunnel-name>.port`	SSH server port	`22`
`tunneling.<tunnel-name>.username`	SSH username	Required `""`
`tunneling.<tunnel-name>.password`	SSH password (use either this or private-key)	`""`
`tunneling.<tunnel-name>.private-key`	SSH private key in PEM format (use either this or password)	`""`
`client.tunnel`	Name of the tunnel to use for this endpoint	`""`

Parameter	Description	Default
`alerts`	List of all alerts for a given endpoint.	`[]`
`alerts[].type`	Type of alert. See table below for all valid types.	Required `""`
`alerts[].enabled`	Whether to enable the alert.	`true`
`alerts[].failure-threshold`	Number of failures in a row needed before triggering the alert.	`3`
`alerts[].success-threshold`	Number of successes in a row before an ongoing incident is marked as resolved.	`2`
`alerts[].minimum-reminder-interval`	Minimum time interval between alert reminders. E.g. `"30m"`, `"1h45m30s"` or `"24h"`. If empty or `0`, reminders are disabled. Cannot be lower than `5m`.	`0`
`alerts[].send-on-resolved`	Whether to send a notification once a triggered alert is marked as resolved.	`false`
`alerts[].description`	Description of the alert. Will be included in the alert sent.	`""`
`alerts[].provider-override`	Alerting provider configuration override for the given alert type	`{}`

Parameter	Description	Default
`alerting.awsses`	Configuration for alerts of type `awsses`. See Configuring AWS SES alerts.	`{}`
`alerting.clickup`	Configuration for alerts of type `clickup`. See Configuring ClickUp alerts.	`{}`
`alerting.custom`	Configuration for custom actions on failure or alerts. See Configuring Custom alerts.	`{}`
`alerting.datadog`	Configuration for alerts of type `datadog`. See Configuring Datadog alerts.	`{}`
`alerting.discord`	Configuration for alerts of type `discord`. See Configuring Discord alerts.	`{}`
`alerting.email`	Configuration for alerts of type `email`. See Configuring Email alerts.	`{}`
`alerting.gitea`	Configuration for alerts of type `gitea`. See Configuring Gitea alerts.	`{}`
`alerting.github`	Configuration for alerts of type `github`. See Configuring GitHub alerts.	`{}`
`alerting.gitlab`	Configuration for alerts of type `gitlab`. See Configuring GitLab alerts.	`{}`
`alerting.googlechat`	Configuration for alerts of type `googlechat`. See Configuring Google Chat alerts.	`{}`
`alerting.gotify`	Configuration for alerts of type `gotify`. See Configuring Gotify alerts.	`{}`
`alerting.homeassistant`	Configuration for alerts of type `homeassistant`. See Configuring HomeAssistant alerts.	`{}`
`alerting.ifttt`	Configuration for alerts of type `ifttt`. See Configuring IFTTT alerts.	`{}`
`alerting.ilert`	Configuration for alerts of type `ilert`. See Configuring ilert alerts.	`{}`
`alerting.incident-io`	Configuration for alerts of type `incident-io`. See Configuring Incident.io alerts.	`{}`
`alerting.line`	Configuration for alerts of type `line`. See Configuring Line alerts.	`{}`
`alerting.matrix`	Configuration for alerts of type `matrix`. See Configuring Matrix alerts.	`{}`
`alerting.mattermost`	Configuration for alerts of type `mattermost`. See Configuring Mattermost alerts.	`{}`
`alerting.messagebird`	Configuration for alerts of type `messagebird`. See Configuring Messagebird alerts.	`{}`
`alerting.n8n`	Configuration for alerts of type `n8n`. See Configuring n8n alerts.	`{}`
`alerting.newrelic`	Configuration for alerts of type `newrelic`. See Configuring New Relic alerts.	`{}`
`alerting.ntfy`	Configuration for alerts of type `ntfy`. See Configuring Ntfy alerts.	`{}`
`alerting.opsgenie`	Configuration for alerts of type `opsgenie`. See Configuring Opsgenie alerts.	`{}`
`alerting.pagerduty`	Configuration for alerts of type `pagerduty`. See Configuring PagerDuty alerts.	`{}`
`alerting.plivo`	Configuration for alerts of type `plivo`. See Configuring Plivo alerts.	`{}`
`alerting.pushover`	Configuration for alerts of type `pushover`. See Configuring Pushover alerts.	`{}`
`alerting.resend`	Configuration for alerts of type `resend`. See Configuring Resend alerts.	`{}`
`alerting.rocketchat`	Configuration for alerts of type `rocketchat`. See Configuring Rocket.Chat alerts.	`{}`
`alerting.sendgrid`	Configuration for alerts of type `sendgrid`. See Configuring SendGrid alerts.	`{}`
`alerting.signal`	Configuration for alerts of type `signal`. See Configuring Signal alerts.	`{}`
`alerting.signl4`	Configuration for alerts of type `signl4`. See Configuring SIGNL4 alerts.	`{}`
`alerting.slack`	Configuration for alerts of type `slack`. See Configuring Slack alerts.	`{}`
`alerting.splunk`	Configuration for alerts of type `splunk`. See Configuring Splunk alerts.	`{}`
`alerting.squadcast`	Configuration for alerts of type `squadcast`. See Configuring Squadcast alerts.	`{}`
`alerting.teams`	Configuration for alerts of type `teams`. (Deprecated) See Configuring Teams alerts.	`{}`
`alerting.teams-workflows`	Configuration for alerts of type `teams-workflows`. See Configuring Teams Workflow alerts.	`{}`
`alerting.telegram`	Configuration for alerts of type `telegram`. See Configuring Telegram alerts.	`{}`
`alerting.twilio`	Settings for alerts of type `twilio`. See Configuring Twilio alerts.	`{}`
`alerting.vonage`	Configuration for alerts of type `vonage`. See Configuring Vonage alerts.	`{}`
`alerting.webex`	Configuration for alerts of type `webex`. See Configuring Webex alerts.	`{}`
`alerting.zapier`	Configuration for alerts of type `zapier`. See Configuring Zapier alerts.	`{}`
`alerting.zulip`	Configuration for alerts of type `zulip`. See Configuring Zulip alerts.	`{}`

Parameter	Description	Default
`alerting.aws-ses`	Settings for alerts of type `aws-ses`	`{}`
`alerting.aws-ses.access-key-id`	AWS Access Key ID	Optional `""`
`alerting.aws-ses.secret-access-key`	AWS Secret Access Key	Optional `""`
`alerting.aws-ses.region`	AWS Region	Required `""`
`alerting.aws-ses.from`	The Email address to send the emails from (should be registered in SES)	Required `""`
`alerting.aws-ses.to`	Comma separated list of email address to notify	Required `""`
`alerting.aws-ses.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.aws-ses.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.aws-ses.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.aws-ses.overrides[].*`	See `alerting.aws-ses.*` parameters	`{}`

Parameter	Description	Default
`alerting.clickup`	Configuration for alerts of type `clickup`	`{}`
`alerting.clickup.list-id`	ClickUp List ID where tasks will be created	Required `""`
`alerting.clickup.token`	ClickUp API token	Required `""`
`alerting.clickup.api-url`	Custom API URL	`https://api.clickup.com/api/v2`
`alerting.clickup.assignees`	List of user IDs to assign tasks to	`[]`
`alerting.clickup.status`	Initial status for created tasks	`""`
`alerting.clickup.priority`	Priority level: `urgent`, `high`, `normal`, `low`, or `none`	`normal`
`alerting.clickup.notify-all`	Whether to notify all assignees when task is created	`true`
`alerting.clickup.name`	Custom task name template (supports placeholders)	`Health Check: [ENDPOINT_GROUP]:[ENDPOINT_NAME]`
`alerting.clickup.content`	Custom task content template (supports placeholders)	`Triggered: [ENDPOINT_GROUP] - [ENDPOINT_NAME] - [ALERT_DESCRIPTION] - [RESULT_ERRORS]`
`alerting.clickup.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.clickup.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.clickup.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.clickup.overrides[].*`	See `alerting.clickup.*` parameters	`{}`

Parameter	Description	Default
`alerting.datadog`	Configuration for alerts of type `datadog`	`{}`
`alerting.datadog.api-key`	Datadog API key	Required `""`
`alerting.datadog.site`	Datadog site (e.g., datadoghq.com, datadoghq.eu)	`"datadoghq.com"`
`alerting.datadog.tags`	Additional tags to include	`[]`
`alerting.datadog.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.datadog.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.datadog.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.datadog.overrides[].*`	See `alerting.datadog.*` parameters	`{}`

Parameter	Description	Default
`alerting.discord`	Configuration for alerts of type `discord`	`{}`
`alerting.discord.webhook-url`	Discord Webhook URL	Required `""`
`alerting.discord.title`	Title of the notification	`":helmet_with_white_cross: Gatus"`
`alerting.discord.message-content`	Message content to send before the embed (useful for pinging users/roles, e.g. `<@123>`)	`""`
`alerting.discord.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.discord.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.discord.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.discord.overrides[].*`	See `alerting.discord.*` parameters	`{}`

Parameter	Description	Default
`alerting.email`	Configuration for alerts of type `email`	`{}`
`alerting.email.from`	Email used to send the alert	Required `""`
`alerting.email.username`	Username of the SMTP server used to send the alert. If empty, uses `alerting.email.from`.	`""`
`alerting.email.password`	Password of the SMTP server used to send the alert. If empty, no authentication is performed.	`""`
`alerting.email.host`	Host of the mail server (e.g. `smtp.gmail.com`)	Required `""`
`alerting.email.port`	Port the mail server is listening to (e.g. `587`)	Required `0`
`alerting.email.to`	Email(s) to send the alerts to	Required `""`
`alerting.email.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.email.client.insecure`	Whether to skip TLS verification	`false`
`alerting.email.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.email.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.email.overrides[].*`	See `alerting.email.*` parameters	`{}`

Parameter	Description	Default
`alerting.gitea`	Configuration for alerts of type `gitea`	`{}`
`alerting.gitea.repository-url`	Gitea repository URL (e.g. `https://gitea.com/TwiN/example`)	Required `""`
`alerting.gitea.token`	Personal access token to use for authentication. Must have at least RW on issues and RO on metadata.	Required `""`
`alerting.gitea.default-alert`	Default alert configuration. See Setting a default alert.	N/A

Parameter	Description	Default
`alerting.github`	Configuration for alerts of type `github`	`{}`
`alerting.github.repository-url`	GitHub repository URL (e.g. `https://github.com/TwiN/example`)	Required `""`
`alerting.github.token`	Personal access token to use for authentication. Must have at least RW on issues and RO on metadata.	Required `""`
`alerting.github.default-alert`	Default alert configuration. See Setting a default alert.	N/A

Parameter	Description	Default
`alerting.gitlab`	Configuration for alerts of type `gitlab`	`{}`
`alerting.gitlab.webhook-url`	GitLab alert webhook URL (e.g. `https://gitlab.com/yourusername/example/alerts/notify/gatus/xxxxxxxxxxxxxxxx.json`)	Required `""`
`alerting.gitlab.authorization-key`	GitLab alert authorization key.	Required `""`
`alerting.gitlab.severity`	Override default severity (critical), can be one of `critical, high, medium, low, info, unknown`	`""`
`alerting.gitlab.monitoring-tool`	Override the monitoring tool name (gatus)	`"gatus"`
`alerting.gitlab.environment-name`	Set gitlab environment's name. Required to display alerts on a dashboard.	`""`
`alerting.gitlab.service`	Override endpoint display name	`""`
`alerting.gitlab.default-alert`	Default alert configuration. See Setting a default alert.	N/A

Parameter	Description	Default
`alerting.googlechat`	Configuration for alerts of type `googlechat`	`{}`
`alerting.googlechat.webhook-url`	Google Chat Webhook URL	Required `""`
`alerting.googlechat.client`	Client configuration. See Client configuration.	`{}`
`alerting.googlechat.default-alert`	Default alert configuration. See Setting a default alert.	N/A
`alerting.googlechat.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.googlechat.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.googlechat.overrides[].*`	See `alerting.googlechat.*` parameters	`{}`

Parameter	Description	Default
`alerting.gotify`	Configuration for alerts of type `gotify`	`{}`
`alerting.gotify.server-url`	Gotify server URL	Required `""`
`alerting.gotify.token`	Token that is used for authentication.	Required `""`
`alerting.gotify.priority`	Priority of the alert according to Gotify standards.	`5`
`alerting.gotify.title`	Title of the notification	`"Gatus: <endpoint>"`
`alerting.gotify.default-alert`	Default alert configuration. See Setting a default alert.	N/A

Parameter	Description	Default Value
`alerting.homeassistant.url`	HomeAssistant instance URL	Required `""`
`alerting.homeassistant.token`	Long-lived access token from HomeAssistant	Required `""`
`alerting.homeassistant.default-alert`	Default alert configuration to use for endpoints with an alert of the appropriate type	`{}`
`alerting.homeassistant.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.homeassistant.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.homeassistant.overrides[].*`	See `alerting.homeassistant.*` parameters	`{}`

Parameter	Description	Default
`alerting.ifttt`	Configuration for alerts of type `ifttt`	`{}`
`alerting.ifttt.webhook-key`	IFTTT Webhook key	Required `""`
`alerting.ifttt.event-name`	IFTTT event name	Required `""`
`alerting.ifttt.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.ifttt.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.ifttt.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.ifttt.overrides[].*`	See `alerting.ifttt.*` parameters	`{}`

Parameter	Description	Default
`alerting.ilert`	Configuration for alerts of type `ilert`	`{}`
`alerting.ilert.integration-key`	ilert Alert Source integration key	`""`
`alerting.ilert.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.ilert.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.ilert.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.ilert.overrides[].*`	See `alerting.ilert.*` parameters	`{}`

Parameter	Description	Default
`alerting.incident-io`	Configuration for alerts of type `incident-io`	`{}`
`alerting.incident-io.url`	url to trigger an alert event.	Required `""`
`alerting.incident-io.auth-token`	Token that is used for authentication.	Required `""`
`alerting.incident-io.source-url`	Source URL	`""`
`alerting.incident-io.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.incident-io.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.incident-io.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.incident-io.overrides[].*`	See `alerting.incident-io.*` parameters	`{}`

Parameter	Description	Default
`alerting.line`	Configuration for alerts of type `line`	`{}`
`alerting.line.channel-access-token`	Line Messaging API channel access token	Required `""`
`alerting.line.user-ids`	List of Line user IDs to send messages to (this can be user ids, room ids or group ids)	Required `[]`
`alerting.line.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.line.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.line.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.line.overrides[].*`	See `alerting.line.*` parameters	`{}`

Parameter	Description	Default
`alerting.matrix`	Configuration for alerts of type `matrix`	`{}`
`alerting.matrix.server-url`	Homeserver URL	`https://matrix-client.matrix.org`
`alerting.matrix.access-token`	Bot user access token (see https://webapps.stackexchange.com/q/131056)	Required `""`
`alerting.matrix.internal-room-id`	Internal room ID of room to send alerts to (can be found in Room Settings > Advanced)	Required `""`
`alerting.matrix.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.matrix.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.matrix.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.matrix.overrides[].*`	See `alerting.matrix.*` parameters	`{}`

Parameter	Description	Default
`alerting.mattermost`	Configuration for alerts of type `mattermost`	`{}`
`alerting.mattermost.webhook-url`	Mattermost Webhook URL	Required `""`
`alerting.mattermost.channel`	Mattermost channel name override (optional)	`""`
`alerting.mattermost.client`	Client configuration. See Client configuration.	`{}`
`alerting.mattermost.default-alert`	Default alert configuration. See Setting a default alert.	N/A
`alerting.mattermost.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.mattermost.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.mattermost.overrides[].*`	See `alerting.mattermost.*` parameters	`{}`

Parameter	Description	Default
`alerting.messagebird`	Configuration for alerts of type `messagebird`	`{}`
`alerting.messagebird.access-key`	Messagebird access key	Required `""`
`alerting.messagebird.originator`	The sender of the message	Required `""`
`alerting.messagebird.recipients`	The recipients of the message	Required `""`
`alerting.messagebird.default-alert`	Default alert configuration. See Setting a default alert	N/A

Parameter	Description	Default
`alerting.newrelic`	Configuration for alerts of type `newrelic`	`{}`
`alerting.newrelic.api-key`	New Relic API key	Required `""`
`alerting.newrelic.account-id`	New Relic account ID	Required `""`
`alerting.newrelic.region`	Region (US or EU)	`"US"`
`alerting.newrelic.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.newrelic.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.newrelic.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.newrelic.overrides[].*`	See `alerting.newrelic.*` parameters	`{}`

Parameter	Description	Default
`alerting.n8n`	Configuration for alerts of type `n8n`	`{}`
`alerting.n8n.webhook-url`	n8n webhook URL	Required `""`
`alerting.n8n.title`	Title of the alert sent to n8n	`""`
`alerting.n8n.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.n8n.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.n8n.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.n8n.overrides[].*`	See `alerting.n8n.*` parameters	`{}`

Parameter	Description	Default
`alerting.ntfy`	Configuration for alerts of type `ntfy`	`{}`
`alerting.ntfy.topic`	Topic at which the alert will be sent	Required `""`
`alerting.ntfy.url`	The URL of the target server	`https://ntfy.sh`
`alerting.ntfy.token`	Access token for restricted topics	`""`
`alerting.ntfy.email`	E-mail address for additional e-mail notifications	`""`
`alerting.ntfy.click`	Website opened when notification is clicked	`""`
`alerting.ntfy.priority`	The priority of the alert	`3`
`alerting.ntfy.disable-firebase`	Whether message push delivery via firebase should be disabled. ntfy.sh defaults to enabled	`false`
`alerting.ntfy.disable-cache`	Whether server side message caching should be disabled. ntfy.sh defaults to enabled	`false`
`alerting.ntfy.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.ntfy.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.ntfy.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.ntfy.overrides[].*`	See `alerting.ntfy.*` parameters	`{}`

Parameter	Description	Default
`alerting.opsgenie`	Configuration for alerts of type `opsgenie`	`{}`
`alerting.opsgenie.api-key`	Opsgenie API Key	Required `""`
`alerting.opsgenie.priority`	Priority level of the alert.	`P1`
`alerting.opsgenie.source`	Source field of the alert.	`gatus`
`alerting.opsgenie.entity-prefix`	Entity field prefix.	`gatus-`
`alerting.opsgenie.alias-prefix`	Alias field prefix.	`gatus-healthcheck-`
`alerting.opsgenie.tags`	Tags of alert.	`[]`
`alerting.opsgenie.default-alert`	Default alert configuration. See Setting a default alert	N/A

Parameter	Description	Default
`alerting.pagerduty`	Configuration for alerts of type `pagerduty`	`{}`
`alerting.pagerduty.integration-key`	PagerDuty Events API v2 integration key	`""`
`alerting.pagerduty.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.pagerduty.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.pagerduty.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.pagerduty.overrides[].*`	See `alerting.pagerduty.*` parameters	`{}`

Parameter	Description	Default
`alerting.plivo`	Configuration for alerts of type `plivo`	`{}`
`alerting.plivo.auth-id`	Plivo Auth ID	Required `""`
`alerting.plivo.auth-token`	Plivo Auth Token	Required `""`
`alerting.plivo.from`	Phone number to send SMS from	Required `""`
`alerting.plivo.to`	List of phone numbers to send SMS to	Required `[]`
`alerting.plivo.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.plivo.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.plivo.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.plivo.overrides[].*`	See `alerting.plivo.*` parameters	`{}`

Parameter	Description	Default
`alerting.pushover`	Configuration for alerts of type `pushover`	`{}`
`alerting.pushover.application-token`	Pushover application token	`""`
`alerting.pushover.user-key`	User or group key	`""`
`alerting.pushover.title`	Fixed title for all messages sent via Pushover	`"Gatus: <endpoint>"`
`alerting.pushover.priority`	Priority of all messages, ranging from -2 (very low) to 2 (emergency)	`0`
`alerting.pushover.resolved-priority`	Override the priority of messages on resolved, ranging from -2 (very low) to 2 (emergency)	`0`
`alerting.pushover.sound`	Sound of all messages See sounds for all valid choices.	`""`
`alerting.pushover.ttl`	Set the Time-to-live of the message to be automatically deleted from pushover notifications	`0`
`alerting.pushover.device`	Device to send the message to (optional) See devices for details	`""` (all devices)
`alerting.pushover.default-alert`	Default alert configuration. See Setting a default alert	N/A

Parameter	Description	Default
`alerting.resend`	Configuration for alerts of type `resend`	`{}`
`alerting.resend.api-key`	Resend API key	Required `""`
`alerting.resend.from`	Email address to send from (e.g. `alerts@example.com` or `Gatus <alerts@example.com>`)	Required `""`
`alerting.resend.to`	Email address(es) to send alerts to (comma-separated for multiple recipients, up to 50)	Required `""`
`alerting.resend.client`	Client configuration. See Client configuration.	`{}`
`alerting.resend.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.resend.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.resend.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.resend.overrides[].*`	See `alerting.resend.*` parameters	`{}`

Parameter	Description	Default
`alerting.rocketchat`	Configuration for alerts of type `rocketchat`	`{}`
`alerting.rocketchat.webhook-url`	Rocket.Chat incoming webhook URL	Required `""`
`alerting.rocketchat.channel`	Optional channel override	`""`
`alerting.rocketchat.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.rocketchat.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.rocketchat.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.rocketchat.overrides[].*`	See `alerting.rocketchat.*` parameters	`{}`

Parameter	Description	Default
`alerting.sendgrid`	Configuration for alerts of type `sendgrid`	`{}`
`alerting.sendgrid.api-key`	SendGrid API key	Required `""`
`alerting.sendgrid.from`	Email address to send from	Required `""`
`alerting.sendgrid.to`	Email address(es) to send alerts to (comma-separated for multiple recipients)	Required `""`
`alerting.sendgrid.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.sendgrid.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.sendgrid.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.sendgrid.overrides[].*`	See `alerting.sendgrid.*` parameters	`{}`

Parameter	Description	Default
`alerting.signal`	Configuration for alerts of type `signal`	`{}`
`alerting.signal.api-url`	Signal API URL (e.g., signal-cli-rest-api instance)	Required `""`
`alerting.signal.number`	Sender phone number	Required `""`
`alerting.signal.recipients`	List of recipient phone numbers	Required `[]`
`alerting.signal.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.signal.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.signal.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.signal.overrides[].*`	See `alerting.signal.*` parameters	`{}`

Parameter	Description	Default
`alerting.signl4`	Configuration for alerts of type `signl4`	`{}`
`alerting.signl4.team-secret`	SIGNL4 team secret (part of webhook URL)	Required `""`
`alerting.signl4.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.signl4.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.signl4.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.signl4.overrides[].*`	See `alerting.signl4.*` parameters	`{}`

Parameter	Description	Default
`alerting.slack`	Configuration for alerts of type `slack`	`{}`
`alerting.slack.webhook-url`	Slack Webhook URL	Required `""`
`alerting.slack.title`	Title of the notification	`":helmet_with_white_cross: Gatus"`
`alerting.slack.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.slack.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.slack.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.slack.overrides[].*`	See `alerting.slack.*` parameters	`{}`

Parameter	Description	Default
`alerting.splunk`	Configuration for alerts of type `splunk`	`{}`
`alerting.splunk.hec-url`	Splunk HEC (HTTP Event Collector) URL	Required `""`
`alerting.splunk.hec-token`	Splunk HEC token	Required `""`
`alerting.splunk.source`	Event source	`"gatus"`
`alerting.splunk.sourcetype`	Event source type	`"gatus:alert"`
`alerting.splunk.index`	Splunk index	`""`
`alerting.splunk.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.splunk.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.splunk.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.splunk.overrides[].*`	See `alerting.splunk.*` parameters	`{}`

Parameter	Description	Default
`alerting.squadcast`	Configuration for alerts of type `squadcast`	`{}`
`alerting.squadcast.webhook-url`	Squadcast webhook URL	Required `""`
`alerting.squadcast.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.squadcast.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.squadcast.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.squadcast.overrides[].*`	See `alerting.squadcast.*` parameters	`{}`

Parameter	Description	Default
`alerting.teams`	Configuration for alerts of type `teams`	`{}`
`alerting.teams.webhook-url`	Teams Webhook URL	Required `""`
`alerting.teams.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.teams.title`	Title of the notification	`"🚨 Gatus"`
`alerting.teams.client.insecure`	Whether to skip TLS verification	`false`
`alerting.teams.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.teams.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.teams.overrides[].*`	See `alerting.teams.*` parameters	`{}`

Parameter	Description	Default
`alerting.teams-workflows`	Configuration for alerts of type `teams`	`{}`
`alerting.teams-workflows.webhook-url`	Teams Webhook URL	Required `""`
`alerting.teams-workflows.title`	Title of the notification	`"⛑ Gatus"`
`alerting.teams-workflows.default-alert`	Default alert configuration. See Setting a default alert	N/A
`alerting.teams-workflows.overrides`	List of overrides that may be prioritized over the default configuration	`[]`
`alerting.teams-workflows.overrides[].group`	Endpoint group for which the configuration will be overridden by this configuration	`""`
`alerting.teams-workflows.overrides[].*`	See `alerting.teams-workflows.*` parameters	`{}`

Parameter	Description	Default
`alerting.twilio`	Settings for alerts of type `twilio`	`{}`
`alerting.twilio.sid`	Twilio account SID	Required `""`
`alerting.twilio.token`	Twilio auth token	Required `""`
`alerting.twilio.from`	Number to send Twilio alerts from	Required `""`
`alerting.twilio.to`	Number to send twilio alerts to	Required `""`
`alerting.twilio.default-alert`	Default alert configuration. See Setting a default alert	N/A

Parameter	Description	Default
`alerting.twilio.text-twilio-triggered`	Custom message template for triggered alerts. Supports `[ENDPOINT]`, `[ALERT_DESCRIPTION]`	`""`
`alerting.twilio.text-twilio-resolved`	Custom message template for resolved alerts. Supports `[ENDPOINT]`, `[ALERT_DESCRIPTION]`	`""`

Parameter	Description	Default
`alerting.*.default-alert.enabled`	Whether to enable the alert	N/A
`alerting.*.default-alert.failure-threshold`	Number of failures in a row needed before triggering the alert	N/A
`alerting.*.default-alert.success-threshold`	Number of successes in a row before an ongoing incident is marked as resolved	N/A
`alerting.*.default-alert.send-on-resolved`	Whether to send a notification once a triggered alert is marked as resolved	N/A
`alerting.*.default-alert.description`	Description of the alert. Will be included in the alert sent	N/A

Parameter	Description	Default
`maintenance.enabled`	Whether the maintenance period is enabled	`true`
`maintenance.start`	Time at which the maintenance window starts in `hh:mm` format (e.g. `23:00`)	Required `""`
`maintenance.duration`	Duration of the maintenance window (e.g. `1h`, `30m`)	Required `""`
`maintenance.timezone`	Timezone of the maintenance window format (e.g. `Europe/Amsterdam`). See List of tz database time zones for more info	`UTC`
`maintenance.every`	Days on which the maintenance period applies (e.g. `[Monday, Thursday]`). If left empty, the maintenance window applies every day	`[]`

Parameter	Description	Default
`security`	Security configuration	`{}`
`security.basic`	HTTP Basic configuration	`{}`
`security.oidc`	OpenID Connect configuration	`{}`

Metric name	Type	Description	Labels	Relevant endpoint types
gatus_results_total	counter	Number of results per endpoint per success state	key, group, name, type, success	All
gatus_results_code_total	counter	Total number of results by code	key, group, name, type, code	DNS, HTTP
gatus_results_connected_total	counter	Total number of results in which a connection was successfully established	key, group, name, type	All
gatus_results_duration_seconds	gauge	Duration of the request in seconds	key, group, name, type	All
gatus_results_certificate_expiration_seconds	gauge	Number of seconds until the certificate expires	key, group, name, type	HTTP, STARTTLS
gatus_results_domain_expiration_seconds	gauge	Number of seconds until the domains expires	key, group, name, type	HTTP, STARTTLS
gatus_results_endpoint_success	gauge	Displays whether or not the endpoint was a success (0 failure, 1 success)	key, group, name, type	All

Parameter	Description	Default
`connectivity`	Connectivity configuration	`{}`
`connectivity.checker`	Connectivity checker configuration	Required `{}`
`connectivity.checker.target`	Host to use for validating connectivity	Required `""`
`connectivity.checker.interval`	Interval at which to validate connectivity	`1m`

Parameter	Description	Default
`remote`	Remote configuration	`{}`
`remote.instances`	List of remote instances	Required `[]`
`remote.instances.endpoint-prefix`	String to prefix all endpoint names with	`""`
`remote.instances.url`	URL from which to retrieve endpoint statuses	Required `""`
`remote.client`	Client configuration.	`{}`

Table of Contents

Why Gatus?

Features

Usage

Configuration

Configuration

Endpoints

External Endpoints

Suites (ALPHA)

Using Context in Endpoints

Example Suite Configuration

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

Native Home Assistant Integration

Configuration

Automation Example

Configuring IFTTT alerts

Configuring Ilert alerts

Configuring Incident.io alerts

Configuring Line alerts

Configuring Matrix alerts

Configuring Mattermost alerts

Configuring Messagebird alerts

Configuring New Relic alerts

Configuring n8n 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