Skip to main content

AlertmanagerConfig [monitoring.coreos.com/v1beta1]

Description
The AlertmanagerConfig custom resource definition (CRD) defines how Alertmanager objects process Prometheus alerts. It allows to specify alert grouping and routing, notification receivers and inhibition rules. Alertmanager objects select AlertmanagerConfig objects using label and namespace selectors.
Type
`object`
Required
  • spec

Specification​

PropertyTypeDescription
apiVersionstringAPIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kindstringKind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadataObjectMetaStandard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
specobjectspec defines the specification of AlertmanagerConfigSpec
statusobjectstatus defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled.
Most recent observed status of the ServiceMonitor. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

.spec​

Description
spec defines the specification of AlertmanagerConfigSpec
Type
`object`
PropertyTypeDescription
inhibitRulesarrayinhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.
inhibitRules[]objectInhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule
receiversarrayreceivers defines the list of receivers.
receivers[]objectReceiver defines one or more notification integrations.
routeobjectroute defines the Alertmanager route definition for alerts matching the resource’s namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route.
timeIntervalsarraytimeIntervals defines the list of timeIntervals specifying when the routes should be muted.
timeIntervals[]objectTimeInterval specifies the periods in time when notifications will be muted or active.

.spec.inhibitRules​

Description
inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.
Type
`array`

.spec.inhibitRules[]​

Description
InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule
Type
`object`
PropertyTypeDescription
equalarray (string)equal defines labels that must have an equal value in the source and target alert for the inhibition to take effect. This ensures related alerts are properly grouped.
sourceMatcharraysourceMatch defines matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource’s namespace. These are the "trigger" alerts that cause other alerts to be inhibited.
sourceMatch[]objectMatcher defines how to match on alert’s labels.
targetMatcharraytargetMatch defines matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace. When these conditions are met, matching alerts will be inhibited (silenced).
targetMatch[]objectMatcher defines how to match on alert’s labels.

.spec.inhibitRules[].sourceMatch​

Description
sourceMatch defines matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource’s namespace. These are the "trigger" alerts that cause other alerts to be inhibited.
Type
`array`

.spec.inhibitRules[].sourceMatch[]​

Description
Matcher defines how to match on alert’s labels.
Type
`object`
Required
  • name
PropertyTypeDescription
matchTypestringmatchType defines the match operation available with AlertManager >= v0.22.0. Takes precedence over Regex (deprecated) if non-empty. Valid values: "=" (equality), "!=" (inequality), "=" (regex match), "!" (regex non-match).
namestringname defines the label to match. This specifies which alert label should be evaluated.
valuestringvalue defines the label value to match. This is the expected value for the specified label.

.spec.inhibitRules[].targetMatch​

Description
targetMatch defines matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace. When these conditions are met, matching alerts will be inhibited (silenced).
Type
`array`

.spec.inhibitRules[].targetMatch[]​

Description
Matcher defines how to match on alert’s labels.
Type
`object`
Required
  • name
PropertyTypeDescription
matchTypestringmatchType defines the match operation available with AlertManager >= v0.22.0. Takes precedence over Regex (deprecated) if non-empty. Valid values: "=" (equality), "!=" (inequality), "=" (regex match), "!" (regex non-match).
namestringname defines the label to match. This specifies which alert label should be evaluated.
valuestringvalue defines the label value to match. This is the expected value for the specified label.

.spec.receivers​

Description
receivers defines the list of receivers.
Type
`array`

.spec.receivers[]​

Description
Receiver defines one or more notification integrations.
Type
`object`
Required
  • name
PropertyTypeDescription
discordConfigsarraydiscordConfigs defines the list of Discord configurations.
discordConfigs[]objectDiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config
emailConfigsarrayemailConfigs defines the list of Email configurations.
emailConfigs[]objectEmailConfig configures notifications via Email.
msteamsConfigsarraymsteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0.
msteamsConfigs[]objectMSTeamsConfig configures notifications via Microsoft Teams. It requires Alertmanager >= 0.26.0.
msteamsv2Configsarraymsteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0.
msteamsv2Configs[]objectMSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows. See https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config It requires Alertmanager >= 0.28.0.
namestringname defines the name of the receiver. Must be unique across all items from the list.
opsgenieConfigsarrayopsgenieConfigs defines the list of OpsGenie configurations.
opsgenieConfigs[]objectOpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
pagerdutyConfigsarraypagerdutyConfigs defines the List of PagerDuty configurations.
pagerdutyConfigs[]objectPagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config
pushoverConfigsarraypushoverConfigs defines the list of Pushover configurations.
pushoverConfigs[]objectPushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config
rocketchatConfigsarrayrocketchatConfigs defines the list of RocketChat configurations. It requires Alertmanager >= 0.28.0.
rocketchatConfigs[]objectRocketChatConfig configures notifications via RocketChat. It requires Alertmanager >= 0.28.0.
slackConfigsarrayslackConfigs defines the list of Slack configurations.
slackConfigs[]objectSlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config
snsConfigsarraysnsConfigs defines the list of SNS configurations
snsConfigs[]objectSNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
telegramConfigsarraytelegramConfigs defines the list of Telegram configurations.
telegramConfigs[]objectTelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config
victoropsConfigsarrayvictoropsConfigs defines the list of VictorOps configurations.
victoropsConfigs[]objectVictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config
webexConfigsarraywebexConfigs defines the list of Webex configurations.
webexConfigs[]objectWebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config
webhookConfigsarraywebhookConfigs defines the List of webhook configurations.
webhookConfigs[]objectWebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
wechatConfigsarraywechatConfigs defines the list of WeChat configurations.
wechatConfigs[]objectWeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config

.spec.receivers[].discordConfigs​

Description
discordConfigs defines the list of Discord configurations.
Type
`array`

.spec.receivers[].discordConfigs[]​

Description
DiscordConfig configures notifications via Discord. See https://prometheus.io/docs/alerting/latest/configuration/#discord_config
Type
`object`
Required
  • apiURL
PropertyTypeDescription
apiURLobjectapiURL defines the secret’s key that contains the Discord webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
avatarURLstringavatarURL defines the avatar url of the message sender.
contentstringcontent defines the template of the content’s body.
httpConfigobjecthttpConfig defines HTTP client configuration.
messagestringmessage defines the template of the message’s body.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
titlestringtitle defines the template of the message’s title.
usernamestringusername defines the username of the message sender.

.spec.receivers[].discordConfigs[].apiURL​

Description
apiURL defines the secret’s key that contains the Discord webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig​

Description
httpConfig defines HTTP client configuration.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].discordConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].discordConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].discordConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].discordConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].discordConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].discordConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].discordConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].discordConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].discordConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].discordConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].discordConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].emailConfigs​

Description
emailConfigs defines the list of Email configurations.
Type
`array`

.spec.receivers[].emailConfigs[]​

