How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Yugabyte

Yugabyte Alerts API

The Alerts API from Yugabyte — 24 operation(s) for alerts.

Documentation Provider Profile APIs.io OpenAPI GitHub

Yugabyte Alerts API is one of 82 APIs that Yugabyte 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 27 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

36 operations 24 paths 27 schemas 6 DELETE12 GET13 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
https://docs.yugabyte.com
License
Polyform Free Trial License 1.0.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Yugabyte Alerts API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

  • apiKeyAuth — API token passed as 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
List all alert channel templates
listAlertChannelTemplates 1 param → 200
DELETE
/api/v1/customers/{cUUID}/alert_channel_templates/{acType}
Delete alert channel templates
deleteAlertChannelTemplates 3 params → 200
GET
/api/v1/customers/{cUUID}/alert_channel_templates/{acType}
Get alert channel templates
getAlertChannelTemplates 2 params → 200
POST
/api/v1/customers/{cUUID}/alert_channel_templates/{acType}
Set alert channel templates
setAlertChannelTemplates 3 params body → 200
GET
/api/v1/customers/{cUUID}/alert_channels
List all alert channels
listAlertChannels 1 param → 200
POST
/api/v1/customers/{cUUID}/alert_channels
Create an alert channel
createAlertChannel 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/alert_channels/{acUUID}
Delete an alert channel
deleteAlertChannel 3 params → 200
GET
/api/v1/customers/{cUUID}/alert_channels/{acUUID}
Get an alert channel
getAlertChannel 2 params → 200
PUT
/api/v1/customers/{cUUID}/alert_channels/{acUUID}
Update an alert channel
updateAlertChannel 3 params body → 200
POST
/api/v1/customers/{cUUID}/alert_configurations
Create an alert configuration
createAlertConfiguration 2 params body → 200
POST
/api/v1/customers/{cUUID}/alert_configurations/list
Get filtered list of alert configurations
listAlertConfigurations 2 params body → 200
POST
/api/v1/customers/{cUUID}/alert_configurations/page
List all alert configurations (paginated)
pageAlertConfigurations 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}
Delete an alert configuration
deleteAlertConfiguration 3 params → 200
GET
/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}
Get an alert configuration
getAlertConfiguration 2 params → 200
PUT
/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}
Update an alert configuration
updateAlertConfiguration 3 params body → 200
POST
/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}/test_alert
Send test alert for alert configuration
sendTestAlert 2 params → 200
GET
/api/v1/customers/{cUUID}/alert_destinations
List alert destinations
listAlertDestinations 1 param → 200
POST
/api/v1/customers/{cUUID}/alert_destinations
Create an alert destination
createAlertDestination 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/alert_destinations/{adUUID}
Delete an alert destination
deleteAlertDestination 3 params → 200
GET
/api/v1/customers/{cUUID}/alert_destinations/{adUUID}
Get an alert destination
getAlertDestination 2 params → 200
PUT
/api/v1/customers/{cUUID}/alert_destinations/{adUUID}
Update an alert destination
updateAlertDestination 3 params body → 200
POST
/api/v1/customers/{cUUID}/alert_notification_preview
Prepare alert notification preview
alertNotificationPreview 2 params body → 200
GET
/api/v1/customers/{cUUID}/alert_template_settingsdeprecated
Get alert template settings - deprecated
listAlertTemplateSettings 1 param → 200
PUT
/api/v1/customers/{cUUID}/alert_template_settingsdeprecated
Create or update alert template settings list - deprecated
editAlertTemplateSettings 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/alert_template_settings/{settingsUUID}deprecated
Delete an alert template settings - deprecated
deleteAlertTemplateSettings 3 params → 200
GET
/api/v1/customers/{cUUID}/alert_template_variables
List alert template variables
listAlertTemplateVariables 1 param → 200
PUT
/api/v1/customers/{cUUID}/alert_template_variables
Create or update alert template variables
editAlertTemplateVariables 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/alert_template_variables/{variableUUID}
Delete an alert template variables
deleteAlertTemplateVariables 3 params → 200
POST
/api/v1/customers/{cUUID}/alert_templates
Get filtered list of alert configuration templates
listAlertTemplates 2 params body → 200
GET
/api/v1/customers/{cUUID}/alerts
List all alerts
listOfAlerts 1 param → 200
POST
/api/v1/customers/{cUUID}/alerts/acknowledgedeprecated
Acknowledge all alerts - deprecated
acknowledgeByFilter 2 params body → 200
GET
/api/v1/customers/{cUUID}/alerts/activedeprecated
List active alerts - deprecated
listActive 1 param → 200
POST
/api/v1/customers/{cUUID}/alerts/count
Count alerts
countAlerts 2 params body → 200
POST
/api/v1/customers/{cUUID}/alerts/page
List alerts (paginated)
pageAlerts 2 params body → 200
GET
/api/v1/customers/{cUUID}/alerts/{alertUUID}
Get details of an alert
get 2 params → 200
POST
/api/v1/customers/{cUUID}/alerts/{alertUUID}/acknowledge
Acknowledge an alert
acknowledge 3 params → 200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are AlertConfigurationTemplate (23 properties), Alert (21 properties), AlertConfiguration (17 properties), AlertConfigurationApiFilter (9 properties). Each schema is shown below with its type and property counts.

