AlertmanagerConfig (monitoring.coreos.com/v1alpha1)

Type: object

AlertmanagerConfig configures the Prometheus Alertmanager,
specifying how alerts should be grouped, inhibited and notified to external systems.

Type: string

APIVersion 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

Type: string

Kind 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

io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta

Type: object

Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: object

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

Each additional property must conform to the following schema

Type: string

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Type: integerFormat: int64

Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

Same definition as creationTimestamp

Type: array of string

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.

No Additional Items

Each item of this array must be:

Type: string

GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.

If this field is specified and the generated name exists, the server will return a 409.

Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

Type: integerFormat: int64

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

Type: object

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

Each additional property must conform to the following schema

Type: string

Type: array

ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry

Type: object

ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource that the fieldset applies to.

Type: string

APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.

Type: string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

io.k8s.apimachinery.pkg.apis.meta.v1.FieldsV1

Type: object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

Type: string

Manager is an identifier of the workflow managing these fields.

Type: string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

Type: string

Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.

io.k8s.apimachinery.pkg.apis.meta.v1.Time

Type: string

Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.

Same definition as creationTimestamp

Type: string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

Type: array

List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.

No Additional Items

Each item of this array must be:

io.k8s.apimachinery.pkg.apis.meta.v1.OwnerReference

Type: object

OwnerReference contains enough information to let you identify an owning object. An owning object must be in the same namespace as the dependent, or be cluster-scoped, so there is no namespace field.

Type: boolean

If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.

Type: boolean

If true, this reference points to the managing controller.

Type: string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

Type: string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

Type: string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: string

An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.

Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

Type: string

UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.

Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

Type: object

spec defines the specification of AlertmanagerConfigSpec

Type: array of object

inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching
the resource's namespace.

No Additional Items

Each item of this array must be:

Type: object

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: array of 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.

No Additional Items

Each item of this array must be:

Type: array of object

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.

No Additional Items

Each item of this array must be:

Type: object

Matcher defines how to match on alert's labels.

Type: enum (of string)

matchType 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).

Must be one of:

  • "!="
  • "="
  • "=~"
  • "!~"

Type: string

name defines the label to match.
This specifies which alert label should be evaluated.

Must be at least 1 characters long

Type: boolean

regex defines whether to match on equality (false) or regular-expression (true).
Deprecated: for AlertManager >= v0.22.0, matchType should be used instead.

Type: string

value defines the label value to match.
This is the expected value for the specified label.

Type: array of object

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).

No Additional Items

Each item of this array must be:

Type: object

Matcher defines how to match on alert's labels.

Type: enum (of string)

matchType 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).

Must be one of:

  • "!="
  • "="
  • "=~"
  • "!~"

Type: string

name defines the label to match.
This specifies which alert label should be evaluated.

Must be at least 1 characters long

Type: boolean

regex defines whether to match on equality (false) or regular-expression (true).
Deprecated: for AlertManager >= v0.22.0, matchType should be used instead.

Type: string

value defines the label value to match.
This is the expected value for the specified label.

Type: array of object

muteTimeIntervals defines the list of MuteTimeInterval specifying when the routes should be muted.

No Additional Items

Each item of this array must be:

Type: object

MuteTimeInterval specifies the periods in time when notifications will be muted

Type: string

name of the time interval

Type: array of object

timeIntervals defines a list of TimeInterval

No Additional Items

Each item of this array must be:

Type: object

TimeInterval describes intervals of time

Type: array of object

daysOfMonth defines a list of DayOfMonthRange

No Additional Items

Each item of this array must be:

Type: object

DayOfMonthRange is an inclusive range of days of the month beginning at 1

Type: integer

end of the inclusive range

Value must be greater or equal to -31 and lesser or equal to 31

Type: integer

start of the inclusive range

Value must be greater or equal to -31 and lesser or equal to 31

Type: array of string

months defines a list of MonthRange

No Additional Items

Each item of this array must be:

Type: string

MonthRange is an inclusive range of months of the year beginning in January
Months can be specified by name (e.g 'January') by numerical month (e.g '1') or as an inclusive range (e.g 'January:March', '1:3', '1:March')