Description
EmailConfig configures notifications via Email.
Type
`object`
PropertyTypeDescription
authIdentitystringauthIdentity defines the identity to use for SMTP authentication. This is typically used with PLAIN authentication mechanism.
authPasswordobjectauthPassword defines the secret’s key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
authSecretobjectauthSecret defines the secret’s key that contains the CRAM-MD5 secret. This is used for CRAM-MD5 authentication mechanism. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
authUsernamestringauthUsername defines the username to use for SMTP authentication. This is used for SMTP AUTH when the server requires authentication.
forceImplicitTLSbooleanforceImplicitTLS defines whether to force use of implicit TLS (direct TLS connection) for better security. true: force use of implicit TLS (direct TLS connection on any port) false: force disable implicit TLS (use explicit TLS/STARTTLS if required) nil (default): auto-detect based on port (465=implicit, other=explicit) for backward compatibility It requires Alertmanager >= v0.31.0.
fromstringfrom defines the sender address for email notifications. This appears as the "From" field in the email header.
headersarrayheaders defines additional email header key/value pairs. These override any headers previously set by the notification implementation.
headers[]objectKeyValue defines a (key, value) tuple.
hellostringhello defines the hostname to identify to the SMTP server. This is used in the SMTP HELO/EHLO command during the connection handshake.
htmlstringhtml defines the HTML body of the email notification. This allows for rich formatting in the email content.
requireTLSbooleanrequireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
smarthoststringsmarthost defines the SMTP host and port through which emails are sent. Format should be "hostname:port", e.g. "smtp.example.com:587".
textstringtext defines the plain text body of the email notification. This provides a fallback for email clients that don’t support HTML.
tlsConfigobjecttlsConfig defines the TLS configuration for SMTP connections. This includes settings for certificates, CA validation, and TLS protocol options.
tostringto defines the email address to send notifications to. This is the recipient address for alert notifications.

.spec.receivers[].emailConfigs[].authPassword​

Description
authPassword defines the secret’s key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].emailConfigs[].authSecret​

Description
authSecret defines the secret’s key that contains the CRAM-MD5 secret. This is used for CRAM-MD5 authentication mechanism. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].emailConfigs[].headers​

Description
headers defines additional email header key/value pairs. These override any headers previously set by the notification implementation.
Type
`array`

.spec.receivers[].emailConfigs[].headers[]​

Description
KeyValue defines a (key, value) tuple.
Type
`object`
Required
  • key
  • value
PropertyTypeDescription
keystringkey defines the key of the tuple. This is the identifier or name part of the key-value pair.
valuestringvalue defines the value of the tuple. This is the data or content associated with the key.

.spec.receivers[].emailConfigs[].tlsConfig​

Description
tlsConfig defines the TLS configuration for SMTP connections. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].emailConfigs[].tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].emailConfigs[].tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].emailConfigs[].tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].emailConfigs[].tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].emailConfigs[].tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].emailConfigs[].tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].emailConfigs[].tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs​

Description
msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0.
Type
`array`

.spec.receivers[].msteamsConfigs[]​

Description
MSTeamsConfig configures notifications via Microsoft Teams. It requires Alertmanager >= 0.26.0.
Type
`object`
Required
  • webhookUrl
PropertyTypeDescription
httpConfigobjecthttpConfig defines the HTTP client configuration for Teams webhook requests.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
summarystringsummary defines the message summary template for Teams notifications. This provides a brief overview that appears in Teams notification previews. It requires Alertmanager >= 0.27.0.
textstringtext defines the message body template for Teams notifications. This contains the detailed content of the Teams message.
titlestringtitle defines the message title template for Teams notifications. This appears as the main heading of the Teams message card.
webhookUrlobjectwebhookUrl defines the MSTeams webhook URL for sending notifications. This is the incoming webhook URL configured in your Teams channel.

.spec.receivers[].msteamsConfigs[].httpConfig​

Description
httpConfig defines the HTTP client configuration for Teams webhook requests.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].msteamsConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].msteamsConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].msteamsConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].msteamsConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].msteamsConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsConfigs[].webhookUrl​

Description
webhookUrl defines the MSTeams webhook URL for sending notifications. This is the incoming webhook URL configured in your Teams channel.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs​

Description
msteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0.
Type
`array`

.spec.receivers[].msteamsv2Configs[]​

Description
MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows. See https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config It requires Alertmanager >= 0.28.0.
Type
`object`
PropertyTypeDescription
httpConfigobjecthttpConfig defines the HTTP client configuration for Teams webhook requests.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
textstringtext defines the message body template for adaptive card notifications. This contains the detailed content displayed in the Teams adaptive card format.
titlestringtitle defines the message title template for adaptive card notifications. This appears as the main heading in the Teams adaptive card.
webhookURLobjectwebhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. This webhook must support the newer adaptive cards format required by Teams flows.

.spec.receivers[].msteamsv2Configs[].httpConfig​

Description
httpConfig defines the HTTP client configuration for Teams webhook requests.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].msteamsv2Configs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].msteamsv2Configs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].msteamsv2Configs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].msteamsv2Configs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].msteamsv2Configs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].msteamsv2Configs[].webhookURL​

Description
webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. This webhook must support the newer adaptive cards format required by Teams flows.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs​

Description
opsgenieConfigs defines the list of OpsGenie configurations.
Type
`array`

.spec.receivers[].opsgenieConfigs[]​

Description
OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config
Type
`object`
PropertyTypeDescription
actionsstringactions defines a comma separated list of actions that will be available for the alert. These appear as action buttons in the OpsGenie interface.
apiKeyobjectapiKey defines the secret’s key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
apiURLstringapiURL defines the URL to send OpsGenie API requests to. When not specified, defaults to the standard OpsGenie API endpoint.
descriptionstringdescription defines the detailed description of the incident. This provides additional context beyond the message field.
detailsarraydetails defines a set of arbitrary key/value pairs that provide further detail about the incident. These appear as additional fields in the OpsGenie alert.
details[]objectKeyValue defines a (key, value) tuple.
entitystringentity defines an optional field that can be used to specify which domain alert is related to. This helps group related alerts together in OpsGenie.
httpConfigobjecthttpConfig defines the HTTP client configuration for OpsGenie API requests.
messagestringmessage defines the alert text limited to 130 characters. This appears as the main alert title in OpsGenie.
notestringnote defines an additional alert note. This provides supplementary information about the alert.
prioritystringpriority defines the priority level of alert. Possible values are P1, P2, P3, P4, and P5, where P1 is highest priority.
respondersarrayresponders defines the list of responders responsible for notifications. These determine who gets notified when the alert is created.
responders[]objectOpsGenieConfigResponder defines a responder to an incident. One of id, name or username has to be defined.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
sourcestringsource defines the backlink to the sender of the notification. This helps identify where the alert originated from.
tagsstringtags defines a comma separated list of tags attached to the notifications. These help categorize and filter alerts within OpsGenie.

.spec.receivers[].opsgenieConfigs[].apiKey​

Description
apiKey defines the secret’s key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].opsgenieConfigs[].details​

