YugabyteDB Alerts API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.
This API exposes
36 operations
across 24 paths,
and defines 103 schemas.
It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, /.
The identity and technical contract details declared by the specification.
AlertTemplateVariable
object
Alert template variable
5 properties
4 required
AlertLabel
object
3 properties
3 required
AlertConfiguration
object
Alert configuration
17 properties
13 required
AlertLabelKey
object
1 property
1 required
AlertChannelParams
object
Supertype for channel params for different channel types.
3 properties
AlertConfigurationPagedResponse
object
4 properties
4 required
AlertTemplateApiFilter
object
2 properties
AlertChannelFormData
object
3 properties
3 required
AlertPagedResponse
object
4 properties
4 required
AlertApiFilter
object
7 properties
AlertDestination
object
Alert notification destination
5 properties
4 required
AlertConfigurationThreshold
object
Alert configuration threshold. Conditions can be either greater than a specified value, or less than a specified value.
2 properties
2 required
Alert_channel_templates_ext_with_default_values
object
6 properties
3 required
AlertConfigurationTemplate
object
Alert configuration template
23 properties
13 required
AlertTemplateSettings
object
Alert template settings
5 properties
4 required
AlertTemplateVariablesFormData
object
1 property
1 required
AlertTemplateVariablesList
object
2 properties
2 required
AlertChannel
object
Alert notification channel
4 properties
3 required
AlertTemplateSettingsFormData
object
1 property
1 required
AlertConfigurationApiFilter
object
9 properties
AlertConfigurationTarget
object
Alert target. Set to all, or specify one or more target UUIDs.
2 properties
Alert
object
Alert definition. Used to send an alert notification.
21 properties
14 required
AlertChannelTemplates
object
Alert channel templates
4 properties
3 required
AlertPagedApiQuery
object
6 properties
6 required
AlertDestinationFormData
object
3 properties
3 required
AlertConfigurationPagedApiQuery
object
6 properties
6 required
YBPSuccess
object
2 properties
AlertLabel_2
object
3 properties
3 required
AlertConfiguration_2
object
Alert configuration
16 properties
13 required
AlertLabelKey_2
object
1 property
1 required
AlertChannelParams_2
object
2 properties
2 required
AlertConfigurationPagedResponse_2
object
4 properties
4 required
AlertTemplateApiFilter_2
object
2 properties
2 required
AlertDefinitionLabelKey
object
1 property
1 required
AlertChannelFormData_2
object
3 properties
3 required
AlertPagedResponse_2
object
4 properties
4 required
AlertApiFilter_2
object
7 properties
7 required
AlertDestination_2
object
5 properties
5 required
AlertConfigurationThreshold_2
object
Alert configuration threshold. Conditions can be either greater than a specified value, or less than a specified value.
2 properties
2 required
AlertConfigurationTemplate_2
object
Alert configuration template
22 properties
13 required
AlertChannel_2
object
4 properties
4 required
AlertConfigurationApiFilter_2
object
9 properties
9 required
AlertDefinitionLabel
object
3 properties
3 required
AlertConfigurationTarget_2
object
Alert target. Set to all, or specify one or more target UUIDs.
2 properties
AlertDefinition
object
7 properties
7 required
Alert_2
object
Alert definition. Used to send an alert notification.
21 properties
14 required
AlertPagedApiQuery_2
object
6 properties
6 required
AlertDestinationFormData_2
object
3 properties
3 required
AlertConfigurationPagedApiQuery_2
object
6 properties
6 required
YBPSuccess_2
object
2 properties
AlertTemplateVariable_2
object
Alert template variable
5 properties
4 required
AlertLabel_3
object
3 properties
3 required
AlertConfiguration_3
object
Alert configuration
17 properties
13 required
AlertLabelKey_3
object
1 property
1 required
AlertChannelParams_3
object
Supertype for channel params for different channel types.
3 properties
AlertConfigurationPagedResponse_3
object
4 properties
4 required
AlertTemplateApiFilter_3
object
2 properties
AlertChannelFormData_3
object
3 properties
3 required
AlertPagedResponse_3
object
4 properties
4 required
AlertApiFilter_3
object
7 properties
AlertDestination_3
object
Alert notification destination
5 properties
4 required
AlertConfigurationThreshold_3
object
Alert configuration threshold. Conditions can be either greater than a specified value, or less than a specified value.
2 properties
2 required
AlertConfigurationTemplate_3
object
Alert configuration template
23 properties
13 required
AlertTemplateSettings_2
object
Alert template settings
5 properties
4 required
AlertTemplateVariablesFormData_2
object
1 property
1 required
AlertTemplateVariablesList_2
object
2 properties
2 required
AlertChannel_3
object
Alert notification channel
4 properties
3 required
AlertTemplateSettingsFormData_2
object
1 property
1 required
AlertConfigurationApiFilter_3
object
9 properties
AlertConfigurationTarget_3
object
Alert target. Set to all, or specify one or more target UUIDs.
2 properties
Alert_3
object
Alert definition. Used to send an alert notification.
21 properties
14 required
AlertChannelTemplates_2
object
Alert channel templates
4 properties
3 required
AlertPagedApiQuery_3
object
6 properties
6 required
AlertDestinationFormData_3
object
3 properties
3 required
AlertConfigurationPagedApiQuery_3
object
6 properties
6 required
YBPSuccess_3
object
2 properties
AlertTemplateVariable_3
object
Alert template variable
5 properties
4 required
AlertLabel_4
object
3 properties
3 required
AlertConfiguration_4
object
Alert configuration
17 properties
13 required
AlertLabelKey_4
object
1 property
1 required
AlertChannelParams_4
object
Supertype for channel params for different channel types.
3 properties
AlertConfigurationPagedResponse_4
object
4 properties
4 required
AlertTemplateApiFilter_4
object
2 properties
AlertChannelFormData_4
object
3 properties
3 required
AlertPagedResponse_4
object
4 properties
4 required
AlertApiFilter_4
object
7 properties
AlertDestination_4
object
Alert notification destination
5 properties
4 required
AlertConfigurationThreshold_4
object
Alert configuration threshold. Conditions can be either greater than a specified value, or less than a specified value.
2 properties
2 required
Alert_channel_templates_ext_with_default_values_2
object
6 properties
3 required
AlertConfigurationTemplate_4
object
Alert configuration template
23 properties
13 required
AlertTemplateSettings_3
object
Alert template settings
5 properties
4 required
AlertTemplateVariablesFormData_3
object
1 property
1 required
AlertTemplateVariablesList_3
object
2 properties
2 required
AlertChannel_4
object
Alert notification channel
4 properties
3 required
AlertTemplateSettingsFormData_3
object
1 property
1 required
AlertConfigurationApiFilter_4
object
9 properties
AlertConfigurationTarget_4
object
Alert target. Set to all, or specify one or more target UUIDs.
2 properties
Alert_4
object
Alert definition. Used to send an alert notification.
21 properties
14 required
AlertChannelTemplates_3
object
Alert channel templates
4 properties
3 required
AlertPagedApiQuery_4
object
6 properties
6 required
AlertDestinationFormData_4
object
3 properties
3 required
AlertConfigurationPagedApiQuery_4
object
6 properties
6 required
YBPSuccess_4
object
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs YugabyteDB publishes across the network.
