Description

AlertmanagerConfig defines a namespaced AlertmanagerConfig to be aggregated across multiple namespaces configuring one Alertmanager cluster.

Type

object

Required
  • spec

Specification

Property Type Description

apiVersion

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

kind

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

metadata

ObjectMeta_v2 meta/v1

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

spec

object

AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration. By definition, the Alertmanager configuration only applies to alerts for which the namespace label is equal to the namespace of the AlertmanagerConfig resource.

.spec
Description

AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration. By definition, the Alertmanager configuration only applies to alerts for which the namespace label is equal to the namespace of the AlertmanagerConfig resource.

Type

object

Property Type Description

inhibitRules

array

List of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.

inhibitRules[]

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

receivers

array

List of receivers.

receivers[]

object

Receiver defines one or more notification integrations.

route

object

The Alertmanager route definition for alerts matching the resource’s namespace. It will be added to the generated Alertmanager configuration as a first-level route.

.spec.inhibitRules
Description

List of inhibition rules. The rules will only apply to alerts matching the resource’s namespace.

Type

array

.spec.inhibitRules[]
Description

InhibitRule defines an inhibition rule that allows to mute alerts when other alerts are already firing. See https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule

Type

object

Property Type Description

equal

array (string)

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

sourceMatch

array

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.

sourceMatch[]

object

Matcher defines how to match on alert’s labels.

targetMatch

array

Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace.

targetMatch[]

object

Matcher defines how to match on alert’s labels.

.spec.inhibitRules[].sourceMatch
Description

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.

Type

array

.spec.inhibitRules[].sourceMatch[]
Description

Matcher defines how to match on alert’s labels.

Type

object

Required
  • name

  • value

Property Type Description

name

string

Label to match.

regex

boolean

Whether to match on equality (false) or regular-expression (true).

value

string

Label value to match.

.spec.inhibitRules[].targetMatch
Description

Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace.

Type

array

.spec.inhibitRules[].targetMatch[]
Description

Matcher defines how to match on alert’s labels.

Type

object

Required
  • name

  • value

Property Type Description

name

string

Label to match.

regex

boolean

Whether to match on equality (false) or regular-expression (true).

value

string

Label value to match.

.spec.receivers
Description

List of receivers.

Type

array

.spec.receivers[]
Description

Receiver defines one or more notification integrations.

Type

object

Required
  • name

Property Type Description

emailConfigs

array

List of Email configurations.

emailConfigs[]

object

EmailConfig configures notifications via Email.

name

string

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

opsgenieConfigs

array

List of OpsGenie configurations.

opsgenieConfigs[]

object

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

pagerdutyConfigs

array

List of PagerDuty configurations.

pagerdutyConfigs[]

object

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

pushoverConfigs

array

List of Pushover configurations.

pushoverConfigs[]

object

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

slackConfigs

array

List of Slack configurations.

slackConfigs[]

object

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

victoropsConfigs

array

List of VictorOps configurations.

victoropsConfigs[]

object

VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config

webhookConfigs

array

List of webhook configurations.

webhookConfigs[]

object

WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config

wechatConfigs

array

List of WeChat configurations.

wechatConfigs[]

object

WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config

.spec.receivers[].emailConfigs
Description

List of Email configurations.

Type

array

.spec.receivers[].emailConfigs[]
Description

EmailConfig configures notifications via Email.

Type

object

Property Type Description

authIdentity

string

authPassword

object

SecretKeySelector selects a key of a Secret.

authSecret

object

SecretKeySelector selects a key of a Secret.

authUsername

string

SMTP authentication information.

from

string

The sender address.

headers

array

Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation.

headers[]

object

KeyValue defines a (key, value) tuple.

hello

string

The hostname to identify to the SMTP server.

html

string

The HTML body of the email notification.

requireTLS

boolean

The SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints.

sendResolved

boolean

Whether or not to notify about resolved alerts.

smarthost

string

The SMTP host through which emails are sent.