Must match regular expression: ^((?i)january|february|march|april|may|june|july|august|september|october|november|december|1[0-2]|[1-9])(?:((:((?i)january|february|march|april|may|june|july|august|september|october|november|december|1[0-2]|[1-9]))$)|$)

Type: array of object

times defines a list of TimeRange

No Additional Items

Each item of this array must be:

Type: object

TimeRange defines a start and end time in 24hr format

Type: string

endTime defines the end time in 24hr format.

Must match regular expression: ^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)

Type: string

startTime defines the start time in 24hr format.

Must match regular expression: ^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)

Type: array of string

weekdays defines a list of WeekdayRange

No Additional Items

Each item of this array must be:

Type: string

WeekdayRange is an inclusive range of days of the week beginning on Sunday
Days can be specified by name (e.g 'Sunday') or as an inclusive range (e.g 'Monday:Friday')

Must match regular expression: ^((?i)sun|mon|tues|wednes|thurs|fri|satur)day(?:((:(sun|mon|tues|wednes|thurs|fri|satur)day)$)|$)

Type: array of string

years defines a list of YearRange

No Additional Items

Each item of this array must be:

Type: string

YearRange is an inclusive range of years

Must match regular expression: ^2\d{3}(?::2\d{3}|$)

Type: array of object

receivers defines the list of receivers.

No Additional Items

Each item of this array must be:

Type: object

Receiver defines one or more notification integrations.

Type: array of object

discordConfigs defines the list of Slack configurations.

No Additional Items

Each item of this array must be:

Type: object

DiscordConfig configures notifications via Discord.
See https://prometheus.io/docs/alerting/latest/configuration/#discord_config

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

avatarURL defines the avatar url of the message sender.

Must match regular expression: ^https?://.+$

Type: string

content defines the template of the content's body.

Must be at least 1 characters long

Type: object

httpConfig defines the HTTP client configuration.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

message defines the template of the message's body.

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: string

title defines the template of the message's title.

Type: string

username defines the username of the message sender.

Must be at least 1 characters long

Type: array of object

emailConfigs defines the list of Email configurations.

No Additional Items

Each item of this array must be:

Type: object

EmailConfig configures notifications via Email.

Type: string

authIdentity defines the identity to use for SMTP authentication.
This is typically used with PLAIN authentication mechanism.

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

authUsername defines the username to use for SMTP authentication.
This is used for SMTP AUTH when the server requires authentication.

Type: string

from defines the sender address for email notifications.
This appears as the "From" field in the email header.

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: object

KeyValue defines a (key, value) tuple.

Type: string

key defines the key of the tuple.
This is the identifier or name part of the key-value pair.

Must be at least 1 characters long

Type: string

value defines the value of the tuple.
This is the data or content associated with the key.

Type: string

hello defines the hostname to identify to the SMTP server.
This is used in the SMTP HELO/EHLO command during the connection handshake.

Type: string

html defines the HTML body of the email notification.
This allows for rich formatting in the email content.

Type: boolean

requireTLS defines the SMTP TLS requirement.
Note that Go does not support unencrypted connections to remote SMTP endpoints.

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: string

smarthost defines the SMTP host and port through which emails are sent.
Format should be "hostname:port", e.g. "smtp.example.com:587".

Type: string

text defines the plain text body of the email notification.
This provides a fallback for email clients that don't support HTML.

Type: object

tlsConfig defines the TLS configuration for SMTP connections.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

to defines the email address to send notifications to.
This is the recipient address for alert notifications.

Type: array of object

msteamsConfigs defines the list of MSTeams configurations.
It requires Alertmanager >= 0.26.0.

No Additional Items

Each item of this array must be:

Type: object

MSTeamsConfig configures notifications via Microsoft Teams.
It requires Alertmanager >= 0.26.0.

Type: object

httpConfig defines the HTTP client configuration for Teams webhook requests.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: string

summary 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.

Type: string

text defines the message body template for Teams notifications.
This contains the detailed content of the Teams message.

Type: string

title defines the message title template for Teams notifications.
This appears as the main heading of the Teams message card.