Description
details defines a set of arbitrary key/value pairs that provide further detail about the incident. These appear as additional fields in the OpsGenie alert.
Type
`array`

.spec.receivers[].opsgenieConfigs[].details[]​

Description
KeyValue defines a (key, value) tuple.
Type
`object`
Required
  • key
  • value
PropertyTypeDescription
keystringkey defines the key of the tuple. This is the identifier or name part of the key-value pair.
valuestringvalue defines the value of the tuple. This is the data or content associated with the key.

.spec.receivers[].opsgenieConfigs[].httpConfig​

Description
httpConfig defines the HTTP client configuration for OpsGenie API requests.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].opsgenieConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].opsgenieConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].opsgenieConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].opsgenieConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].responders​

Description
responders defines the list of responders responsible for notifications. These determine who gets notified when the alert is created.
Type
`array`

.spec.receivers[].opsgenieConfigs[].responders[]​

Description
OpsGenieConfigResponder defines a responder to an incident. One of id, name or username has to be defined.
Type
`object`
Required
  • type
PropertyTypeDescription
idstringid defines the unique identifier of the responder. This corresponds to the responder’s ID within OpsGenie.
namestringname defines the display name of the responder. This is used when the responder is identified by name rather than ID.
typestringtype defines the type of responder. Valid values include "user", "team", "schedule", and "escalation". This determines how OpsGenie interprets the other identifier fields.
usernamestringusername defines the username of the responder. This is typically used for user-type responders when identifying by username.

.spec.receivers[].pagerdutyConfigs​

Description
pagerdutyConfigs defines the List of PagerDuty configurations.
Type
`array`

.spec.receivers[].pagerdutyConfigs[]​

Description
PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config
Type
`object`
PropertyTypeDescription
classstringclass defines the class/type of the event.
clientstringclient defines the client identification.
clientURLstringclientURL defines the backlink to the sender of notification.
componentstringcomponent defines the part or component of the affected system that is broken.
descriptionstringdescription of the incident.
detailsarraydetails defines the arbitrary key/value pairs that provide further detail about the incident.
details[]objectKeyValue defines a (key, value) tuple.
groupstringgroup defines a cluster or grouping of sources.
httpConfigobjecthttpConfig defines the HTTP client configuration.
pagerDutyImageConfigsarraypagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident.
pagerDutyImageConfigs[]objectPagerDutyImageConfig attaches images to an incident
pagerDutyLinkConfigsarraypagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident.
pagerDutyLinkConfigs[]objectPagerDutyLinkConfig attaches text links to an incident
routingKeyobjectroutingKey defines the secret’s key that contains the PagerDuty integration key (when using Events API v2). Either this field or serviceKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
serviceKeyobjectserviceKey defines the secret’s key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or routingKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
severitystringseverity of the incident.
sourcestringsource defines the unique location of the affected system.
timeoutstringtimeout is the maximum time allowed to invoke the pagerduty It requires Alertmanager >= v0.30.0.
urlstringurl defines the URL to send requests to.

.spec.receivers[].pagerdutyConfigs[].details​

Description
details defines the arbitrary key/value pairs that provide further detail about the incident.
Type
`array`

.spec.receivers[].pagerdutyConfigs[].details[]​

Description
KeyValue defines a (key, value) tuple.
Type
`object`
Required
  • key
  • value
PropertyTypeDescription
keystringkey defines the key of the tuple. This is the identifier or name part of the key-value pair.
valuestringvalue defines the value of the tuple. This is the data or content associated with the key.

.spec.receivers[].pagerdutyConfigs[].httpConfig​

Description
httpConfig defines the HTTP client configuration.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].pagerdutyConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].pagerdutyConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].pagerdutyConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].pagerdutyConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].pagerDutyImageConfigs​

Description
pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident.
Type
`array`

.spec.receivers[].pagerdutyConfigs[].pagerDutyImageConfigs[]​

Description
PagerDutyImageConfig attaches images to an incident
Type
`object`
PropertyTypeDescription
altstringalt is the optional alternative text for the image.
hrefstringhref defines the optional URL; makes the image a clickable link.
srcstringsrc of the image being attached to the incident

.spec.receivers[].pagerdutyConfigs[].pagerDutyLinkConfigs​

Description
pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident.
Type
`array`

.spec.receivers[].pagerdutyConfigs[].pagerDutyLinkConfigs[]​

Description
PagerDutyLinkConfig attaches text links to an incident
Type
`object`
PropertyTypeDescription
altstringalt defines the text that describes the purpose of the link, and can be used as the link’s text.
hrefstringhref defines the URL of the link to be attached

.spec.receivers[].pagerdutyConfigs[].routingKey​

Description
routingKey defines the secret’s key that contains the PagerDuty integration key (when using Events API v2). Either this field or serviceKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].pagerdutyConfigs[].serviceKey​

Description
serviceKey defines the secret’s key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or routingKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].pushoverConfigs​

Description
pushoverConfigs defines the list of Pushover configurations.
Type
`array`

.spec.receivers[].pushoverConfigs[]​

Description
PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config
Type
`object`
PropertyTypeDescription
devicestringdevice defines the name of a specific device to send the notification to. If not specified, the notification is sent to all user’s devices.
expirestringexpire defines how long your notification will continue to be retried for, unless the user acknowledges the notification. Only applies to priority 2 notifications.
htmlbooleanhtml defines whether notification message is HTML or plain text. When true, the message can include HTML formatting tags. html and monospace formatting are mutually exclusive.
httpConfigobjecthttpConfig defines the HTTP client configuration for Pushover API requests.
messagestringmessage defines the notification message content. This is the main body text of the Pushover notification.
monospacebooleanmonospace optional HTML/monospace formatting for the message, see https://pushover.net/api#html html and monospace formatting are mutually exclusive.
prioritystringpriority defines the notification priority level. See https://pushover.net/api#priority for valid values and behavior.
retrystringretry defines how often the Pushover servers will send the same notification to the user. Must be at least 30 seconds. Only applies to priority 2 notifications.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
soundstringsound defines the name of one of the sounds supported by device clients. This overrides the user’s default sound choice for this notification.
titlestringtitle defines the notification title displayed in the Pushover message. This appears as the bold header text in the notification.
tokenobjecttoken defines the secret’s key that contains the registered application’s API token. See https://pushover.net/apps for application registration. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either token or tokenFile is required.
tokenFilestringtokenFile defines the token file that contains the registered application’s API token. See https://pushover.net/apps for application registration. Either token or tokenFile is required. It requires Alertmanager >= v0.26.0.
ttlstringttl defines the time to live for the alert notification. This determines how long the notification remains active before expiring.
urlstringurl defines a supplementary URL shown alongside the message. This creates a clickable link within the Pushover notification.
urlTitlestringurlTitle defines a title for the supplementary URL. If not specified, the raw URL is shown instead.
userKeyobjectuserKey defines the secret’s key that contains the recipient user’s user key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either userKey or userKeyFile is required.
userKeyFilestringuserKeyFile defines the user key file that contains the recipient user’s user key. Either userKey or userKeyFile is required. It requires Alertmanager >= v0.26.0.