text

string

The text body of the email notification.

tlsConfig

object

TLS configuration

to

string

The email address to send notifications to.

.spec.receivers[].emailConfigs[].authPassword
Description

SecretKeySelector selects a key of a Secret.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].emailConfigs[].authSecret
Description

SecretKeySelector selects a key of a Secret.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].emailConfigs[].headers
Description

Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation.

Type

array

.spec.receivers[].emailConfigs[].headers[]
Description

KeyValue defines a (key, value) tuple.

Type

object

Required
  • key

  • value

Property Type Description

key

string

Key of the tuple.

value

string

Value of the tuple.

.spec.receivers[].emailConfigs[].tlsConfig
Description

TLS configuration

Type

object

Property Type Description

ca

object

Struct containing the CA cert to use for the targets.

cert

object

Struct containing the client cert file for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

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

Struct containing the CA cert to use for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

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

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

Struct containing the client cert file for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

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

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

Secret containing the client key file for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs
Description

List of OpsGenie configurations.

Type

array

.spec.receivers[].opsgenieConfigs[]
Description

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

Type

object

Property Type Description

apiKey

object

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.

apiURL

string

The URL to send OpsGenie API requests to.

description

string

Description of the incident.

details

array

A set of arbitrary key/value pairs that provide further detail about the incident.

details[]

object

KeyValue defines a (key, value) tuple.

httpConfig

object

HTTP client configuration.

message

string

Alert text limited to 130 characters.

note

string

Additional alert note.

priority

string

Priority level of alert. Possible values are P1, P2, P3, P4, and P5.

responders

array

List of responders responsible for notifications.

responders[]

object

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

sendResolved

boolean

Whether or not to notify about resolved alerts.

source

string

Backlink to the sender of the notification.

tags

string

Comma separated list of tags attached to the notifications.

.spec.receivers[].opsgenieConfigs[].apiKey
Description

The secret’s key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].details
Description

A set of arbitrary key/value pairs that provide further detail about the incident.

Type

array

.spec.receivers[].opsgenieConfigs[].details[]
Description

KeyValue defines a (key, value) tuple.

Type

object

Required
  • key

  • value

Property Type Description

key

string

Key of the tuple.

value

string

Value of the tuple.

.spec.receivers[].opsgenieConfigs[].httpConfig
Description

HTTP client configuration.

Type

object

Property Type Description

basicAuth

object

BasicAuth for the client.

bearerTokenSecret

object

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.

proxyURL

string

Optional proxy URL.

tlsConfig

object

TLS configuration for the client.

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

BasicAuth for the client.

Type

object

Property Type Description

password

object

The secret in the service monitor namespace that contains the password for authentication.

username

object

The secret in the service monitor namespace that contains the username for authentication.

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

The secret in the service monitor namespace that contains the password for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

The secret in the service monitor namespace that contains the username for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

TLS configuration for the client.

Type

object

Property Type Description

ca

object

Struct containing the CA cert to use for the targets.

cert

object

Struct containing the client cert file for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

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

Struct containing the CA cert to use for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

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

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

Struct containing the client cert file for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

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

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

Secret containing the client key file for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].opsgenieConfigs[].responders
Description

List of responders responsible for notifications.

Type

array

.spec.receivers[].opsgenieConfigs[].responders[]
Description

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

Type

object

Property Type Description

id

string

ID of the responder.

name

string

Name of the responder.

type

string

Type of responder.

username

string

Username of the responder.

.spec.receivers[].pagerdutyConfigs
Description

List of PagerDuty configurations.

Type

array

.spec.receivers[].pagerdutyConfigs[]
Description

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

Type

object

Property Type Description

class

string

The class/type of the event.

client

string

Client identification.

clientURL

string

Backlink to the sender of notification.

component

string

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

description

string

Description of the incident.

details

array

Arbitrary key/value pairs that provide further detail about the incident.

details[]

object

KeyValue defines a (key, value) tuple.

group

string