Type: object

webhookUrl defines the MSTeams webhook URL for sending notifications.
This is the incoming webhook URL configured in your Teams channel.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: array of object

msteamsv2Configs defines the list of MSTeamsV2 configurations.
It requires Alertmanager >= 0.28.0.

No Additional Items

Each item of this array must be:

Type: object

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

httpConfig defines the HTTP client configuration for Teams webhook requests.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: string

text defines the message body template for adaptive card notifications.
This contains the detailed content displayed in the Teams adaptive card format.

Must be at least 1 characters long

Type: string

title defines the message title template for adaptive card notifications.
This appears as the main heading in the Teams adaptive card.

Must be at least 1 characters long

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

name defines the name of the receiver. Must be unique across all items from the list.

Must be at least 1 characters long

Type: array of object

opsgenieConfigs defines the list of OpsGenie configurations.

No Additional Items

Each item of this array must be:

Type: object

OpsGenieConfig configures notifications via OpsGenie.
See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config

Type: string

actions defines a comma separated list of actions that will be available for the alert.
These appear as action buttons in the OpsGenie interface.

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

apiURL defines the URL to send OpsGenie API requests to.
When not specified, defaults to the standard OpsGenie API endpoint.

Must match regular expression: ^https?://.+$

Type: string

description defines the detailed description of the incident.
This provides additional context beyond the message field.

Type: array of object

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.

No Additional Items

Each item of this array must be:

Type: object

KeyValue defines a (key, value) tuple.

Type: string

key defines the key of the tuple.
This is the identifier or name part of the key-value pair.

Must be at least 1 characters long

Type: string

value defines the value of the tuple.
This is the data or content associated with the key.

Type: string

entity defines an optional field that can be used to specify which domain alert is related to.
This helps group related alerts together in OpsGenie.

Type: object

httpConfig defines the HTTP client configuration for OpsGenie API requests.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

message defines the alert text limited to 130 characters.
This appears as the main alert title in OpsGenie.

Type: string

note defines an additional alert note.
This provides supplementary information about the alert.

Type: string

priority defines the priority level of alert.
Possible values are P1, P2, P3, P4, and P5, where P1 is highest priority.

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: object

OpsGenieConfigResponder defines a responder to an incident.
One of id, name or username has to be defined.

Type: string

id defines the unique identifier of the responder.
This corresponds to the responder's ID within OpsGenie.

Type: string

name defines the display name of the responder.
This is used when the responder is identified by name rather than ID.

Type: enum (of string)

type defines the type of responder.
Valid values include "user", "team", "schedule", and "escalation".
This determines how OpsGenie interprets the other identifier fields.

Must be one of:

  • "team"
  • "teams"
  • "user"
  • "escalation"
  • "schedule"

Type: string

username defines the username of the responder.
This is typically used for user-type responders when identifying by username.

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: string

source defines the backlink to the sender of the notification.
This helps identify where the alert originated from.

Type: string

tags defines a comma separated list of tags attached to the notifications.
These help categorize and filter alerts within OpsGenie.

Type: boolean

updateAlerts defines Whether to update message and description of the alert in OpsGenie if it already exists
By default, the alert is never updated in OpsGenie, the new message only appears in activity log.

Type: array of object

pagerdutyConfigs defines the List of PagerDuty configurations.

No Additional Items

Each item of this array must be:

Type: object

PagerDutyConfig configures notifications via PagerDuty.
See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config

Type: string

class defines the class/type of the event.

Must be at least 1 characters long

Type: string

client defines the client identification.

Must be at least 1 characters long

Type: string

clientURL defines the backlink to the sender of notification.

Type: string

component defines the part or component of the affected system that is broken.

Must be at least 1 characters long

Type: string

description of the incident.

Must be at least 1 characters long

Type: array of object

details defines the arbitrary key/value pairs that provide further detail about the incident.

No Additional Items

Each item of this array must be:

Type: object

KeyValue defines a (key, value) tuple.

Type: string

key defines the key of the tuple.
This is the identifier or name part of the key-value pair.

Must be at least 1 characters long