.spec.receivers[].pushoverConfigs[].httpConfig​

Description
httpConfig defines the HTTP client configuration for Pushover API requests.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].pushoverConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].pushoverConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].pushoverConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].pushoverConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].pushoverConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].token​

Description
token defines the secret’s key that contains the registered application’s API token. See https://pushover.net/apps for application registration. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either token or tokenFile is required.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].pushoverConfigs[].userKey​

Description
userKey defines the secret’s key that contains the recipient user’s user key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either userKey or userKeyFile is required.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].rocketchatConfigs​

Description
rocketchatConfigs defines the list of RocketChat configurations. It requires Alertmanager >= 0.28.0.
Type
`array`

.spec.receivers[].rocketchatConfigs[]​

Description
RocketChatConfig configures notifications via RocketChat. It requires Alertmanager >= 0.28.0.
Type
`object`
Required
  • token
  • tokenID
PropertyTypeDescription
actionsarrayactions defines interactive actions to include in the message. These appear as buttons that users can click to trigger responses.
actions[]objectRocketChatActionConfig defines actions for RocketChat messages.
apiURLstringapiURL defines the API URL for RocketChat. Defaults to https://open.rocket.chat/ if not specified.
channelstringchannel defines the channel to send alerts to. This can be a channel name (e.g., "#alerts") or a direct message recipient.
colorstringcolor defines the message color displayed in RocketChat. This appears as a colored bar alongside the message.
emojistringemoji defines the emoji to be displayed as an avatar. If provided, this emoji will be used instead of the default avatar or iconURL.
fieldsarrayfields defines additional fields for the message attachment. These appear as structured key-value pairs within the message.
fields[]objectRocketChatFieldConfig defines a field for RocketChat messages.
httpConfigobjecthttpConfig defines the HTTP client configuration for RocketChat API requests.
iconURLstringiconURL defines the icon URL for the message avatar. This displays a custom image as the message sender’s avatar.
imageURLstringimageURL defines the image URL to display within the message. This embeds an image directly in the message attachment.
linkNamesbooleanlinkNames defines whether to enable automatic linking of usernames and channels. When true, @username and #channel references become clickable links.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
shortFieldsbooleanshortFields defines whether to use short fields in the message layout. When true, fields may be displayed side by side to save space.
textstringtext defines the message text to send. This is optional because attachments can be used instead of or alongside text.
thumbURLstringthumbURL defines the thumbnail URL for the message. This displays a small thumbnail image alongside the message content.
titlestringtitle defines the message title displayed prominently in the message. This appears as bold text at the top of the message attachment.
titleLinkstringtitleLink defines the URL that the title will link to when clicked. This makes the message title clickable in the RocketChat interface.
tokenobjecttoken defines the sender token for RocketChat authentication. This is the personal access token or bot token used to authenticate API requests. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
tokenIDobjecttokenID defines the sender token ID for RocketChat authentication. This is the user ID associated with the token used for API requests. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

.spec.receivers[].rocketchatConfigs[].actions​

Description
actions defines interactive actions to include in the message. These appear as buttons that users can click to trigger responses.
Type
`array`

.spec.receivers[].rocketchatConfigs[].actions[]​

Description
RocketChatActionConfig defines actions for RocketChat messages.
Type
`object`
PropertyTypeDescription
msgstringmsg defines the message to send when the button is clicked. This allows the button to post a predefined message to the channel.
textstringtext defines the button text displayed to users. This is the label that appears on the interactive button.
urlstringurl defines the URL the button links to when clicked. This creates a clickable button that opens the specified URL.

.spec.receivers[].rocketchatConfigs[].fields​

Description
fields defines additional fields for the message attachment. These appear as structured key-value pairs within the message.
Type
`array`

.spec.receivers[].rocketchatConfigs[].fields[]​

Description
RocketChatFieldConfig defines a field for RocketChat messages.
Type
`object`
PropertyTypeDescription
shortbooleanshort defines whether this field should be a short field. When true, the field may be displayed inline with other short fields to save space.
titlestringtitle defines the title of this field. This appears as bold text labeling the field content.
valuestringvalue defines the value of this field, displayed underneath the title. This contains the actual data or content for the field.

.spec.receivers[].rocketchatConfigs[].httpConfig​

Description
httpConfig defines the HTTP client configuration for RocketChat API requests.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].rocketchatConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].rocketchatConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].rocketchatConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].rocketchatConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].rocketchatConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].token​

Description
token defines the sender token for RocketChat authentication. This is the personal access token or bot token used to authenticate API requests. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].rocketchatConfigs[].tokenID​

Description
tokenID defines the sender token ID for RocketChat authentication. This is the user ID associated with the token used for API requests. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs​

Description
slackConfigs defines the list of Slack configurations.
Type
`array`

.spec.receivers[].slackConfigs[]​

Description
SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config
Type
`object`
PropertyTypeDescription
actionsarrayactions defines a list of Slack actions that are sent with each notification.
actions[]objectSlackAction configures a single Slack action that is sent with each notification. See https://api.slack.com/docs/message-attachments#action_fields and https://api.slack.com/docs/message-buttons for more information.
apiURLobjectapiURL defines the secret’s key that contains the Slack webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
callbackIdstringcallbackId defines an identifier for the message used in interactive components.
channelstringchannel defines the channel or user to send notifications to.
colorstringcolor defines the color of the left border of the Slack message attachment. Can be a hex color code (e.g., "#ff0000") or a predefined color name.
fallbackstringfallback defines a plain-text summary of the attachment for clients that don’t support attachments.
fieldsarrayfields defines a list of Slack fields that are sent with each notification.
fields[]objectSlackField configures a single Slack field that is sent with each notification. Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. See https://api.slack.com/docs/message-attachments#fields for more information.
footerstringfooter defines small text displayed at the bottom of the message attachment.
httpConfigobjecthttpConfig defines the HTTP client configuration.
iconEmojistringiconEmoji defines the emoji to use as the bot’s avatar (e.g., "👻").
iconURLstringiconURL defines the URL to an image to use as the bot’s avatar.
imageURLstringimageURL defines the URL to an image file that will be displayed inside the message attachment.
linkNamesbooleanlinkNames enables automatic linking of channel names and usernames in the message. When true, @channel and @username will be converted to clickable links.
messageTextstringmessageText defines text content of the Slack message. If set, this is sent as the top-level 'text' field in the Slack payload. It requires Alertmanager >= v0.31.0.
mrkdwnInarray (string)mrkdwnIn defines which fields should be parsed as Slack markdown. Valid values include "pretext", "text", and "fields".
pretextstringpretext defines optional text that appears above the message attachment block.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
shortFieldsbooleanshortFields determines whether fields are displayed in a compact format. When true, fields are shown side by side when possible.
textstringtext defines the main text content of the Slack message attachment.
thumbURLstringthumbURL defines the URL to an image file that will be displayed as a thumbnail on the right side of the message attachment.
timeoutstringtimeout defines the maximum time to wait for a webhook request to complete, before failing the request and allowing it to be retried. It requires Alertmanager >= v0.30.0.
titlestringtitle defines the title text displayed in the Slack message attachment.
titleLinkstringtitleLink defines the URL that the title will link to when clicked.
usernamestringusername defines the slack bot user name.