A cluster or grouping of sources.

httpConfig

object

HTTP client configuration.

routingKey

object

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.

sendResolved

boolean

Whether or not to notify about resolved alerts.

serviceKey

object

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.

severity

string

Severity of the incident.

url

string

The URL to send requests to.

.spec.receivers[].pagerdutyConfigs[].details
Description

Arbitrary key/value pairs that provide further detail about the incident.

Type

array

.spec.receivers[].pagerdutyConfigs[].details[]
Description

KeyValue defines a (key, value) tuple.

Type

object

Required
  • key

  • value

Property Type Description

key

string

Key of the tuple.

value

string

Value of the tuple.

.spec.receivers[].pagerdutyConfigs[].httpConfig
Description

HTTP client configuration.

Type

object

Property Type Description

basicAuth

object

BasicAuth for the client.

bearerTokenSecret

object

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.

proxyURL

string

Optional proxy URL.

tlsConfig

object

TLS configuration for the client.

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

BasicAuth for the client.

Type

object

Property Type Description

password

object

The secret in the service monitor namespace that contains the password for authentication.

username

object

The secret in the service monitor namespace that contains the username for authentication.

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

The secret in the service monitor namespace that contains the password for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

The secret in the service monitor namespace that contains the username for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

TLS configuration for the client.

Type

object

Property Type Description

ca

object

Struct containing the CA cert to use for the targets.

cert

object

Struct containing the client cert file for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

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

Struct containing the CA cert to use for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

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

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

Struct containing the client cert file for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

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

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

Secret containing the client key file for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].routingKey
Description

The secret’s key that contains the PagerDuty integration key (when using Events API v2). Either this field or serviceKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].pagerdutyConfigs[].serviceKey
Description

The secret’s key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or routingKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs
Description

List of Pushover configurations.

Type

array

.spec.receivers[].pushoverConfigs[]
Description

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

Type

object

Property Type Description

expire

string

How long your notification will continue to be retried for, unless the user acknowledges the notification.

html

boolean

Whether notification message is HTML or plain text.

httpConfig

object

HTTP client configuration.

message

string

Notification message.

priority

string

Priority, see https://pushover.net/api#priority

retry

string

How often the Pushover servers will send the same notification to the user. Must be at least 30 seconds.

sendResolved

boolean

Whether or not to notify about resolved alerts.

sound

string

The name of one of the sounds supported by device clients to override the user’s default sound choice

title

string

Notification title.

token

object

Your registered application’s API token, see https://pushover.net/apps

url

string

A supplementary URL shown alongside the message.

urlTitle

string

A title for supplementary URL, otherwise just the URL is shown

userKey

object

The recipient user’s user key.

.spec.receivers[].pushoverConfigs[].httpConfig
Description

HTTP client configuration.

Type

object

Property Type Description

basicAuth

object

BasicAuth for the client.

bearerTokenSecret

object

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.

proxyURL

string

Optional proxy URL.

tlsConfig

object

TLS configuration for the client.

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

BasicAuth for the client.

Type

object

Property Type Description

password

object

The secret in the service monitor namespace that contains the password for authentication.

username

object

The secret in the service monitor namespace that contains the username for authentication.

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

The secret in the service monitor namespace that contains the password for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

The secret in the service monitor namespace that contains the username for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

TLS configuration for the client.

Type

object

Property Type Description

ca

object

Struct containing the CA cert to use for the targets.

cert

object

Struct containing the client cert file for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

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

Struct containing the CA cert to use for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

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

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

Struct containing the client cert file for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

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

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

Secret containing the client key file for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].token
Description

Your registered application’s API token, see https://pushover.net/apps

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].pushoverConfigs[].userKey
Description

The recipient user’s user key.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs
Description

List of Slack configurations.

Type

array

.spec.receivers[].slackConfigs[]
Description

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

Type

object

Property Type Description

actions

array

A list of Slack actions that are sent with each notification.

actions[]

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.

apiURL

object

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.