Type: string

value defines the value of the tuple.
This is the data or content associated with the key.

Type: string

group defines a cluster or grouping of sources.

Must be at least 1 characters long

Type: object

httpConfig defines the HTTP client configuration.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: object

PagerDutyImageConfig attaches images to an incident

Type: string

alt is the optional alternative text for the image.

Must be at least 1 characters long

Type: string

href defines the optional URL; makes the image a clickable link.

Type: string

src of the image being attached to the incident

Must be at least 1 characters long

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: object

PagerDutyLinkConfig attaches text links to an incident

Type: string

alt defines the text that describes the purpose of the link, and can be used as the link's text.

Must be at least 1 characters long

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

severity of the incident.

Must be at least 1 characters long

Type: string

source defines the unique location of the affected system.

Must be at least 1 characters long

Type: string

timeout is the maximum time allowed to invoke the pagerduty
It requires Alertmanager >= v0.30.0.

Must match regular expression: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

Type: string

url defines the URL to send requests to.

Must match regular expression: ^https?://.+$

Type: array of object

pushoverConfigs defines the list of Pushover configurations.

No Additional Items

Each item of this array must be:

Type: object

PushoverConfig configures notifications via Pushover.
See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config

Type: string

device defines the name of a specific device to send the notification to.
If not specified, the notification is sent to all user's devices.

Must be at least 1 characters long

Type: string

expire defines how long your notification will continue to be retried for,
unless the user acknowledges the notification. Only applies to priority 2 notifications.

Must match regular expression: ^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$

Type: boolean

html 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.

Type: object

httpConfig defines the HTTP client configuration for Pushover API requests.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

message defines the notification message content.
This is the main body text of the Pushover notification.

Must be at least 1 characters long

Type: boolean

monospace optional HTML/monospace formatting for the message, see https://pushover.net/api#html
html and monospace formatting are mutually exclusive.

Type: string

priority defines the notification priority level.
See https://pushover.net/api#priority for valid values and behavior.

Must be at least 1 characters long

Type: string

retry 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.

Must match regular expression: ^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: string

sound defines the name of one of the sounds supported by device clients.
This overrides the user's default sound choice for this notification.

Must be at least 1 characters long

Type: string

title defines the notification title displayed in the Pushover message.
This appears as the bold header text in the notification.

Must be at least 1 characters long

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

tokenFile 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.

Must be at least 1 characters long

Type: string

ttl defines the time to live for the alert notification.
This determines how long the notification remains active before expiring.

Must match regular expression: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

Type: string

url defines a supplementary URL shown alongside the message.
This creates a clickable link within the Pushover notification.

Type: string

urlTitle defines a title for the supplementary URL.
If not specified, the raw URL is shown instead.

Must be at least 1 characters long

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

userKeyFile 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.

Must be at least 1 characters long

Type: array of object

rocketchatConfigs defines the list of RocketChat configurations.
It requires Alertmanager >= 0.28.0.

No Additional Items

Each item of this array must be:

Type: object

RocketChatConfig configures notifications via RocketChat.
It requires Alertmanager >= 0.28.0.

Type: array of object

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

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

RocketChatActionConfig defines actions for RocketChat messages.

Type: string

msg defines the message to send when the button is clicked.
This allows the button to post a predefined message to the channel.

Must be at least 1 characters long

Type: string

text defines the button text displayed to users.
This is the label that appears on the interactive button.

Must be at least 1 characters long

Type: string

url defines the URL the button links to when clicked.
This creates a clickable button that opens the specified URL.

Type: string

apiURL defines the API URL for RocketChat.
Defaults to https://open.rocket.chat/ if not specified.

Must match regular expression: ^https?://.+$

Type: string

channel defines the channel to send alerts to.
This can be a channel name (e.g., "#alerts") or a direct message recipient.

Must be at least 1 characters long

Type: string

color defines the message color displayed in RocketChat.
This appears as a colored bar alongside the message.

Must be at least 1 characters long

Type: string

emoji defines the emoji to be displayed as an avatar.
If provided, this emoji will be used instead of the default avatar or iconURL.