.spec.receivers[].slackConfigs[].actions​

Description
actions defines a list of Slack actions that are sent with each notification.
Type
`array`

.spec.receivers[].slackConfigs[].actions[]​

Description
SlackAction configures a single Slack action that is sent with each notification. See https://api.slack.com/docs/message-attachments#action_fields and https://api.slack.com/docs/message-buttons for more information.
Type
`object`
Required
  • text
  • type
PropertyTypeDescription
confirmobjectconfirm defines an optional confirmation dialog that appears before the action is executed. When set, users must confirm their intent before the action proceeds.
namestringname defines a unique identifier for the action within the message. This value is sent back to your application when the action is triggered.
stylestringstyle defines the visual appearance of the action element. Valid values include "default", "primary" (green), and "danger" (red).
textstringtext defines the user-visible label displayed on the action element. For buttons, this is the button text. For select menus, this is the placeholder text.
typestringtype defines the type of interactive component. Common values include "button" for clickable buttons and "select" for dropdown menus.
urlstringurl defines the URL to open when the action is triggered. Only applicable for button-type actions. When set, clicking the button opens this URL.
valuestringvalue defines the payload sent when the action is triggered. This data is included in the callback sent to your application.

.spec.receivers[].slackConfigs[].actions[].confirm​

Description
confirm defines an optional confirmation dialog that appears before the action is executed. When set, users must confirm their intent before the action proceeds.
Type
`object`
Required
  • text
PropertyTypeDescription
dismissTextstringdismissText defines the label for the cancel button in the dialog. When not specified, defaults to "Cancel". This button cancels the action.
okTextstringokText defines the label for the confirmation button in the dialog. When not specified, defaults to "Okay". This button proceeds with the action.
textstringtext defines the main message displayed in the confirmation dialog. This should be a clear question or statement asking the user to confirm their action.
titlestringtitle defines the title text displayed at the top of the confirmation dialog. When not specified, a default title will be used.

.spec.receivers[].slackConfigs[].apiURL​

Description
apiURL defines the secret’s key that contains the Slack webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].slackConfigs[].fields​

Description
fields defines a list of Slack fields that are sent with each notification.
Type
`array`

.spec.receivers[].slackConfigs[].fields[]​

Description
SlackField configures a single Slack field that is sent with each notification. Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. See https://api.slack.com/docs/message-attachments#fields for more information.
Type
`object`
Required
  • title
  • value
PropertyTypeDescription
shortbooleanshort determines whether this field can be displayed alongside other short fields. When true, Slack may display this field side by side with other short fields. When false or not specified, the field takes the full width of the message.
titlestringtitle defines the label or header text displayed for this field. This appears as bold text above the field value in the Slack message.
valuestringvalue defines the content or data displayed for this field. This appears below the title and can contain plain text or Slack markdown.

.spec.receivers[].slackConfigs[].httpConfig​

Description
httpConfig defines the HTTP client configuration.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].slackConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].slackConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].slackConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].slackConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].slackConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].slackConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].slackConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].slackConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].slackConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].slackConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs​

Description
snsConfigs defines the list of SNS configurations
Type
`array`

.spec.receivers[].snsConfigs[]​

Description
SNSConfig configures notifications via AWS SNS. See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs
Type
`object`
PropertyTypeDescription
apiURLstringapiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com. If not specified, the SNS API URL from the SNS SDK will be used.
attributesobject (string)attributes defines SNS message attributes as key-value pairs. These provide additional metadata that can be used for message filtering and routing.
httpConfigobjecthttpConfig defines the HTTP client configuration for SNS API requests.
messagestringmessage defines the message content of the SNS notification. This is the actual notification text that will be sent to subscribers.
phoneNumberstringphoneNumber defines the phone number if message is delivered via SMS in E.164 format. If you don’t specify this value, you must specify a value for the TopicARN or TargetARN.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
sigv4objectsigv4 configures AWS’s Signature Verification 4 signing process to sign requests. This includes AWS credentials and region configuration for authentication.
subjectstringsubject defines the subject line when the message is delivered to email endpoints. This field is only used when sending to email subscribers of an SNS topic.
targetARNstringtargetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications. If you don’t specify this value, you must specify a value for the TopicARN or PhoneNumber.
topicARNstringtopicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic. If you don’t specify this value, you must specify a value for the PhoneNumber or TargetARN.

.spec.receivers[].snsConfigs[].httpConfig​

Description
httpConfig defines the HTTP client configuration for SNS API requests.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].snsConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].snsConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].snsConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].snsConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].snsConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].snsConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].snsConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].snsConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].snsConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].snsConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].snsConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].snsConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].snsConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].sigv4​

Description
sigv4 configures AWS’s Signature Verification 4 signing process to sign requests. This includes AWS credentials and region configuration for authentication.
Type
`object`
PropertyTypeDescription
accessKeyobjectaccessKey defines the AWS API key. If not specified, the environment variable AWS_ACCESS_KEY_ID is used.
profilestringprofile defines the named AWS profile used to authenticate.
regionstringregion defines the AWS region. If blank, the region from the default credentials chain used.
roleArnstringroleArn defines the named AWS profile used to authenticate.
secretKeyobjectsecretKey defines the AWS API secret. If not specified, the environment variable AWS_SECRET_ACCESS_KEY is used.
useFIPSSTSEndpointbooleanuseFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. It requires Prometheus >= v2.54.0.

.spec.receivers[].snsConfigs[].sigv4.accessKey​

Description
accessKey defines the AWS API key. If not specified, the environment variable AWS_ACCESS_KEY_ID is used.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].snsConfigs[].sigv4.secretKey​

Description
secretKey defines the AWS API secret. If not specified, the environment variable AWS_SECRET_ACCESS_KEY is used.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs​

Description
telegramConfigs defines the list of Telegram configurations.
Type
`array`

.spec.receivers[].telegramConfigs[]​

Description
TelegramConfig configures notifications via Telegram. See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config
Type
`object`
Required
  • chatID
