prometheus-alertmanager.json

Prometheus Alertmanager configuration file

Type object | null
File match alertmanager.yml alertmanager.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/prometheus-alertmanager-json/latest.json
Source https://www.schemastore.org/prometheus-alertmanager.json

Validate with Lintel

npx @lintel/lintel check
Type: object | null

Prometheus Alertmanager configuration file

Properties

global object
32 nested properties
smtp_from string

The default SMTP From header field

smtp_smarthost string

The default SMTP smarthost used for sending emails, including port number. Port number usually is 25, or 587 for SMTP over TLS (sometimes referred to as STARTTLS).

Examples: "smtp.example.org:587"
smtp_hello string

The default hostname to identify to the SMTP server

Default: "localhost"
smtp_auth_username string
smtp_auth_password string
smtp_auth_password_file string
smtp_auth_identity string
smtp_auth_secret string
smtp_require_tls boolean

The default SMTP TLS requirement

Default: true
smtp_tls_config object
7 nested properties
ca_file string

CA certificate to validate the server certificate with

cert_file string

Certificate file for client cert authentication to the server

key_file string

Key files for client cert authentication to the server

server_name string

ServerName extension to indicate the name of the server

insecure_skip_verify boolean

Disable validation of the server certificate

Default: false
min_version enum

Minimum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
max_version enum

Maximum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
jira_api_url string
slack_api_url string
slack_api_url_file string
victorops_api_key string
victorops_api_key_file string
victorops_api_url string
Default: "https://alert.victorops.com/integrations/generic/20131114/alert/"
pagerduty_url string
Default: "https://events.pagerduty.com/v2/enqueue"
opsgenie_api_key string
opsgenie_api_key_file string
opsgenie_api_url string
Default: "https://api.opsgenie.com/"
rocketchat_api_url string
Default: "https://open.rocket.chat/"
rocketchat_token string
rocketchat_token_file string
rocketchat_token_id string
rocketchat_token_id_file string
wechat_api_url string
Default: "https://qyapi.weixin.qq.com/cgi-bin/"
wechat_api_secret string
wechat_api_corp_id string
telegram_api_url string
Default: "https://api.telegram.org"
webex_api_url string
Default: "https://webexapis.com/v1/messages"
http_config object
11 nested properties
basic_auth object

Sets the Authorization header with the configured username and password. password and password_file are mutually exclusive

3 nested properties
username string
password string
password_file string
authorization object

Optional the Authorization header configuration

3 nested properties
type string

Sets the authentication type

Default: "Bearer"
credentials string

Sets the credentials. It is mutually exclusive with credentials_file

credentials_file string

Sets the credentials with the credentials read from the configured file. It is mutually exclusive with credentials

oauth2 object
11 nested properties
client_id string
client_secret string
client_secret_file string

Read the client secret from a file. It is mutually exclusive with client_secret

scopes string[]

Scopes for the token request

token_url string

The URL to fetch the token from

endpoint_params Record<string, string>

Optional parameters to append to the token URL

tls_config object
proxy_url string

Optional proxy URL

no_proxy string

Comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers

proxy_from_environment boolean

Use proxy URL indicated by environment variables (HTTP_PROXY, https_proxy, HTTPs_PROXY, https_proxy, and no_proxy)

Default: false
proxy_connect_header Record<string, string[]>

Specifies headers to send to proxies during CONNECT requests

enable_http2 boolean

Whether to enable HTTP2

Default: true
proxy_url string

Optional proxy URL

no_proxy string

Comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers

proxy_from_environment boolean

Use proxy URL indicated by environment variables (HTTP_PROXY, http_proxy, HTTPS_PROXY, https_proxy, NO_PROXY, and no_proxy)

Default: false
proxy_connect_header Record<string, string[]>

Specifies headers to send to proxies during CONNECT requests

follow_redirects boolean

Configure whether HTTP requests follow HTTP 3xx redirects

Default: true
tls_config object
7 nested properties
ca_file string

CA certificate to validate the server certificate with

cert_file string

Certificate file for client cert authentication to the server

key_file string

Key files for client cert authentication to the server