callbackId

string

channel

string

The channel or user to send notifications to.

color

string

fallback

string

fields

array

A list of Slack fields that are sent with each notification.

fields[]

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.

footer

string

httpConfig

object

HTTP client configuration.

iconEmoji

string

iconURL

string

imageURL

string

linkNames

boolean

mrkdwnIn

array (string)

pretext

string

sendResolved

boolean

Whether or not to notify about resolved alerts.

shortFields

boolean

text

string

thumbURL

string

title

string

titleLink

string

username

string

.spec.receivers[].slackConfigs[].actions
Description

A list of Slack actions that are sent with each notification.

Type

array

.spec.receivers[].slackConfigs[].actions[]
Description

SlackAction configures a single Slack action that is sent with each notification. See https://api.slack.com/docs/message-attachments#action_fields and https://api.slack.com/docs/message-buttons for more information.

Type

object

Required
  • text

  • type

Property Type Description

confirm

object

SlackConfirmationField protect users from destructive actions or particularly distinguished decisions by asking them to confirm their button click one more time. See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields for more information.

name

string

style

string

text

string

type

string

url

string

value

string

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

SlackConfirmationField protect users from destructive actions or particularly distinguished decisions by asking them to confirm their button click one more time. See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields for more information.

Type

object

Required
  • text

Property Type Description

dismissText

string

okText

string

text

string

title

string

.spec.receivers[].slackConfigs[].apiURL
Description

The secret’s key that contains the Slack webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].slackConfigs[].fields
Description

A list of Slack fields that are sent with each notification.

Type

array

.spec.receivers[].slackConfigs[].fields[]
Description

SlackField configures a single Slack field that is sent with each notification. Each field must contain a title, value, and optionally, a boolean value to indicate if the field is short enough to be displayed next to other fields designated as short. See https://api.slack.com/docs/message-attachments#fields for more information.

Type

object

Required
  • title

  • value

Property Type Description

short

boolean

title

string

value

string

.spec.receivers[].slackConfigs[].httpConfig
Description

HTTP client configuration.

Type

object

Property Type Description

basicAuth

object

BasicAuth for the client.

bearerTokenSecret

object

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.

proxyURL

string

Optional proxy URL.

tlsConfig

object

TLS configuration for the client.

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

BasicAuth for the client.

Type

object

Property Type Description

password

object

The secret in the service monitor namespace that contains the password for authentication.

username

object

The secret in the service monitor namespace that contains the username for authentication.

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

The secret in the service monitor namespace that contains the password for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

The secret in the service monitor namespace that contains the username for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

TLS configuration for the client.

Type

object

Property Type Description

ca

object

Struct containing the CA cert to use for the targets.

cert

object

Struct containing the client cert file for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

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

Struct containing the CA cert to use for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

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

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

Struct containing the client cert file for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

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

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

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

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

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

Secret containing the client key file for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs
Description

List of VictorOps configurations.

Type

array

.spec.receivers[].victoropsConfigs[]
Description

VictorOpsConfig configures notifications via VictorOps. See https://prometheus.io/docs/alerting/latest/configuration/#victorops_config

Type

object

Required
  • routingKey

Property Type Description

apiKey

object

The API key to use when talking to the VictorOps API.

apiUrl

string

The VictorOps API URL.

customFields

array

Additional custom fields for notification.

customFields[]

object

KeyValue defines a (key, value) tuple.

entityDisplayName

string

Contains summary of the alerted problem.

httpConfig

object

The HTTP client’s configuration.

messageType

string

Describes the behavior of the alert (CRITICAL, WARNING, INFO).

monitoringTool

string

The monitoring tool the state message is from.

routingKey

string

A key used to map the alert to a team.

sendResolved

boolean

Whether or not to notify about resolved alerts.

stateMessage

string

Contains long explanation of the alerted problem.

.spec.receivers[].victoropsConfigs[].apiKey
Description

The API key to use when talking to the VictorOps API.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].customFields
Description