PropertyTypeDescription
apiURLstringapiURL defines the Telegram API URL, e.g. https://api.telegram.org. If not specified, the default Telegram API URL will be used.
botTokenobjectbotToken defines the Telegram bot token. It is mutually exclusive with botTokenFile. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either botToken or botTokenFile is required.
botTokenFilestringbotTokenFile defines the file to read the Telegram bot token from. It is mutually exclusive with botToken. Either botToken or botTokenFile is required. It requires Alertmanager >= v0.26.0.
chatIDintegerchatID defines the Telegram chat ID where messages will be sent. This can be a user ID, group ID, or channel ID (with @ prefix for public channels).
disableNotificationsbooleandisableNotifications controls whether Telegram notifications are sent silently. When true, users will receive the message without notification sounds.
httpConfigobjecthttpConfig defines the HTTP client configuration for Telegram API requests.
messagestringmessage defines the message template for the Telegram notification. This is the content that will be sent to the specified chat.
messageThreadIDintegermessageThreadID defines the Telegram Group Topic ID for threaded messages. This allows sending messages to specific topics within Telegram groups. It requires Alertmanager >= 0.26.0.
parseModestringparseMode defines the parse mode for telegram message formatting. Valid values are "MarkdownV2", "Markdown", and "HTML". This determines how text formatting is interpreted in the message.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.

.spec.receivers[].telegramConfigs[].botToken​

Description
botToken defines the Telegram bot token. It is mutually exclusive with botTokenFile. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either botToken or botTokenFile is required.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].telegramConfigs[].httpConfig​

Description
httpConfig defines the HTTP client configuration for Telegram API requests.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].telegramConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].telegramConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].telegramConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].telegramConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].telegramConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].telegramConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].telegramConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs​

Description
victoropsConfigs defines the list of VictorOps configurations.
Type
`array`

.spec.receivers[].victoropsConfigs[]​

Description
VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config
Type
`object`
Required
  • routingKey
PropertyTypeDescription
apiKeyobjectapiKey defines the secret’s key that contains the API key to use when talking to the VictorOps API. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
apiUrlstringapiUrl defines the VictorOps API URL. When not specified, defaults to the standard VictorOps API endpoint.
customFieldsarraycustomFields defines additional custom fields for notification. These provide extra metadata that will be included with the VictorOps incident.
customFields[]objectKeyValue defines a (key, value) tuple.
entityDisplayNamestringentityDisplayName contains a summary of the alerted problem. This appears as the main title or identifier for the incident.
httpConfigobjecthttpConfig defines the HTTP client’s configuration for VictorOps API requests.
messageTypestringmessageType describes the behavior of the alert. Valid values are "CRITICAL", "WARNING", and "INFO".
monitoringToolstringmonitoringTool defines the monitoring tool the state message is from. This helps identify the source system that generated the alert.
routingKeystringroutingKey defines a key used to map the alert to a team. This determines which VictorOps team will receive the alert notification.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
stateMessagestringstateMessage contains a long explanation of the alerted problem. This provides detailed context about the incident.

.spec.receivers[].victoropsConfigs[].apiKey​

Description
apiKey defines the secret’s key that contains the API key to use when talking to the VictorOps API. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].victoropsConfigs[].customFields​

Description
customFields defines additional custom fields for notification. These provide extra metadata that will be included with the VictorOps incident.
Type
`array`

.spec.receivers[].victoropsConfigs[].customFields[]​

Description
KeyValue defines a (key, value) tuple.
Type
`object`
Required
  • key
  • value
PropertyTypeDescription
keystringkey defines the key of the tuple. This is the identifier or name part of the key-value pair.
valuestringvalue defines the value of the tuple. This is the data or content associated with the key.

.spec.receivers[].victoropsConfigs[].httpConfig​

Description
httpConfig defines the HTTP client’s configuration for VictorOps API requests.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].victoropsConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].victoropsConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].victoropsConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].victoropsConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs​

Description
webexConfigs defines the list of Webex configurations.
Type
`array`

.spec.receivers[].webexConfigs[]​

Description
WebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config
Type
`object`
Required
  • roomID
PropertyTypeDescription
apiURLstringapiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages
httpConfigobjecthttpConfig defines the HTTP client’s configuration. You must use this configuration to supply the bot token as part of the HTTP Authorization header.
messagestringmessage defines the message template
roomIDstringroomID defines the ID of the Webex Teams room where to send the messages.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.

.spec.receivers[].webexConfigs[].httpConfig​

Description
httpConfig defines the HTTP client’s configuration. You must use this configuration to supply the bot token as part of the HTTP Authorization header.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].webexConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].webexConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].webexConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].webexConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].webexConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].webexConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].webexConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].webexConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].webexConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].webexConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].webexConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].webexConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].webexConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webexConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs​

Description
webhookConfigs defines the List of webhook configurations.
Type
`array`

.spec.receivers[].webhookConfigs[]​

Description
WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config
Type
`object`
PropertyTypeDescription
httpConfigobjecthttpConfig defines the HTTP client configuration for webhook requests.
maxAlertsintegermaxAlerts defines the maximum number of alerts to be sent per webhook message. When 0, all alerts are included in the webhook payload.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
timeoutstringtimeout defines the maximum time to wait for a webhook request to complete, before failing the request and allowing it to be retried. It requires Alertmanager >= v0.28.0.
urlstringurl defines the URL to send HTTP POST requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined.
urlSecretobjecturlSecret defines the secret’s key that contains the webhook URL to send HTTP requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

.spec.receivers[].webhookConfigs[].httpConfig​

Description
httpConfig defines the HTTP client configuration for webhook requests.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].webhookConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].webhookConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].webhookConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].webhookConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].webhookConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].webhookConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].urlSecret​

Description
urlSecret defines the secret’s key that contains the webhook URL to send HTTP requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].wechatConfigs​

Description
wechatConfigs defines the list of WeChat configurations.
Type
`array`

.spec.receivers[].wechatConfigs[]​

Description
WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config
Type
`object`
PropertyTypeDescription
agentIDstringagentID defines the application agent ID within WeChat Work. This identifies which WeChat Work application will send the notifications.
apiSecretobjectapiSecret defines the secret’s key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
apiURLstringapiURL defines the WeChat API URL. When not specified, defaults to the standard WeChat Work API endpoint.
corpIDstringcorpID defines the corp id for authentication. This is the unique identifier for your WeChat Work organization.
httpConfigobjecthttpConfig defines the HTTP client configuration for WeChat API requests.
messagestringmessage defines the API request data as defined by the WeChat API. This contains the actual notification content to be sent.
messageTypestringmessageType defines the type of message to send. Valid values include "text", "markdown", and other WeChat Work supported message types.
sendResolvedbooleansendResolved defines whether or not to notify about resolved alerts.
toPartystringtoParty defines the target department(s) to receive the notification. Can be a single department ID or multiple department IDs separated by '|'.
toTagstringtoTag defines the target tag(s) to receive the notification. Can be a single tag ID or multiple tag IDs separated by '|'.
toUserstringtoUser defines the target user(s) to receive the notification. Can be a single user ID or multiple user IDs separated by '|'.

.spec.receivers[].wechatConfigs[].apiSecret​

Description
apiSecret defines the secret’s key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].wechatConfigs[].httpConfig​