Must be at least 1 characters long

Type: array of object

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

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

RocketChatFieldConfig defines additional fields for RocketChat messages.

Type: boolean

short defines whether this field should be a short field.
When true, the field may be displayed inline with other short fields to save space.

Type: string

title defines the title of this field.
This appears as bold text labeling the field content.

Must be at least 1 characters long

Type: string

value defines the value of this field, displayed underneath the title.
This contains the actual data or content for the field.

Must be at least 1 characters long

Type: object

httpConfig defines the HTTP client configuration for RocketChat API requests.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

iconURL defines the icon URL for the message avatar.
This displays a custom image as the message sender's avatar.

Type: string

imageURL defines the image URL to display within the message.
This embeds an image directly in the message attachment.

Type: boolean

linkNames defines whether to enable automatic linking of usernames and channels.
When true, @username and #channel references become clickable links.

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: boolean

shortFields defines whether to use short fields in the message layout.
When true, fields may be displayed side by side to save space.

Type: string

text defines the message text to send.
This is optional because attachments can be used instead of or alongside text.

Must be at least 1 characters long

Type: string

thumbURL defines the thumbnail URL for the message.
This displays a small thumbnail image alongside the message content.

Type: string

title defines the message title displayed prominently in the message.
This appears as bold text at the top of the message attachment.

Must be at least 1 characters long

Type: object

token defines the sender token for RocketChat authentication.
This is the personal access token or bot token used to authenticate API requests.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

tokenID defines the sender token ID for RocketChat authentication.
This is the user ID associated with the token used for API requests.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: array of object

slackConfigs defines the list of Slack configurations.

No Additional Items

Each item of this array must be:

Type: object

SlackConfig configures notifications via Slack.
See https://prometheus.io/docs/alerting/latest/configuration/#slack_config

Type: array of object

actions defines a list of Slack actions that are sent with each notification.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

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

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

dismissText defines the label for the cancel button in the dialog.
When not specified, defaults to "Cancel". This button cancels the action.

Must be at least 1 characters long

Type: string

okText defines the label for the confirmation button in the dialog.
When not specified, defaults to "Okay". This button proceeds with the action.

Must be at least 1 characters long

Type: string

text defines the main message displayed in the confirmation dialog.
This should be a clear question or statement asking the user to confirm their action.

Must be at least 1 characters long

Type: string

title defines the title text displayed at the top of the confirmation dialog.
When not specified, a default title will be used.

Must be at least 1 characters long

Type: string

name defines a unique identifier for the action within the message.
This value is sent back to your application when the action is triggered.

Must be at least 1 characters long

Type: string

style defines the visual appearance of the action element.
Valid values include "default", "primary" (green), and "danger" (red).

Must be at least 1 characters long

Type: string

text 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.

Must be at least 1 characters long

Type: string

type defines the type of interactive component.
Common values include "button" for clickable buttons and "select" for dropdown menus.

Must be at least 1 characters long

Type: string

url defines the URL to open when the action is triggered.
Only applicable for button-type actions. When set, clicking the button opens this URL.

Type: string

value defines the payload sent when the action is triggered.
This data is included in the callback sent to your application.

Must be at least 1 characters long

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

callbackId defines an identifier for the message used in interactive components.

Must be at least 1 characters long

Type: string

channel defines the channel or user to send notifications to.

Must be at least 1 characters long

Type: string

color 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.

Must be at least 1 characters long

Type: string

fallback defines a plain-text summary of the attachment for clients that don't support attachments.

Must be at least 1 characters long

Type: array of object

fields defines a list of Slack fields that are sent with each notification.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

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

short 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.

Type: string

title defines the label or header text displayed for this field.
This appears as bold text above the field value in the Slack message.

Must be at least 1 characters long

Type: string

value defines the content or data displayed for this field.
This appears below the title and can contain plain text or Slack markdown.

Must be at least 1 characters long

Type: object

httpConfig defines the HTTP client configuration.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

iconEmoji defines the emoji to use as the bot's avatar (e.g., ":ghost:").

Must be at least 1 characters long

Type: string