Additional custom fields for notification.

Type

array

.spec.receivers[].victoropsConfigs[].customFields[]
Description

KeyValue defines a (key, value) tuple.

Type

object

Required
  • key

  • value

Property Type Description

key

string

Key of the tuple.

value

string

Value of the tuple.

.spec.receivers[].victoropsConfigs[].httpConfig
Description

The HTTP client’s configuration.

Type

object

Property Type Description

basicAuth

object

BasicAuth for the client.

bearerTokenSecret

object

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.

proxyURL

string

Optional proxy URL.

tlsConfig

object

TLS configuration for the client.

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

BasicAuth for the client.

Type

object

Property Type Description

password

object

The secret in the service monitor namespace that contains the password for authentication.

username

object

The secret in the service monitor namespace that contains the username for authentication.

.spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.password
Description

The secret in the service monitor namespace that contains the password for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.basicAuth.username
Description

The secret in the service monitor namespace that contains the username for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.bearerTokenSecret
Description

The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig
Description

TLS configuration for the client.

Type

object

Property Type Description

ca

object

Struct containing the CA cert to use for the targets.

cert

object

Struct containing the client cert file for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca
Description

Struct containing the CA cert to use for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.configMap
Description

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.ca.secret
Description

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert
Description

Struct containing the client cert file for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.configMap
Description

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.cert.secret
Description

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].victoropsConfigs[].httpConfig.tlsConfig.keySecret
Description

Secret containing the client key file for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs
Description

List of webhook configurations.

Type

array

.spec.receivers[].webhookConfigs[]
Description

WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config

Type

object

Property Type Description

httpConfig

object

HTTP client configuration.

maxAlerts

integer

Maximum number of alerts to be sent per webhook message.

sendResolved

boolean

Whether or not to notify about resolved alerts.

url

string

The URL to send HTTP POST requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined.

urlSecret

object

The secret’s key that contains the webhook URL to send HTTP requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

.spec.receivers[].webhookConfigs[].httpConfig
Description

HTTP client configuration.

Type

object

Property Type Description

basicAuth

object

BasicAuth for the client.

bearerTokenSecret

object

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.

proxyURL

string

Optional proxy URL.

tlsConfig

object

TLS configuration for the client.

.spec.receivers[].webhookConfigs[].httpConfig.basicAuth
Description

BasicAuth for the client.

Type

object

Property Type Description

password

object

The secret in the service monitor namespace that contains the password for authentication.

username

object

The secret in the service monitor namespace that contains the username for authentication.

.spec.receivers[].webhookConfigs[].httpConfig.basicAuth.password
Description

The secret in the service monitor namespace that contains the password for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.basicAuth.username
Description

The secret in the service monitor namespace that contains the username for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.bearerTokenSecret
Description

The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig
Description

TLS configuration for the client.

Type

object

Property Type Description

ca

object

Struct containing the CA cert to use for the targets.

cert

object

Struct containing the client cert file for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca
Description

Struct containing the CA cert to use for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.configMap
Description

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.ca.secret
Description

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert
Description

Struct containing the client cert file for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.configMap
Description

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.cert.secret
Description

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].httpConfig.tlsConfig.keySecret
Description

Secret containing the client key file for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].webhookConfigs[].urlSecret
Description

The secret’s key that contains the webhook URL to send HTTP requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs
Description

List of WeChat configurations.

Type

array

.spec.receivers[].wechatConfigs[]
Description

WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config

Type

object

Property Type Description

agentID

string

apiSecret

object

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.

apiURL

string

The WeChat API URL.

corpID

string

The corp id for authentication.

httpConfig

object

HTTP client configuration.

message

string

API request data as defined by the WeChat API.

messageType

string

sendResolved

boolean

Whether or not to notify about resolved alerts.

toParty

string

toTag

string

toUser

string

.spec.receivers[].wechatConfigs[].apiSecret
Description

The secret’s key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig
Description