Description
httpConfig defines the HTTP client configuration for WeChat API requests.
Type
`object`
PropertyTypeDescription
authorizationobjectauthorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
basicAuthobjectbasicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
bearerTokenSecretobjectbearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
enableHttp2booleanenableHttp2 can be used to disable HTTP2.
followRedirectsbooleanfollowRedirects defines whether HTTP requests follow HTTP 3xx redirects. When true, the client will automatically follow redirect responses.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
oauth2objectoauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyURLstringproxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over proxyUrl.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
tlsConfigobjecttlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.

.spec.receivers[].wechatConfigs[].httpConfig.authorization​

Description
authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.
Type
`object`
PropertyTypeDescription
credentialsobjectcredentials defines a key of a Secret in the namespace that contains the credentials for authentication.
typestringtype defines the authentication type. The value is case-insensitive.
"Basic" is not a supported value.
Default: "Bearer"

.spec.receivers[].wechatConfigs[].httpConfig.authorization.credentials​

Description
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.basicAuth​

Description
basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.
Type
`object`
PropertyTypeDescription
passwordobjectpassword defines a key of a Secret containing the password for authentication.
usernameobjectusername defines a key of a Secret containing the username for authentication.

.spec.receivers[].wechatConfigs[].httpConfig.basicAuth.password​

Description
password defines a key of a Secret containing the password for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.basicAuth.username​

Description
username defines a key of a Secret containing the username for authentication.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.bearerTokenSecret​

Description
bearerTokenSecret defines the secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.
Type
`object`
Required
  • key
  • name
PropertyTypeDescription
keystringkey defines the key of the secret to select from. Must be a valid secret key.
namestringname defines the name of the secret in the object’s namespace to select from.

.spec.receivers[].wechatConfigs[].httpConfig.oauth2​

Description
oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. This enables OAuth2 authentication flow for HTTP requests.
Type
`object`
Required
  • clientId
  • clientSecret
  • tokenUrl
PropertyTypeDescription
clientIdobjectclientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
clientSecretobjectclientSecret defines a key of a Secret containing the OAuth2 client’s secret.
endpointParamsobject (string)endpointParams configures the HTTP parameters to append to the token URL.
noProxystringnoProxy defines a 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.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeaderobjectproxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyConnectHeader{}array
proxyConnectHeader{}[]objectSecretKeySelector selects a key of a Secret.
proxyFromEnvironmentbooleanproxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).
It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
proxyUrlstringproxyUrl defines the HTTP proxy server to use.
scopesarray (string)scopes defines the OAuth2 scopes used for the token request.
tlsConfigobjecttlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
tokenUrlstringtokenUrl defines the URL to fetch the token from.

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientId​

Description
clientId defines a key of a Secret or ConfigMap containing the OAuth2 client’s ID.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientId.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientId.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.clientSecret​

Description
clientSecret defines a key of a Secret containing the OAuth2 client’s secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig​

Description
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.oauth2.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.proxyConnectHeader​

Description
proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
Type
`object`

.spec.receivers[].wechatConfigs[].httpConfig.proxyConnectHeader{}​

Description

Type
`array`

.spec.receivers[].wechatConfigs[].httpConfig.proxyConnectHeader{}[]​

Description
SecretKeySelector selects a key of a Secret.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig​

Description
tlsConfig defines the TLS configuration for the client. This includes settings for certificates, CA validation, and TLS protocol options.
Type
`object`
PropertyTypeDescription
caobjectca defines the Certificate authority used when verifying server certificates.
certobjectcert defines the Client certificate to present when doing client-authentication.
insecureSkipVerifybooleaninsecureSkipVerify defines how to disable target certificate validation.
keySecretobjectkeySecret defines the Secret containing the client key file for the targets.
maxVersionstringmaxVersion defines the maximum acceptable TLS version.
It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.
minVersionstringminVersion defines the minimum acceptable TLS version.
It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.
serverNamestringserverName is used to verify the hostname for the targets.

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca​

Description
ca defines the Certificate authority used when verifying server certificates.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert​

Description
cert defines the Client certificate to present when doing client-authentication.
Type
`object`
PropertyTypeDescription
configMapobjectconfigMap defines the ConfigMap containing data to use for the targets.
secretobjectsecret defines the Secret containing data to use for the targets.

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.configMap​

Description
configMap defines the ConfigMap containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key to select.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the ConfigMap or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.secret​

Description
secret defines the Secret containing data to use for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.keySecret​

Description
keySecret defines the Secret containing the client key file for the targets.
Type
`object`
Required
  • key
PropertyTypeDescription
keystringThe key of the secret to select from. Must be a valid secret key.
namestringName of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
optionalbooleanSpecify whether the Secret or its key must be defined

.spec.route​

Description
route defines the Alertmanager route definition for alerts matching the resource’s namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route.
Type
`object`
PropertyTypeDescription
activeTimeIntervalsarray (string)activeTimeIntervals is a list of TimeInterval names when this route should be active.
continuebooleancontinue defines the boolean indicating whether an alert should continue matching subsequent sibling nodes. It will always be overridden to true for the first-level route by the Prometheus operator.
groupByarray (string)groupBy defines the list of labels to group by. Labels must not be repeated (unique list). Special label "..." (aggregate by all possible labels), if provided, must be the only element in the list.
groupIntervalstringgroupInterval defines how long to wait before sending an updated notification. Must be greater than 0. Example: "5m"
groupWaitstringgroupWait defines how long to wait before sending the initial notification. Example: "30s"
matchersarraymatchers defines the list of matchers that the alert’s labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the namespace label and adds a namespace: <object namespace> matcher.
matchers[]objectMatcher defines how to match on alert’s labels.
muteTimeIntervalsarray (string)muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,
receiverstringreceiver defines the name of the receiver for this route. If not empty, it should be listed in the receivers field.
repeatIntervalstringrepeatInterval defines how long to wait before repeating the last notification. Must be greater than 0. Example: "4h"
routesarray (undefined)routes defines the child routes.

.spec.route.matchers​

Description
matchers defines the list of matchers that the alert’s labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the namespace label and adds a namespace: <object namespace> matcher.
Type
`array`

.spec.route.matchers[]​

Description
Matcher defines how to match on alert’s labels.
Type
`object`
Required
  • name
PropertyTypeDescription
matchTypestringmatchType defines the match operation available with AlertManager >= v0.22.0. Takes precedence over Regex (deprecated) if non-empty. Valid values: "=" (equality), "!=" (inequality), "=" (regex match), "!" (regex non-match).
namestringname defines the label to match. This specifies which alert label should be evaluated.
valuestringvalue defines the label value to match. This is the expected value for the specified label.

.spec.timeIntervals​

Description
timeIntervals defines the list of timeIntervals specifying when the routes should be muted.
Type
`array`

.spec.timeIntervals[]​

Description
TimeInterval specifies the periods in time when notifications will be muted or active.
Type
`object`
Required
  • name
PropertyTypeDescription
namestringname of the time interval.
timeIntervalsarraytimeIntervals defines a list of TimePeriod.
timeIntervals[]objectTimePeriod describes periods of time.

