YugabyteDB

YugabyteDB Alerts API

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

GitHub OpenAPI

Operations 36

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 #

Documentation

📖
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/
📖
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/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-alerts-api-openapi.yml

Other Resources

🔗
CLI
https://github.com/yugabyte/ybm-cli
🔗
Integrations
https://github.com/yugabyte/terraform-provider-ybm
🔗
TermsOfService
https://www.yugabyte.com/yugabytedb-managed-service-terms/
🔗
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/yugabytedb/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-restore-job.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-storage-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-dr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-pitr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-release.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-support-bundle.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybprovider.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybplatform.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/yugabytedb-alerts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

yugabytedb-alerts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Yugabytedb Alerts API
  version: v1
  contact:
    name: https://docs.yugabyte.com
  license:
    name: Polyform Free Trial License 1.0.0
    url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt
  termsOfService: TODO(chirag)
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  - x-split-from differs across the merged source definitions and was not carried
  description: 'Operations tagged Alerts across 4 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json, yugabytedb-anywhere-v1-alerts-monitoring.yaml, yugabytedb-anywhere-v1-full.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: Alerts
paths:
  /api/v1/customers/{cUUID}/alert_channel_templates:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: listAlertChannelTemplates
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Alert_channel_templates_ext_with_default_values'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List all alert channel templates
      tags:
      - Alerts
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_channel_templates/{acType}:
    delete:
      description: 'WARNING: This is a preview API that could change.'
      operationId: deleteAlertChannelTemplates
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: acType
        required: true
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete alert channel templates
      tags:
      - Alerts
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getAlertChannelTemplates
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: acType
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert_channel_templates_ext_with_default_values'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get alert channel templates
      tags:
      - Alerts
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: setAlertChannelTemplates
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: acType
        required: true
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertChannelTemplates'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertChannelTemplates'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Set alert channel templates
      tags:
      - Alerts
      x-codegen-request-body-name: SetAlertChannelTemplatesRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_channels:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: listAlertChannels
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AlertChannel'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List all alert channels
      tags:
      - Alerts
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: createAlertChannel
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertChannelFormData'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertChannel'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create an alert channel
      tags:
      - Alerts
      x-codegen-request-body-name: CreateAlertChannelRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_channels/{acUUID}:
    delete:
      description: 'WARNING: This is a preview API that could change.'
      operationId: deleteAlertChannel
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: acUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete an alert channel
      tags:
      - Alerts
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getAlertChannel
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: acUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertChannel'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get an alert channel
      tags:
      - Alerts
    put:
      description: 'WARNING: This is a preview API that could change.'
      operationId: updateAlertChannel
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: acUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertChannelFormData'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertChannel'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Update an alert channel
      tags:
      - Alerts
      x-codegen-request-body-name: UpdateAlertChannelRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_configurations:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: createAlertConfiguration
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertConfiguration'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfiguration'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create an alert configuration
      tags:
      - Alerts
      x-codegen-request-body-name: CreateAlertConfigurationRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_configurations/list:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: listAlertConfigurations
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertConfigurationApiFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AlertConfiguration'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get filtered list of alert configurations
      tags:
      - Alerts
      x-codegen-request-body-name: ListAlertConfigurationsRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_configurations/page:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: pageAlertConfigurations
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertConfigurationPagedApiQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfigurationPagedResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List all alert configurations (paginated)
      tags:
      - Alerts
      x-codegen-request-body-name: PageAlertConfigurationsRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}:
    delete:
      description: 'WARNING: This is a preview API that could change.'
      operationId: deleteAlertConfiguration
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: configurationUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete an alert configuration
      tags:
      - Alerts
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getAlertConfiguration
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: configurationUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfiguration'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get an alert configuration
      tags:
      - Alerts
    put:
      description: 'WARNING: This is a preview API that could change.'
      operationId: updateAlertConfiguration
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: configurationUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertConfiguration'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfiguration'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Update an alert configuration
      tags:
      - Alerts
      x-codegen-request-body-name: UpdateAlertConfigurationRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_configurations/{configurationUUID}/test_alert:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: sendTestAlert
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: configurationUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Send test alert for alert configuration
      tags:
      - Alerts
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_destinations:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: listAlertDestinations
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AlertDestination'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List alert destinations
      tags:
      - Alerts
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: createAlertDestination
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertDestinationFormData'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertDestination'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create an alert destination
      tags:
      - Alerts
      x-codegen-request-body-name: CreateAlertDestinationRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_destinations/{adUUID}:
    delete:
      description: 'WARNING: This is a preview API that could change.'
      operationId: deleteAlertDestination
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: adUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete an alert destination
      tags:
      - Alerts
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getAlertDestination
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: adUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertDestination'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get an alert destination
      tags:
      - Alerts
    put:
      description: 'WARNING: This is a preview API that could change.'
      operationId: updateAlertDestination
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: adUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertDestinationFormData'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertDestination'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Update an alert destination
      tags:
      - Alerts
      x-codegen-request-body-name: UpdateAlertDestinationRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_notification_preview:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: alertNotificationPreview
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertTemplateVariablesFormData'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertTemplateVariablesList'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Prepare alert notification preview
      tags:
      - Alerts
      x-codegen-request-body-name: NotificationPreviewRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_template_settings:
    get:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.0.</b></p>
      operationId: listAlertTemplateSettings
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AlertTemplateSettings'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get alert template settings - deprecated
      tags:
      - Alerts
    put:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.0.</b></p>
      operationId: editAlertTemplateSettings
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertTemplateSettingsFormData'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AlertTemplateSettings'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create or update alert template settings list - deprecated
      tags:
      - Alerts
      x-codegen-request-body-name: EditAlertTemplateSettingsRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_template_settings/{settingsUUID}:
    delete:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.20.0.0.</b></p>
      operationId: deleteAlertTemplateSettings
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: settingsUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete an alert template settings - deprecated
      tags:
      - Alerts
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_template_variables:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: listAlertTemplateVariables
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertTemplateVariablesList'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List alert template variables
      tags:
      - Alerts
    put:
      description: 'WARNING: This is a preview API that could change.'
      operationId: editAlertTemplateVariables
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertTemplateVariablesFormData'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AlertTemplateVariable'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create or update alert template variables
      tags:
      - Alerts
      x-codegen-request-body-name: EditAlertTemplateVariablesRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_template_variables/{variableUUID}:
    delete:
      description: 'WARNING: This is a preview API that could change.'
      operationId: deleteAlertTemplateVariables
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: variableUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete an alert template variables
      tags:
      - Alerts
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alert_templates:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: listAlertTemplates
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertTemplateApiFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AlertConfigurationTemplate'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get filtered list of alert configuration templates
      tags:
      - Alerts
      x-codegen-request-body-name: ListTemplatesRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alerts:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: listOfAlerts
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Alert'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List all alerts
      tags:
      - Alerts
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alerts/acknowledge:
    post:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.8.0.0.</b></p>
      operationId: acknowledgeByFilter
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertApiFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Alert'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Acknowledge all alerts - deprecated
      tags:
      - Alerts
      x-codegen-request-body-name: AcknowledgeAlertsRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alerts/active:
    get:
      deprecated: true
      description: <b style="color:#ff0000">Deprecated since YBA version 2.8.0.0.</b></p>
      operationId: listActive
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Alert'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List active alerts - deprecated
      tags:
      - Alerts
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alerts/count:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: countAlerts
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertApiFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                format: int32
                type: integer
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Count alerts
      tags:
      - Alerts
      x-codegen-request-body-name: CountAlertsRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alerts/page:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: pageAlerts
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertPagedApiQuery'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertPagedResponse'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List alerts (paginated)
      tags:
      - Alerts
      x-codegen-request-body-name: PageAlertsRequest
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alerts/{alertUUID}:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: get
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: alertUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get details of an alert
      tags:
      - Alerts
    servers:
    - url: /
  /api/v1/customers/{cUUID}/alerts/{alertUUID}/acknowledge:
    post:
      description: 'WARNING: This is a preview API that could change.'
      operationId: acknowledge
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: alertUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Acknowledge an alert
      tags:
      - Alerts
    servers:
    - url: /
components:
  schemas:
    AlertTemplateVariable:
      description: Alert template variable
      example:
        possibleValues:
        - possibleValues
        - possibleValues
        - possibleValues
        - possibleValues
        - possibleValues
        customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        defaultValue: defaultValue
        name: name
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
        defaultValue:
          description: Default value
          maxLength: 2147483647
          minLength: 1
          type: string
        name:
          description: Name
          maxLength: 100
          minLength: 1
          type: string
        possibleValues:
          description: Possible values
          items:
            type: string
          maxItems: 2147483647
          minItems: 1
          type: array
          uniqueItems: true
        uuid:
     

# --- truncated at 32 KB (215 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-alerts-api-openapi.yml