# YugabyteDB Alerts API

**Canonical:** https://apis.io/apis/yugabyte/yugabytedb-alerts-api/  
**Provider:** Yugabyte — https://apis.io/providers/yugabyte/  
**Base URL:** https://cloud.yugabyte.com/api/public/v1  
**Documentation:** https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/

YugabyteDB Alerts API is one of 82 APIs that [Yugabyte](https://apis.io/providers/yugabyte/) publishes on the [APIs.io](https://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.

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

## Operations (36)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/customers/{cUUID}/alert_channel_templates` | List all alert channel templates |
| DELETE | `/api/v1/customers/{cUUID}/alert_channel_templates/{acType}` | Delete alert channel templates |
| GET | `/api/v1/customers/{cUUID}/alert_channel_templates/{acType}` | Get alert channel templates |
| POST | `/api/v1/customers/{cUUID}/alert_channel_templates/{acType}` | Set alert channel templates |
| GET | `/api/v1/customers/{cUUID}/alert_channels` | List all alert channels |
| POST | `/api/v1/customers/{cUUID}/alert_channels` | Create an alert channel |
| DELETE | `/api/v1/customers/{cUUID}/alert_channels/{acUUID}` | Delete an alert channel |
| GET | `/api/v1/customers/{cUUID}/alert_channels/{acUUID}` | Get an alert channel |
| PUT | `/api/v1/customers/{cUUID}/alert_channels/{acUUID}` | Update an alert channel |
| POST | `/api/v1/customers/{cUUID}/alert_configurations` | Create an alert configuration |
| POST | `/api/v1/customers/{cUUID}/alert_configurations/list` | Get filtered list of alert configurations |
| POST | `/api/v1/customers/{cUUID}/alert_configurations/page` | List all alert configurations (paginated) |
| DELETE | `/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}` | Delete an alert configuration |
| GET | `/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}` | Get an alert configuration |
| PUT | `/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}` | Update an alert configuration |
| POST | `/api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}/test_alert` | Send test alert for alert configuration |
| GET | `/api/v1/customers/{cUUID}/alert_destinations` | List alert destinations |
| POST | `/api/v1/customers/{cUUID}/alert_destinations` | Create an alert destination |
| DELETE | `/api/v1/customers/{cUUID}/alert_destinations/{adUUID}` | Delete an alert destination |
| GET | `/api/v1/customers/{cUUID}/alert_destinations/{adUUID}` | Get an alert destination |
| PUT | `/api/v1/customers/{cUUID}/alert_destinations/{adUUID}` | Update an alert destination |
| POST | `/api/v1/customers/{cUUID}/alert_notification_preview` | Prepare alert notification preview |
| GET | `/api/v1/customers/{cUUID}/alert_template_settings` | Get alert template settings - deprecated |
| PUT | `/api/v1/customers/{cUUID}/alert_template_settings` | Create or update alert template settings list - deprecated |
| DELETE | `/api/v1/customers/{cUUID}/alert_template_settings/{settingsUUID}` | Delete an alert template settings - deprecated |
| GET | `/api/v1/customers/{cUUID}/alert_template_variables` | List alert template variables |
| PUT | `/api/v1/customers/{cUUID}/alert_template_variables` | Create or update alert template variables |
| DELETE | `/api/v1/customers/{cUUID}/alert_template_variables/{variableUUID}` | Delete an alert template variables |
| POST | `/api/v1/customers/{cUUID}/alert_templates` | Get filtered list of alert configuration templates |
| GET | `/api/v1/customers/{cUUID}/alerts` | List all alerts |
| POST | `/api/v1/customers/{cUUID}/alerts/acknowledge` | Acknowledge all alerts - deprecated |
| GET | `/api/v1/customers/{cUUID}/alerts/active` | List active alerts - deprecated |
| POST | `/api/v1/customers/{cUUID}/alerts/count` | Count alerts |
| POST | `/api/v1/customers/{cUUID}/alerts/page` | List alerts (paginated) |
| GET | `/api/v1/customers/{cUUID}/alerts/{alertUUID}` | Get details of an alert |
| POST | `/api/v1/customers/{cUUID}/alerts/{alertUUID}/acknowledge` | Acknowledge an alert |

## Machine-readable artifacts (27)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/openapi/yugabytedb-alerts-api-openapi.yml
- **Documentation** — https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
- **APIReference** — https://api-docs.yugabyte.com/docs/managed-apis/
- **GettingStarted** — https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
- **Authentication** — https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/managed-apikeys/
- **CLI** — https://github.com/yugabyte/ybm-cli
- **Integrations** — https://github.com/yugabyte/terraform-provider-ybm
- **TermsOfService** — https://www.yugabyte.com/yugabytedb-managed-service-terms/
- **Documentation** — https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
- **APIReference** — https://api-docs.yugabyte.com/docs/yugabyte-platform/
- **GettingStarted** — https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
- **Authentication** — https://docs.yugabyte.com/stable/yugabyte-platform/anywhere-automation/anywhere-api/
- **SDKs** — https://github.com/yugabyte/platform-go-client
- **Integrations** — https://github.com/yugabyte/terraform-provider-yba
- **Integrations** — https://github.com/yugabyte/yugabyte-k8s-operator
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-backup.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-restore-job.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-storage-config.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-dr-config.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-pitr-config.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-release.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-support-bundle.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybprovider.yaml
- **KubernetesCRD** — https://raw.githubusercontent.com/api-evangelist/yugabyte/refs/heads/main/crd/yugabytedb-ybplatform.yaml

## Other Yugabyte APIs (12)

- [YugabyteDB Aeon REST API](https://apis.io/apis/yugabyte/yugabytedb-aeon-rest-api/)
- [Yugabyte Backup Info API](https://apis.io/apis/yugabyte/yugabyte-backup-info-api/)
- [Yugabyte Cluster API](https://apis.io/apis/yugabyte/yugabyte-cluster-api/)
- [Yugabyte Cluster Info API](https://apis.io/apis/yugabyte/yugabyte-cluster-info-api/)
- [Yugabyte Pitr Info API](https://apis.io/apis/yugabyte/yugabyte-pitr-info-api/)
- [Yugabyte Restore Info API](https://apis.io/apis/yugabyte/yugabyte-restore-info-api/)
- [Yugabyte Voyager Info API](https://apis.io/apis/yugabyte/yugabyte-voyager-info-api/)
- [Yugabyte Voyager Metrics API](https://apis.io/apis/yugabyte/yugabyte-voyager-metrics-api/)
- [Yugabyte Xcluster Metrics API](https://apis.io/apis/yugabyte/yugabyte-xcluster-metrics-api/)
- [Yugabyte Xcluster Namespace Details API](https://apis.io/apis/yugabyte/yugabyte-xcluster-namespace-details-api/)
- [YugabyteDB Access Keys API](https://apis.io/apis/yugabyte/yugabytedb-access-keys-api/)
- [YugabyteDB Accounts API](https://apis.io/apis/yugabyte/yugabytedb-accounts-api/)

## Tags

Alerts

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/yugabyte/yugabytedb-alerts-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/yugabyte/.