Alert OpsGenie Heartbeat Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/v0.39.2/config/schemas/config.yaml#/properties/alerts/properties/opsGenieHeartbeat
Configure heartbeats to OpsGenie.
Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
---|---|---|---|---|---|---|---|
Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | config/schemas/config.yaml* |
TYPE:
object
(Alert OpsGenie Heartbeat)
PROPERTIES:
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
enabled | boolean |
Required | cannot be null | Compliant Kubernetes Apps Config |
name | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
url | string |
Optional | cannot be null | Compliant Kubernetes Apps Config |
enabled¶
enabled
-
is required
-
Type:
boolean
(OpsGenie Heartbeat Enabled) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean
(OpsGenie Heartbeat Enabled)
name¶
name
-
is optional
-
Type:
string
(OpsGenie Heartbeat Name) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string
(OpsGenie Heartbeat Name)
url¶
url
-
is optional
-
Type:
string
(OpsGenie Heartbeat URL) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string
(OpsGenie Heartbeat URL)
CONSTRAINTS:
URI: the string must be a URI, according to RFC 3986
DEFAULTS:
The default value is:
"https://api.eu.opsgenie.com/v2/heartbeats"
Return to the root config schema
Generated Thu Nov 14 16:14:40 UTC 2024 from elastisys/compliantkubernetes-apps@v0.39.2