server_name string

ServerName extension to indicate the name of the server

insecure_skip_verify boolean

Disable validation of the server certificate

Default: false
min_version enum

Minimum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
max_version enum

Maximum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
http_headers Record<string, object>

Custom HTTP headers to be sent along with each request. Headers that are set by Prometheus itself can't be overwritten

resolve_timeout string
pattern=^((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?|0)$
templates array | null

Files from which custom notification template definitions are read. The last component may use a wildcard matcher, e.g. 'templates/*.tmpl'.

route object
12 nested properties
receiver string
group_by array | labelname[]
continue boolean

Whether an alert should continue matching subsequent sibling nodes

Default: false
match Record<string, string>

DEPRECATED. A set of equality matchers an alert has to fulfill to match the node. Use matchers instead

match_re Record<string, string>

DEPRECATED. A set of regex-matchers an alert has to fulfill to match the node. Use matchers instead

matchers string[]
group_wait string
pattern=^((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?|0)$
group_interval string
pattern=^((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?|0)$
repeat_interval string
pattern=^((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?|0)$
mute_time_intervals string[]

Times when the route should be muted. These must match the name of a time interval defined in the time_intervals section. Additionally, the root node cannot have any mute times. When a route is muted it will not send any notifications, but otherwise acts normally (including ending the route-matching process if the continue option is not set.)

active_time_intervals string[]

Times when the route should be active. These must match the name of a time interval defined in the time_intervals section. An empty value means that the route is always active. Additionally, the root node cannot have any active times. The route will send notifications only when active, but otherwise acts normally (including ending the route-matching process if the continue option is not set).

routes route[]
receivers receiver[]
inhibit_rules array | null
mute_time_intervals array | null

DEPRECATED. A list of mute time intervals for muting routes. Use time_intervals

time_intervals array | null

Definitions

duration string
labelname string
labelvalue string
regex string
filepath string
secret string
tls_config object
ca_file string

CA certificate to validate the server certificate with

cert_file string

Certificate file for client cert authentication to the server

key_file string

Key files for client cert authentication to the server

server_name string

ServerName extension to indicate the name of the server

insecure_skip_verify boolean

Disable validation of the server certificate

Default: false
min_version enum

Minimum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
max_version enum

Maximum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
oauth2 object
client_id string
client_secret string
client_secret_file string

Read the client secret from a file. It is mutually exclusive with client_secret

scopes string[]

Scopes for the token request

token_url string

The URL to fetch the token from

endpoint_params Record<string, string>

Optional parameters to append to the token URL

tls_config object
7 nested properties
ca_file string

CA certificate to validate the server certificate with

cert_file string

Certificate file for client cert authentication to the server

key_file string

Key files for client cert authentication to the server

server_name string

ServerName extension to indicate the name of the server

insecure_skip_verify boolean

Disable validation of the server certificate

Default: false
min_version enum

Minimum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
max_version enum

Maximum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
proxy_url string

Optional proxy URL

no_proxy string

Comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers

proxy_from_environment boolean

Use proxy URL indicated by environment variables (HTTP_PROXY, https_proxy, HTTPs_PROXY, https_proxy, and no_proxy)

Default: false
proxy_connect_header Record<string, string[]>

Specifies headers to send to proxies during CONNECT requests

http_config object
basic_auth object

Sets the Authorization header with the configured username and password. password and password_file are mutually exclusive

3 nested properties
username string
password string
password_file string
authorization object

Optional the Authorization header configuration

3 nested properties
type string

Sets the authentication type

Default: "Bearer"
credentials string

Sets the credentials. It is mutually exclusive with credentials_file

credentials_file string

Sets the credentials with the credentials read from the configured file. It is mutually exclusive with credentials

oauth2 object
11 nested properties
client_id string
client_secret string
client_secret_file string

Read the client secret from a file. It is mutually exclusive with client_secret

scopes string[]

Scopes for the token request

token_url string

The URL to fetch the token from

endpoint_params Record<string, string>

Optional parameters to append to the token URL

tls_config object
7 nested properties
ca_file string

CA certificate to validate the server certificate with

cert_file string

Certificate file for client cert authentication to the server

key_file string

Key files for client cert authentication to the server

server_name string

ServerName extension to indicate the name of the server

insecure_skip_verify boolean

Disable validation of the server certificate

Default: false
min_version enum

Minimum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
max_version enum

Maximum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
proxy_url string

Optional proxy URL

no_proxy string

Comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers

proxy_from_environment boolean

Use proxy URL indicated by environment variables (HTTP_PROXY, https_proxy, HTTPs_PROXY, https_proxy, and no_proxy)

Default: false
proxy_connect_header Record<string, string[]>

Specifies headers to send to proxies during CONNECT requests

enable_http2 boolean

Whether to enable HTTP2

Default: true
proxy_url string

Optional proxy URL

no_proxy string

Comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers

proxy_from_environment boolean

Use proxy URL indicated by environment variables (HTTP_PROXY, http_proxy, HTTPS_PROXY, https_proxy, NO_PROXY, and no_proxy)

Default: false
proxy_connect_header Record<string, string[]>

Specifies headers to send to proxies during CONNECT requests

follow_redirects boolean

Configure whether HTTP requests follow HTTP 3xx redirects

Default: true
tls_config object
7 nested properties
ca_file string

CA certificate to validate the server certificate with

cert_file string

Certificate file for client cert authentication to the server

key_file string

Key files for client cert authentication to the server

server_name string

ServerName extension to indicate the name of the server

insecure_skip_verify boolean

Disable validation of the server certificate

Default: false
min_version enum

Minimum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
max_version enum

Maximum acceptable TLS version

Values: "TLS10" "TLS11" "TLS12" "TLS13"
http_headers Record<string, object>

Custom HTTP headers to be sent along with each request. Headers that are set by Prometheus itself can't be overwritten

route object
receiver string
group_by array | labelname[]
continue boolean

Whether an alert should continue matching subsequent sibling nodes

Default: false
match Record<string, string>

DEPRECATED. A set of equality matchers an alert has to fulfill to match the node. Use matchers instead

match_re Record<string, string>

DEPRECATED. A set of regex-matchers an alert has to fulfill to match the node. Use matchers instead

matchers string[]
group_wait string
pattern=^((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?|0)$
group_interval string
pattern=^((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?|0)$
repeat_interval string
pattern=^((([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?|0)$
mute_time_intervals string[]

Times when the route should be muted. These must match the name of a time interval defined in the time_intervals section. Additionally, the root node cannot have any mute times. When a route is muted it will not send any notifications, but otherwise acts normally (including ending the route-matching process if the continue option is not set.)

active_time_intervals string[]

Times when the route should be active. These must match the name of a time interval defined in the time_intervals section. An empty value means that the route is always active. Additionally, the root node cannot have any active times. The route will send notifications only when active, but otherwise acts normally (including ending the route-matching process if the continue option is not set).

routes route[]
matcher string[]
receiver object
name string

The unique name of the receiver

discord_configs object[]
email_configs object[]
msteams_configs object[]
msteamsv2_configs object[]
jira_configs object[]
opsgenie_configs object[]
pagerduty_configs object[]
pushover_configs object[]
rocketchat_configs object[]
slack_configs object[]
sns_configs object[]
telegram_configs object[]
victorops_configs object[]
webex_configs object[]
webhook_configs object[]
wechat_configs object[]
inhibit_rule object
target_match Record<string, string>

DEPRECATED. Matchers that have to be fulfilled in the alerts to be muted. Use target_matchers

target_match_re Record<string, string>

DEPRECATED: Use target_matchers

target_matchers string[]
source_match Record<string, string>

DEPRECATED. Matchers for which one or more alerts have to exist for the inhibition to take effect. Use source_matchers

source_match_re Record<string, string>

DEPRECATED. Use source_matchers

source_matchers string[]
equal labelname[]

Labels that must have an equal value in the source and target alert for the inhibition to take effect

time_interval object
name string
time_intervals time_interval_spec[]
time_interval_spec object
times object[]
weekdays string[]
days_of_month string[]
months string[]
years string[]
location string