iconURL defines the URL to an image to use as the bot's avatar.

Type: string

imageURL defines the URL to an image file that will be displayed inside the message attachment.

Type: boolean

linkNames enables automatic linking of channel names and usernames in the message.
When true, @channel and @username will be converted to clickable links.

Type: array of string

mrkdwnIn defines which fields should be parsed as Slack markdown.
Valid values include "pretext", "text", and "fields".

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

Type: string

pretext defines optional text that appears above the message attachment block.

Must be at least 1 characters long

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: boolean

shortFields determines whether fields are displayed in a compact format.
When true, fields are shown side by side when possible.

Type: string

text defines the main text content of the Slack message attachment.

Must be at least 1 characters long

Type: string

thumbURL defines the URL to an image file that will be displayed as a thumbnail
on the right side of the message attachment.

Type: string

timeout 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.

Must match regular expression: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

Type: string

title defines the title text displayed in the Slack message attachment.

Must be at least 1 characters long

Type: string

username defines the slack bot user name.

Must be at least 1 characters long

Type: array of object

snsConfigs defines the list of SNS configurations

No Additional Items

Each item of this array must be:

Type: object

SNSConfig configures notifications via AWS SNS.
See https://prometheus.io/docs/alerting/latest/configuration/#sns_configs

Type: string

apiURL 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.

Type: object

attributes defines SNS message attributes as key-value pairs.
These provide additional metadata that can be used for message filtering and routing.

Each additional property must conform to the following schema

Type: string

Type: object

httpConfig defines the HTTP client configuration for SNS API requests.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

message defines the message content of the SNS notification.
This is the actual notification text that will be sent to subscribers.

Type: string

phoneNumber 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.

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: object

sigv4 configures AWS's Signature Verification 4 signing process to sign requests.
This includes AWS credentials and region configuration for authentication.

Type: object

accessKey defines the AWS API key. If not specified, the environment variable
AWS_ACCESS_KEY_ID is used.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

profile defines the named AWS profile used to authenticate.

Type: string

region defines the AWS region. If blank, the region from the default credentials chain used.

Type: string

roleArn defines the named AWS profile used to authenticate.

Type: object

secretKey defines the AWS API secret. If not specified, the environment
variable AWS_SECRET_ACCESS_KEY is used.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint.
It requires Prometheus >= v2.54.0.

Type: string

subject 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.

Type: string

targetARN 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.

Type: string

topicARN 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.

Type: array of object

telegramConfigs defines the list of Telegram configurations.

No Additional Items

Each item of this array must be:

Type: object

TelegramConfig configures notifications via Telegram.
See https://prometheus.io/docs/alerting/latest/configuration/#telegram_config

Type: string

apiURL defines the Telegram API URL, e.g. https://api.telegram.org.
If not specified, the default Telegram API URL will be used.

Must match regular expression: ^https?://.+$

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

botTokenFile 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.

Type: integerFormat: int64

chatID 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).

Type: boolean

disableNotifications controls whether Telegram notifications are sent silently.
When true, users will receive the message without notification sounds.

Type: object

httpConfig defines the HTTP client configuration for Telegram API requests.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

message defines the message template for the Telegram notification.
This is the content that will be sent to the specified chat.

Type: integerFormat: int64

messageThreadID 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.

Type: enum (of string)

parseMode 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.

Must be one of:

  • "MarkdownV2"
  • "Markdown"
  • "HTML"

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: array of object

victoropsConfigs defines the list of VictorOps configurations.

No Additional Items

Each item of this array must be:

Type: object

VictorOpsConfig configures notifications via VictorOps.
See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

apiUrl defines the VictorOps API URL.
When not specified, defaults to the standard VictorOps API endpoint.

Must match regular expression: ^https?://.+$

Type: array of object

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

No Additional Items

Each item of this array must be:

Type: object

KeyValue defines a (key, value) tuple.

Type: string

key defines the key of the tuple.
This is the identifier or name part of the key-value pair.

Must be at least 1 characters long

Type: string

value defines the value of the tuple.
This is the data or content associated with the key.

Type: string