.spec.timeIntervals[].timeIntervals​

Description
timeIntervals defines a list of TimePeriod.
Type
`array`

.spec.timeIntervals[].timeIntervals[]​

Description
TimePeriod describes periods of time.
Type
`object`
PropertyTypeDescription
daysOfMontharraydaysOfMonth defines a list of DayOfMonthRange
daysOfMonth[]objectDayOfMonthRange is an inclusive range of days of the month beginning at 1
monthsarray (string)months defines a list of MonthRange
timesarraytimes defines a list of TimeRange
times[]objectTimeRange defines a start and end time in 24hr format
weekdaysarray (string)weekdays defines a list of WeekdayRange
yearsarray (string)years defines a list of YearRange

.spec.timeIntervals[].timeIntervals[].daysOfMonth​

Description
daysOfMonth defines a list of DayOfMonthRange
Type
`array`

.spec.timeIntervals[].timeIntervals[].daysOfMonth[]​

Description
DayOfMonthRange is an inclusive range of days of the month beginning at 1
Type
`object`
PropertyTypeDescription
endintegerend of the inclusive range
startintegerstart of the inclusive range

.spec.timeIntervals[].timeIntervals[].times​

Description
times defines a list of TimeRange
Type
`array`

.spec.timeIntervals[].timeIntervals[].times[]​

Description
TimeRange defines a start and end time in 24hr format
Type
`object`
PropertyTypeDescription
endTimestringendTime defines the end time in 24hr format.
startTimestringstartTime defines the start time in 24hr format.

.status​

Description
status defines the status subresource. It is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled. Most recent observed status of the ServiceMonitor. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
Type
`object`
PropertyTypeDescription
bindingsarraybindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
bindings[]objectWorkloadBinding is a link between a configuration resource and a workload resource.

.status.bindings​

Description
bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.
Type
`array`

.status.bindings[]​

Description
WorkloadBinding is a link between a configuration resource and a workload resource.
Type
`object`
Required
  • group
  • name
  • namespace
  • resource
PropertyTypeDescription
conditionsarrayconditions defines the current state of the configuration resource when bound to the referenced Workload object.
conditions[]objectConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
groupstringgroup defines the group of the referenced resource.
namestringname defines the name of the referenced object.
namespacestringnamespace defines the namespace of the referenced object.
resourcestringresource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).

.status.bindings[].conditions​

Description
conditions defines the current state of the configuration resource when bound to the referenced Workload object.
Type
`array`

.status.bindings[].conditions[]​

Description
ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.
Type
`object`
Required
  • lastTransitionTime
  • status
  • type
PropertyTypeDescription
lastTransitionTimestringlastTransitionTime defines the time of the last update to the current status property.
messagestringmessage defines the human-readable message indicating details for the condition’s last transition.
observedGenerationintegerobservedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[].observedGeneration is 9, the condition is out of date with respect to the current state of the object.
reasonstringreason for the condition’s last transition.
statusstringstatus of the condition.
typestringtype of the condition being reported. Currently, only "Accepted" is supported.

API endpoints​

The following API endpoints are available:

  • /apis/monitoring.coreos.com/v1beta1/alertmanagerconfigs
    • GET: list objects of kind AlertmanagerConfig
  • /apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs
    • DELETE: delete collection of AlertmanagerConfig
    • GET: list objects of kind AlertmanagerConfig
    • POST: create an AlertmanagerConfig
  • /apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs/{name}
    • DELETE: delete an AlertmanagerConfig
    • GET: read the specified AlertmanagerConfig
    • PATCH: partially update the specified AlertmanagerConfig
    • PUT: replace the specified AlertmanagerConfig
  • /apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs/{name}/status
    • GET: read status of the specified AlertmanagerConfig
    • PATCH: partially update status of the specified AlertmanagerConfig
    • PUT: replace status of the specified AlertmanagerConfig

/apis/monitoring.coreos.com/v1beta1/alertmanagerconfigs​

HTTP method
`GET`
Description
list objects of kind AlertmanagerConfig

HTTP responses

HTTP codeReponse body
200 - OKAlertmanagerConfigList schema
401 - UnauthorizedEmpty

/apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs​

HTTP method
`DELETE`
Description
delete collection of AlertmanagerConfig

HTTP responses

HTTP codeReponse body
200 - OKStatus schema
401 - UnauthorizedEmpty
HTTP method
`GET`
Description
list objects of kind AlertmanagerConfig

HTTP responses

HTTP codeReponse body
200 - OKAlertmanagerConfigList schema
401 - UnauthorizedEmpty
HTTP method
`POST`
Description
create an AlertmanagerConfig

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

ParameterTypeDescription
bodyAlertmanagerConfig schema

HTTP responses

HTTP codeReponse body
200 - OKAlertmanagerConfig schema
201 - CreatedAlertmanagerConfig schema
202 - AcceptedAlertmanagerConfig schema
401 - UnauthorizedEmpty

/apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs/{name}​

Global path parameters

ParameterTypeDescription
namestringname of the AlertmanagerConfig
HTTP method
`DELETE`
Description
delete an AlertmanagerConfig

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP codeReponse body
200 - OKStatus schema
202 - AcceptedStatus schema
401 - UnauthorizedEmpty
HTTP method
`GET`
Description
read the specified AlertmanagerConfig

HTTP responses

HTTP codeReponse body
200 - OKAlertmanagerConfig schema
401 - UnauthorizedEmpty
HTTP method
`PATCH`
Description
partially update the specified AlertmanagerConfig

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP codeReponse body
200 - OKAlertmanagerConfig schema
401 - UnauthorizedEmpty
HTTP method
`PUT`
Description
replace the specified AlertmanagerConfig

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

ParameterTypeDescription
bodyAlertmanagerConfig schema

HTTP responses

HTTP codeReponse body
200 - OKAlertmanagerConfig schema
201 - CreatedAlertmanagerConfig schema
401 - UnauthorizedEmpty

/apis/monitoring.coreos.com/v1beta1/namespaces/{namespace}/alertmanagerconfigs/{name}/status​

Global path parameters

ParameterTypeDescription
namestringname of the AlertmanagerConfig
HTTP method
`GET`
Description
read status of the specified AlertmanagerConfig

HTTP responses

HTTP codeReponse body
200 - OKAlertmanagerConfig schema
401 - UnauthorizedEmpty
HTTP method
`PATCH`
Description
partially update status of the specified AlertmanagerConfig

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP codeReponse body
200 - OKAlertmanagerConfig schema
401 - UnauthorizedEmpty
HTTP method
`PUT`
Description
replace status of the specified AlertmanagerConfig

Query parameters

ParameterTypeDescription
dryRunstringWhen present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
fieldValidationstringfieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

ParameterTypeDescription
bodyAlertmanagerConfig schema

HTTP responses

HTTP codeReponse body
200 - OKAlertmanagerConfig schema
201 - CreatedAlertmanagerConfig schema
401 - UnauthorizedEmpty