HTTP client configuration.

Type

object

Property Type Description

basicAuth

object

BasicAuth for the client.

bearerTokenSecret

object

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.

proxyURL

string

Optional proxy URL.

tlsConfig

object

TLS configuration for the client.

.spec.receivers[].wechatConfigs[].httpConfig.basicAuth
Description

BasicAuth for the client.

Type

object

Property Type Description

password

object

The secret in the service monitor namespace that contains the password for authentication.

username

object

The secret in the service monitor namespace that contains the username for authentication.

.spec.receivers[].wechatConfigs[].httpConfig.basicAuth.password
Description

The secret in the service monitor namespace that contains the password for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.basicAuth.username
Description

The secret in the service monitor namespace that contains the username for authentication.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.bearerTokenSecret
Description

The secret’s key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig
Description

TLS configuration for the client.

Type

object

Property Type Description

ca

object

Struct containing the CA cert to use for the targets.

cert

object

Struct containing the client cert file for the targets.

insecureSkipVerify

boolean

Disable target certificate validation.

keySecret

object

Secret containing the client key file for the targets.

serverName

string

Used to verify the hostname for the targets.

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca
Description

Struct containing the CA cert to use for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.configMap
Description

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.ca.secret
Description

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert
Description

Struct containing the client cert file for the targets.

Type

object

Property Type Description

configMap

object

ConfigMap containing data to use for the targets.

secret

object

Secret containing data to use for the targets.

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.configMap
Description

ConfigMap containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

The key to select.

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the ConfigMap or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.cert.secret
Description

Secret containing data to use for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.receivers[].wechatConfigs[].httpConfig.tlsConfig.keySecret
Description

Secret containing the client key file for the targets.

Type

object

Required
  • key

Property Type Description

key

string

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

name

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

optional

boolean

Specify whether the Secret or its key must be defined

.spec.route
Description

The Alertmanager route definition for alerts matching the resource’s namespace. It will be added to the generated Alertmanager configuration as a first-level route.

Type

object

Property Type Description

continue

boolean

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.

groupBy

array (string)

List of labels to group by.

groupInterval

string

How long to wait before sending an updated notification. Must match the regular expression [0-9]+(ms|s|m|h) (milliseconds seconds minutes hours).

groupWait

string

How long to wait before sending the initial notification. Must match the regular expression [0-9]+(ms|s|m|h) (milliseconds seconds minutes hours).

matchers

array

List of matchers that the alert’s labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the namespace label and adds a namespace: <object namespace> matcher.

matchers[]

object

Matcher defines how to match on alert’s labels.

receiver

string

Name of the receiver for this route. If present, it should be listed in the receivers field. The field can be omitted only for nested routes otherwise it is mandatory.

repeatInterval

string

How long to wait before repeating the last notification. Must match the regular expression [0-9]+(ms|s|m|h) (milliseconds seconds minutes hours).

routes

array (undefined)

Child routes.

.spec.route.matchers
Description

List of matchers that the alert’s labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the namespace label and adds a namespace: <object namespace> matcher.

Type

array

.spec.route.matchers[]
Description

Matcher defines how to match on alert’s labels.

Type

object

Required
  • name

  • value

Property Type Description

name

string

Label to match.

regex

boolean

Whether to match on equality (false) or regular-expression (true).

value

string

Label value to match.

API endpoints

The following API endpoints are available:

  • /apis/monitoring.coreos.com/v1alpha1/alertmanagerconfigs

    • GET: list objects of kind AlertmanagerConfig

  • /apis/monitoring.coreos.com/v1alpha1/namespaces/{namespace}/alertmanagerconfigs

    • DELETE: delete collection of AlertmanagerConfig

    • GET: list objects of kind AlertmanagerConfig

    • POST: create an AlertmanagerConfig

  • /apis/monitoring.coreos.com/v1alpha1/namespaces/{namespace}/alertmanagerconfigs/{name}

    • DELETE: delete an AlertmanagerConfig

    • GET: read the specified AlertmanagerConfig

    • PATCH: partially update the specified AlertmanagerConfig

    • PUT: replace the specified AlertmanagerConfig