entityDisplayName contains a summary of the alerted problem.
This appears as the main title or identifier for the incident.

Must be at least 1 characters long

Type: object

httpConfig defines the HTTP client's configuration for VictorOps API requests.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

messageType describes the behavior of the alert.
Valid values are "CRITICAL", "WARNING", and "INFO".

Must be at least 1 characters long

Type: string

monitoringTool defines the monitoring tool the state message is from.
This helps identify the source system that generated the alert.

Must be at least 1 characters long

Type: string

routingKey defines a key used to map the alert to a team.
This determines which VictorOps team will receive the alert notification.

Must be at least 1 characters long

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: string

stateMessage contains a long explanation of the alerted problem.
This provides detailed context about the incident.

Must be at least 1 characters long

Type: array of object

webexConfigs defines the list of Webex configurations.

No Additional Items

Each item of this array must be:

Type: object

WebexConfig configures notification via Cisco Webex
See https://prometheus.io/docs/alerting/latest/configuration/#webex_config

Type: string

apiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages

Must match regular expression: ^https?://.+$

Type: object

httpConfig defines the HTTP client's configuration.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

message defines the message template

Type: string

roomID defines the ID of the Webex Teams room where to send the messages.

Must be at least 1 characters long

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: array of object

webhookConfigs defines the List of webhook configurations.

No Additional Items

Each item of this array must be:

Type: object

WebhookConfig configures notifications via a generic receiver supporting the webhook payload.
See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config

Type: object

httpConfig defines the HTTP client configuration for webhook requests.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: integerFormat: int32

maxAlerts defines the maximum number of alerts to be sent per webhook message.
When 0, all alerts are included in the webhook payload.

Value must be greater or equal to 0

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: string

timeout 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.

Must match regular expression: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$

Type: string

url defines the URL to send HTTP POST requests to.
urlSecret takes precedence over url. One of urlSecret and url should be defined.

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: array of object

wechatConfigs defines the list of WeChat configurations.

No Additional Items

Each item of this array must be:

Type: object

WeChatConfig configures notifications via WeChat.
See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config

Type: string

agentID defines the application agent ID within WeChat Work.
This identifies which WeChat Work application will send the notifications.

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

apiURL defines the WeChat API URL.
When not specified, defaults to the standard WeChat Work API endpoint.

Must match regular expression: ^https?://.+$

Type: string

corpID defines the corp id for authentication.
This is the unique identifier for your WeChat Work organization.

Type: object

httpConfig defines the HTTP client configuration for WeChat API requests.

Type: object

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

credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: string

type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

Type: object

basicAuth defines the basic authentication credentials for the client.
This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.

Type: object

password defines a key of a Secret containing the password for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

username defines a key of a Secret containing the username for
authentication.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

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

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

enableHttp2 can be used to disable HTTP2.

Type: boolean

followRedirects specifies whether the client should follow HTTP 3xx redirects.
When true, the client will automatically follow redirect responses.

Type: string

noProxy 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.

Type: object

oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.
This enables OAuth2 authentication flow for HTTP requests.

Type: object

clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

clientSecret defines a key of a Secret containing the OAuth2
client's secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

endpointParams configures the HTTP parameters to append to the token
URL.

Each additional property must conform to the following schema

Type: string

Type: string

noProxy 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.

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: array of string

scopes defines the OAuth2 scopes used for the token request.

No Additional Items

Each item of this array must be:

Type: object

tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

tokenUrl defines the URL to fetch the token from.

Must be at least 1 characters long

Type: object

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.

Each additional property must conform to the following schema

Type: array of object
No Additional Items

Each item of this array must be:

Type: object

SecretKeySelector selects a key of a Secret.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTPPROXY, HTTPSPROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

Type: string

proxyURL defines an optional proxy URL for HTTP requests.
If defined, this field takes precedence over proxyUrl.

Type: string

proxyUrl defines the HTTP proxy server to use.

Must match regular expression: ^(http|https|socks5)://.+$

Type: object

tlsConfig defines the TLS configuration for the client.
This includes settings for certificates, CA validation, and TLS protocol options.

Type: object