AlertDestinationFormData
object
3 properties 3 required
AlertLabelKey
object
1 property 1 required
YBPSuccess
object
2 properties
AlertTemplateVariablesFormData
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
AlertConfigurationPagedApiQuery
object
6 properties 6 required
AlertConfiguration
object
Alert configuration
17 properties 13 required
AlertConfigurationPagedResponse
object
4 properties 4 required
AlertLabel
object
3 properties 3 required
AlertTemplateVariable
object
Alert template variable
5 properties 4 required
AlertChannelTemplates
object
Alert channel templates
4 properties 3 required
AlertConfigurationTemplate
object
Alert configuration template
23 properties 13 required
AlertChannelFormData
object
3 properties 3 required
AlertChannelParams
object
Supertype for channel params for different channel types.
3 properties
AlertPagedApiQuery
object
6 properties 6 required
AlertTemplateApiFilter
object
2 properties
AlertConfigurationThreshold
object
Alert configuration threshold. Conditions can be either greater than a specified value, or less than a specified value.
2 properties 2 required
AlertApiFilter
object
7 properties
Alert_channel_templates_ext_with_default_values
object
6 properties 3 required
AlertTemplateSettings
object
Alert template settings
5 properties 4 required
AlertTemplateSettingsFormData
object
1 property 1 required
AlertDestination
object
Alert notification destination
5 properties 4 required
Alert
object
Alert definition. Used to send an alert notification.
21 properties 14 required
AlertPagedResponse
object
4 properties 4 required
AlertTemplateVariablesList
object
2 properties 2 required
AlertChannel
object
Alert notification channel
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-alerts-api-openapi.yml Raw ↑

Other APIs Yugabyte publishes across the network.

YugabyteDB Aeon REST API
AE Profile APIs.io
Yugabyte Backup Info API
AE Profile APIs.io
Yugabyte Cluster API
AE Profile APIs.io
Yugabyte Cluster Info API
AE Profile APIs.io
Yugabyte Pitr Info API
AE Profile APIs.io
Yugabyte Restore Info API
AE Profile APIs.io
Yugabyte Voyager Info API
AE Profile APIs.io
Yugabyte Voyager Metrics API
AE Profile APIs.io
Yugabyte Xcluster Metrics API
AE Profile APIs.io
Yugabyte Xcluster Namespace Details API
AE Profile APIs.io
Yugabyte Access Keys API
AE Profile APIs.io
Yugabyte Accounts API
AE Profile APIs.io
#Alerts
← Back to Y APIs
API Details
ID
yugabyte:yugabyte-alerts-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://api-docs.yugabyte.com/docs/managed-apis/9u5yqnccbe8lk-yugabyte-db-aeon-rest-api
Provider
Yugabyte
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yugabyte-alerts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabyte-alerts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Yugabyte Alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.