YugabyteDB Alerts API
The Alerts API from YugabyteDB — 24 operation(s) for alerts.
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 54 schemas. It is described by OpenAPI 3.1.0, at version v1.
Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.
36 operations
24 paths
54 schemas
6 DELETE12 GET13 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
YugabyteDB Alerts API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth— API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization header.
Paths & Operations 36
Across 24 paths, the API surfaces 36 operations — 6 DELETE, 12 GET, 13 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Alerts 36
GET
/api/v1/customers/{cUUID}/alert_channel_templates
YugabyteDB Anywhere List All Alert Channel Templates
DELETE
/api/v1/customers/{cUUID}/alert_channel_templates/{acType}
YugabyteDB Anywhere Delete Alert Channel Templates
GET
/api/v1/customers/{cUUID}/alert_channel_templates/{acType}
YugabyteDB Anywhere Get Alert Channel Templates
POST
/api/v1/customers/{cUUID}/alert_channel_templates/{acType}
YugabyteDB Anywhere Set Alert Channel Templates
GET
/api/v1/customers/{cUUID}/alert_channels
YugabyteDB Anywhere List All Alert Channels
POST
/api/v1/customers/{cUUID}/alert_channels
YugabyteDB Anywhere Create an Alert Channel
DELETE
/api/v1/customers/{cUUID}/alert_channels/{acUUID}
YugabyteDB Anywhere Delete an Alert Channel
GET
/api/v1/customers/{cUUID}/alert_channels/{acUUID}
YugabyteDB Anywhere Get an Alert Channel
PUT
/api/v1/customers/{cUUID}/alert_channels/{acUUID}
YugabyteDB Anywhere Update an Alert Channel
POST
/api/v1/customers/{cUUID}/alert_configurations
YugabyteDB Anywhere Create an Alert Configuration
POST
/api/v1/customers/{cUUID}/alert_configurations/list
YugabyteDB Anywhere Get Filtered List of Alert Configurations
POST
/api/v1/customers/{cUUID}/alert_configurations/page
YugabyteDB Anywhere List All Alert Configurations (paginated)
DELETE
/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}
YugabyteDB Anywhere Delete an Alert Configuration
GET
/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}
YugabyteDB Anywhere Get an Alert Configuration
PUT
/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}
YugabyteDB Anywhere Update an Alert Configuration
POST
/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}/test_alert
YugabyteDB Anywhere Send Test Alert for Alert Configuration
GET
/api/v1/customers/{cUUID}/alert_destinations
YugabyteDB Anywhere List Alert Destinations
POST
/api/v1/customers/{cUUID}/alert_destinations
YugabyteDB Anywhere Create an Alert Destination
DELETE
/api/v1/customers/{cUUID}/alert_destinations/{adUUID}
YugabyteDB Anywhere Delete an Alert Destination
GET
/api/v1/customers/{cUUID}/alert_destinations/{adUUID}
YugabyteDB Anywhere Get an Alert Destination
PUT
/api/v1/customers/{cUUID}/alert_destinations/{adUUID}
YugabyteDB Anywhere Update an Alert Destination
POST
/api/v1/customers/{cUUID}/alert_notification_preview
YugabyteDB Anywhere Prepare Alert Notification Preview
GET
/api/v1/customers/{cUUID}/alert_template_settingsdeprecated
YugabyteDB Anywhere Get Alert Template Settings - Deprecated
PUT
/api/v1/customers/{cUUID}/alert_template_settingsdeprecated
YugabyteDB Anywhere Create or Update Alert Template Settings List - Deprecated
DELETE
/api/v1/customers/{cUUID}/alert_template_settings/{settingsUUID}deprecated
YugabyteDB Anywhere Delete an Alert Template Settings - Deprecated
GET
/api/v1/customers/{cUUID}/alert_template_variables
YugabyteDB Anywhere List Alert Template Variables
PUT
/api/v1/customers/{cUUID}/alert_template_variables
YugabyteDB Anywhere Create or Update Alert Template Variables
DELETE
/api/v1/customers/{cUUID}/alert_template_variables/{variableUUID}
YugabyteDB Anywhere Delete an Alert Template Variables
POST
/api/v1/customers/{cUUID}/alert_templates
YugabyteDB Anywhere Get Filtered List of Alert Configuration Templates
GET
/api/v1/customers/{cUUID}/alerts
YugabyteDB Anywhere List All Alerts
POST
/api/v1/customers/{cUUID}/alerts/acknowledgedeprecated
YugabyteDB Anywhere Acknowledge All Alerts - Deprecated
GET
/api/v1/customers/{cUUID}/alerts/activedeprecated
YugabyteDB Anywhere List Active Alerts - Deprecated
POST
/api/v1/customers/{cUUID}/alerts/count
YugabyteDB Anywhere Count Alerts
POST
/api/v1/customers/{cUUID}/alerts/page
YugabyteDB Anywhere List Alerts (paginated)
GET
/api/v1/customers/{cUUID}/alerts/{alertUUID}
YugabyteDB Anywhere Get Details of an Alert
POST
/api/v1/customers/{cUUID}/alerts/{alertUUID}/acknowledge
YugabyteDB Anywhere Acknowledge an Alert
Schemas 54
The contract defines 54 schemas that model the data the API accepts and returns. The most detailed are AlertConfigurationTemplate_2 (23 properties), AlertConfigurationTemplate (23 properties), Alert (21 properties), Alert_2 (21 properties). Each schema is shown below with its type and property counts.
AlertLabelKey
object
1 property
1 required
AlertApiFilter
object
7 properties
AlertTemplateSettings
object
Alert template settings
5 properties
4 required
AlertTemplateVariable
object
Alert template variable
5 properties
4 required
AlertConfigurationTemplate
object
Alert configuration template
23 properties
13 required
AlertPagedApiQuery
object
6 properties
6 required
AlertConfigurationPagedResponse
object
4 properties
4 required
AlertChannelParams
object
Supertype for channel params for different channel types.
3 properties
AlertTemplateVariablesFormData
object
1 property
1 required
AlertChannelFormData
object
3 properties
3 required
AlertConfigurationApiFilter
object
9 properties
AlertConfigurationPagedApiQuery
object
6 properties
6 required
AlertChannel
object
Alert notification channel
4 properties
3 required
AlertTemplateVariablesList
object
2 properties
2 required
AlertConfiguration
object
Alert configuration
17 properties
13 required
AlertChannelTemplates
object
Alert channel templates
4 properties
3 required
Alert
object
Alert definition. Used to send an alert notification.
21 properties
14 required
YBPSuccess
object
2 properties
AlertLabel
object
3 properties
3 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
AlertDestination
object
Alert notification destination
5 properties
4 required
Alert channel templates ext with default values
object
6 properties
3 required
AlertTemplateSettingsFormData
object
1 property
1 required
AlertDestinationFormData
object
3 properties
3 required
AlertConfigurationTarget
object
Alert target. Set to all, or specify one or more target UUIDs.
2 properties
AlertTemplateApiFilter
object
2 properties
AlertPagedResponse
object
4 properties
4 required
AlertLabelKey_2
object
1 property
1 required
AlertApiFilter_2
object
7 properties
AlertTemplateSettings_2
object
Alert template settings
5 properties
4 required
AlertTemplateVariable_2
object
Alert template variable
5 properties
4 required
AlertConfigurationTemplate_2
object
Alert configuration template
23 properties
13 required
AlertPagedApiQuery_2
object
6 properties
6 required
AlertConfigurationPagedResponse_2
object
4 properties
4 required
AlertChannelParams_2
object
Supertype for channel params for different channel types.
3 properties
AlertTemplateVariablesFormData_2
object
1 property
1 required
AlertChannelFormData_2
object
3 properties
3 required
AlertConfigurationApiFilter_2
object
9 properties
AlertConfigurationPagedApiQuery_2
object
6 properties
6 required
AlertChannel_2
object
Alert notification channel
4 properties
3 required
AlertTemplateVariablesList_2
object
2 properties
2 required
AlertConfiguration_2
object
Alert configuration
17 properties
13 required
AlertChannelTemplates_2
object
Alert channel templates
4 properties
3 required
Alert_2
object
Alert definition. Used to send an alert notification.
21 properties
14 required
YBPSuccess_2
object
2 properties
AlertLabel_2
object
3 properties
3 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
AlertDestination_2
object
Alert notification destination
5 properties
4 required
Alert channel templates ext with default values_2
object
6 properties
3 required
AlertTemplateSettingsFormData_2
object
1 property
1 required
AlertDestinationFormData_2
object
3 properties
3 required
AlertConfigurationTarget_2
object
Alert target. Set to all, or specify one or more target UUIDs.
2 properties
AlertTemplateApiFilter_2
object
2 properties
AlertPagedResponse_2
object
4 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from YugabyteDB 12
Other APIs YugabyteDB publishes across the network.
YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API
YugabyteDB Clusters API
#Alerts