ca defines the Certificate authority used when verifying server certificates.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: object

cert defines the Client certificate to present when doing client-authentication.

Type: object

configMap defines the ConfigMap containing data to use for the targets.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the ConfigMap or its key must be defined

Type: object

secret defines the Secret containing data to use for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: boolean

insecureSkipVerify defines how to disable target certificate validation.

Type: object

keySecret defines the Secret containing the client key file for the targets.

Type: string

The key of the secret to select from. Must be a valid secret key.

Type: string

Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

Type: boolean

Specify whether the Secret or its key must be defined

Type: enum (of string)

maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: enum (of string)

minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

Must be one of:

  • "TLS10"
  • "TLS11"
  • "TLS12"
  • "TLS13"

Type: string

serverName is used to verify the hostname for the targets.

Type: string

message defines the API request data as defined by the WeChat API.
This contains the actual notification content to be sent.

Type: string

messageType defines the type of message to send.
Valid values include "text", "markdown", and other WeChat Work supported message types.

Type: boolean

sendResolved defines whether or not to notify about resolved alerts.

Type: string

toParty defines the target department(s) to receive the notification.
Can be a single department ID or multiple department IDs separated by '|'.

Type: string

toTag defines the target tag(s) to receive the notification.
Can be a single tag ID or multiple tag IDs separated by '|'.

Type: string

toUser defines the target user(s) to receive the notification.
Can be a single user ID or multiple user IDs separated by '|'.

Type: object

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: array of string

activeTimeIntervals is a list of MuteTimeInterval names when this route should be active.

No Additional Items

Each item of this array must be:

Type: boolean

continue 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.

Type: array of 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.

No Additional Items

Each item of this array must be:

Type: string

Type: string

groupInterval defines how long to wait before sending an updated notification.
Must match the regular expression^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
Example: "5m"

Type: string

groupWait defines how long to wait before sending the initial notification.
Must match the regular expression^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
Example: "30s"

Type: array of object

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.

No Additional Items

Each item of this array must be:

Type: object

Matcher defines how to match on alert's labels.

Type: enum (of string)

matchType 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).

Must be one of:

  • "!="
  • "="
  • "=~"
  • "!~"

Type: string

name defines the label to match.
This specifies which alert label should be evaluated.

Must be at least 1 characters long

Type: boolean

regex defines whether to match on equality (false) or regular-expression (true).
Deprecated: for AlertManager >= v0.22.0, matchType should be used instead.

Type: string

value defines the label value to match.
This is the expected value for the specified label.

Type: array of string

muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,

No Additional Items

Each item of this array must be:

Type: string

receiver defines the name of the receiver for this route. If not empty, it should be listed in
the receivers field.

Type: string

repeatInterval defines how long to wait before repeating the last notification.
Must match the regular expression^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$
Example: "4h"

Type: array

routes defines the child routes.

No Additional Items

Each item of this array must be:

Type: object

Type: object

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: array of object

bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource.

No Additional Items

Each item of this array must be:

Type: object

WorkloadBinding is a link between a configuration resource and a workload resource.

Type: array of object

conditions defines the current state of the configuration resource when bound to the referenced Workload object.

No Additional Items

Each item of this array must be:

Type: object

ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler.

Type: stringFormat: date-time

lastTransitionTime defines the time of the last update to the current status property.

Type: string

message defines the human-readable message indicating details for the condition's last transition.

Type: integerFormat: int64

observedGeneration 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.

Type: string

reason for the condition's last transition.

Type: string

status of the condition.

Must be at least 1 characters long

Type: enum (of string)

type of the condition being reported.
Currently, only "Accepted" is supported.

Must be one of:

  • "Accepted"

Type: enum (of string)

group defines the group of the referenced resource.

Must be one of:

  • "monitoring.coreos.com"

Type: string

name defines the name of the referenced object.

Must be at least 1 characters long

Type: string

namespace defines the namespace of the referenced object.

Must be at least 1 characters long

Type: enum (of string)

resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager).

Must be one of:

  • "prometheuses"
  • "prometheusagents"
  • "thanosrulers"
  • "alertmanagers"