/apis/monitoring.coreos.com/v1alpha1/alertmanagerconfigs

Table 1. Global guery parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

pretty

string

If 'true', then the output is pretty printed.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

HTTP method

GET

Description

list objects of kind AlertmanagerConfig

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

AlertmanagerConfigList monitoring.coreos.com/v1alpha1

401 - Unauthorized

Empty

/apis/monitoring.coreos.com/v1alpha1/namespaces/{namespace}/alertmanagerconfigs

Table 3. Global path parameters
Parameter Type Description

namespace

string

object name and auth scope, such as for teams and projects

Table 4. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

DELETE

Description

delete collection of AlertmanagerConfig

Table 5. Query parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 6. HTTP responses
HTTP code Reponse body

200 - OK

Status_v2 meta/v1

401 - Unauthorized

Empty

HTTP method

GET

Description

list objects of kind AlertmanagerConfig

Table 7. Query parameters
Parameter Type Description

allowWatchBookmarks

boolean

allowWatchBookmarks requests watch events with type "BOOKMARK". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored. If the feature gate WatchBookmarks is not enabled in apiserver, this field is ignored.

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the "next key".

This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

resourceVersionMatch

string

resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 8. HTTP responses
HTTP code Reponse body

200 - OK

AlertmanagerConfigList monitoring.coreos.com/v1alpha1

401 - Unauthorized

Empty

HTTP method

POST

Description

create an AlertmanagerConfig

Table 9. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 10. Body parameters
Parameter Type Description

body

AlertmanagerConfig monitoring.coreos.com/v1alpha1

Table 11. HTTP responses
HTTP code Reponse body

200 - OK

AlertmanagerConfig monitoring.coreos.com/v1alpha1

201 - Created

AlertmanagerConfig monitoring.coreos.com/v1alpha1

202 - Accepted

AlertmanagerConfig monitoring.coreos.com/v1alpha1

401 - Unauthorized

Empty

/apis/monitoring.coreos.com/v1alpha1/namespaces/{namespace}/alertmanagerconfigs/{name}

Table 12. Global path parameters
Parameter Type Description

name

string

name of the AlertmanagerConfig

namespace

string

object name and auth scope, such as for teams and projects

Table 13. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

DELETE

Description

delete an AlertmanagerConfig

Table 14. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 15. Body parameters
Parameter Type Description

body

DeleteOptions_v2 meta/v1

Table 16. HTTP responses
HTTP code Reponse body

200 - OK

Status_v2 meta/v1

202 - Accepted

Status_v2 meta/v1

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified AlertmanagerConfig

Table 17. Query parameters
Parameter Type Description

resourceVersion

string

resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.

Defaults to unset

Table 18. HTTP responses
HTTP code Reponse body

200 - OK

AlertmanagerConfig monitoring.coreos.com/v1alpha1

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified AlertmanagerConfig

Table 19. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 20. Body parameters
Parameter Type Description

body

Patch meta/v1

Table 21. HTTP responses
HTTP code Reponse body

200 - OK

AlertmanagerConfig monitoring.coreos.com/v1alpha1

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified AlertmanagerConfig

Table 22. Query parameters
Parameter Type Description

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldManager

string

fieldManager is a name associated with the actor or entity that is making these changes. The value must be less than or 128 characters long, and only contain printable characters, as defined by https://golang.org/pkg/unicode/#IsPrint.

Table 23. Body parameters
Parameter Type Description

body

AlertmanagerConfig monitoring.coreos.com/v1alpha1

Table 24. HTTP responses
HTTP code Reponse body

200 - OK

AlertmanagerConfig monitoring.coreos.com/v1alpha1

201 - Created

AlertmanagerConfig monitoring.coreos.com/v1alpha1

401 - Unauthorized

Empty