YugabyteDB Alerts API

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

Documentation

Specifications

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

OpenAPI Specification

yugabytedb-alerts-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: YugabyteDB Aeon REST Access Keys Alerts API
  description: The YugabyteDB Aeon REST API provides programmatic access to YugabyteDB's fully managed cloud database service. Developers and operators can use it to deploy and manage database clusters, configure read replicas, schedule and execute on-demand backups and restores, manage IP allow lists, and set up monitoring and alerts. Authentication is performed using API keys passed as bearer tokens in the Authorization header. All paths are scoped to an account and project, which can be obtained from the YugabyteDB Aeon UI profile page.
  version: v1
  contact:
    name: Yugabyte Support
    url: https://support.yugabyte.com
  termsOfService: https://www.yugabyte.com/yugabytedb-managed-service-terms/
  x-generated-from: documentation
  x-source-url: https://api-docs.yugabyte.com/docs/managed-apis/
  x-last-validated: '2026-05-03'
servers:
- url: https://cloud.yugabyte.com/api/public/v1
  description: YugabyteDB Aeon Production Server
security:
- bearerAuth: []
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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/Alert channel templates ext with default values'
                type: array
              examples:
                ListAlertChannelTemplates200Example:
                  summary: Default listAlertChannelTemplates 200 response
                  x-microcks-default: true
                  value: []
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List All Alert Channel Templates
      tags:
      - Alerts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: acType
        required: true
        schema:
          type: string
        example: DEFAULT
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
              examples:
                DeleteAlertChannelTemplates200Example:
                  summary: Default deleteAlertChannelTemplates 200 response
                  x-microcks-default: true
                  value:
                    success: true
                    message: message
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Delete Alert Channel Templates
      tags:
      - Alerts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: acType
        required: true
        schema:
          type: string
        example: DEFAULT
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Alert channel templates ext with default values'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get Alert Channel Templates
      tags:
      - Alerts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: acType
        required: true
        schema:
          type: string
        example: DEFAULT
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertChannelTemplates'
            examples:
              SetAlertChannelTemplatesRequestExample:
                summary: Default setAlertChannelTemplates request
                x-microcks-default: true
                value:
                  customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  textTemplate: textTemplate
                  type: Email
                  titleTemplate: titleTemplate
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertChannelTemplates'
              examples:
                SetAlertChannelTemplates200Example:
                  summary: Default setAlertChannelTemplates 200 response
                  x-microcks-default: true
                  value:
                    customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    textTemplate: textTemplate
                    type: Email
                    titleTemplate: titleTemplate
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Set Alert Channel Templates
      tags:
      - Alerts
      x-codegen-request-body-name: SetAlertChannelTemplatesRequest
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AlertChannel'
                type: array
              examples:
                ListAlertChannels200Example:
                  summary: Default listAlertChannels 200 response
                  x-microcks-default: true
                  value:
                  - customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    name: name
                    params:
                      channelType: Email
                      textTemplate: textTemplate
                      titleTemplate: titleTemplate
                    uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List All Alert Channels
      tags:
      - Alerts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertChannelFormData'
            examples:
              CreateAlertChannelRequestExample:
                summary: Default createAlertChannel request
                x-microcks-default: true
                value:
                  name: name
                  params:
                    channelType: Email
                    textTemplate: textTemplate
                    titleTemplate: titleTemplate
                  alertChannelUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertChannel'
              examples:
                CreateAlertChannel200Example:
                  summary: Default createAlertChannel 200 response
                  x-microcks-default: true
                  value:
                    customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    name: name
                    params:
                      channelType: Email
                      textTemplate: textTemplate
                      titleTemplate: titleTemplate
                    uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Create an Alert Channel
      tags:
      - Alerts
      x-codegen-request-body-name: CreateAlertChannelRequest
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: acUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
              examples:
                DeleteAlertChannel200Example:
                  summary: Default deleteAlertChannel 200 response
                  x-microcks-default: true
                  value:
                    success: true
                    message: message
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Delete an Alert Channel
      tags:
      - Alerts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: acUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertChannel'
              examples:
                GetAlertChannel200Example:
                  summary: Default getAlertChannel 200 response
                  x-microcks-default: true
                  value:
                    customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    name: name
                    params:
                      channelType: Email
                      textTemplate: textTemplate
                      titleTemplate: titleTemplate
                    uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get an Alert Channel
      tags:
      - Alerts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: acUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertChannelFormData'
            examples:
              UpdateAlertChannelRequestExample:
                summary: Default updateAlertChannel request
                x-microcks-default: true
                value:
                  name: name
                  params:
                    channelType: Email
                    textTemplate: textTemplate
                    titleTemplate: titleTemplate
                  alertChannelUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertChannel'
              examples:
                UpdateAlertChannel200Example:
                  summary: Default updateAlertChannel 200 response
                  x-microcks-default: true
                  value:
                    customer_uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    name: name
                    params:
                      channelType: Email
                      textTemplate: textTemplate
                      titleTemplate: titleTemplate
                    uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Update an Alert Channel
      tags:
      - Alerts
      x-codegen-request-body-name: UpdateAlertChannelRequest
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertConfiguration'
            examples:
              CreateAlertConfigurationRequestExample:
                summary: Default createAlertConfiguration request
                x-microcks-default: true
                value:
                  template: REPLICATION_LAG
                  active: true
                  description: description
                  targetType: PLATFORM
                  maintenanceWindowUuids:
                  - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  labels:
                    key: labels
                  target:
                    all: true
                    uuids:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  thresholds:
                    key:
                      condition: GREATER_THAN
                      threshold: 1.4658129805029452
                  customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  thresholdUnit: STATUS
                  alertCount: 0.8008281904610115
                  createTime: '2022-12-12T13:07:18+00:00'
                  defaultDestination: true
                  destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  name: name
                  durationSec: 0
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfiguration'
              examples:
                CreateAlertConfiguration200Example:
                  summary: Default createAlertConfiguration 200 response
                  x-microcks-default: true
                  value:
                    template: REPLICATION_LAG
                    active: true
                    description: description
                    targetType: PLATFORM
                    maintenanceWindowUuids:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    labels:
                      key: labels
                    target:
                      all: true
                      uuids:
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    thresholds:
                      key:
                        condition: GREATER_THAN
                        threshold: 1.4658129805029452
                    customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    thresholdUnit: STATUS
                    alertCount: 0.8008281904610115
                    createTime: 2022-12-12 13:07:18+00:00
                    defaultDestination: true
                    destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    name: name
                    durationSec: 0
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Create an Alert Configuration
      tags:
      - Alerts
      x-codegen-request-body-name: CreateAlertConfigurationRequest
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertConfigurationApiFilter'
            examples:
              ListAlertConfigurationsRequestExample:
                summary: Default listAlertConfigurations request
                x-microcks-default: true
                value:
                  severity: SEVERE
                  template: REPLICATION_LAG
                  destinationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  name: name
                  active: true
                  destinationType: NO_DESTINATION
                  targetType: PLATFORM
                  target:
                    all: true
                    uuids:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  uuids:
                  - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AlertConfiguration'
                type: array
              examples:
                ListAlertConfigurations200Example:
                  summary: Default listAlertConfigurations 200 response
                  x-microcks-default: true
                  value:
                  - template: REPLICATION_LAG
                    active: true
                    description: description
                    targetType: PLATFORM
                    maintenanceWindowUuids:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    labels:
                      key: labels
                    target:
                      all: true
                      uuids:
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    thresholds:
                      key:
                        condition: GREATER_THAN
                        threshold: 1.4658129805029452
                    customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    thresholdUnit: STATUS
                    alertCount: 0.8008281904610115
                    createTime: 2022-12-12 13:07:18+00:00
                    defaultDestination: true
                    destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    name: name
                    durationSec: 0
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get Filtered List of Alert Configurations
      tags:
      - Alerts
      x-codegen-request-body-name: ListAlertConfigurationsRequest
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertConfigurationPagedApiQuery'
            examples:
              PageAlertConfigurationsRequestExample:
                summary: Default pageAlertConfigurations request
                x-microcks-default: true
                value:
                  filter:
                    severity: SEVERE
                    template: REPLICATION_LAG
                    destinationUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    name: name
                    active: true
                    destinationType: NO_DESTINATION
                    targetType: PLATFORM
                    target:
                      all: true
                      uuids:
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    uuids:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  offset: 6
                  needTotalCount: true
                  limit: 0
                  sortBy: uuid
                  direction: ASC
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfigurationPagedResponse'
              examples:
                PageAlertConfigurations200Example:
                  summary: Default pageAlertConfigurations 200 response
                  x-microcks-default: true
                  value:
                    entities:
                    - template: REPLICATION_LAG
                      active: true
                      description: description
                      targetType: PLATFORM
                      maintenanceWindowUuids:
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      labels:
                        key: labels
                      target:
                        all: true
                        uuids:
                        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      thresholds:
                        key:
                          condition: GREATER_THAN
                          threshold: 1.4658129805029452
                      customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      thresholdUnit: STATUS
                      alertCount: 0.8008281904610115
                      createTime: 2022-12-12 13:07:18+00:00
                      defaultDestination: true
                      destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      name: name
                      durationSec: 0
                    - template: REPLICATION_LAG
                      active: true
                      description: description
                      targetType: PLATFORM
                      maintenanceWindowUuids:
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      labels:
                        key: labels
                      target:
                        all: true
                        uuids:
                        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      thresholds:
                        key:
                          condition: GREATER_THAN
                          threshold: 1.4658129805029452
                      customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      thresholdUnit: STATUS
                      alertCount: 0.8008281904610115
                      createTime: 2022-12-12 13:07:18+00:00
                      defaultDestination: true
                      destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      name: name
                      durationSec: 0
                    hasPrev: true
                    hasNext: true
                    totalCount: 0
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere List All Alert Configurations (paginated)
      tags:
      - Alerts
      x-codegen-request-body-name: PageAlertConfigurationsRequest
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: configurationUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
              examples:
                DeleteAlertConfiguration200Example:
                  summary: Default deleteAlertConfiguration 200 response
                  x-microcks-default: true
                  value:
                    success: true
                    message: message
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Delete an Alert Configuration
      tags:
      - Alerts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: configurationUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertConfiguration'
              examples:
                GetAlertConfiguration200Example:
                  summary: Default getAlertConfiguration 200 response
                  x-microcks-default: true
                  value:
                    template: REPLICATION_LAG
                    active: true
                    description: description
                    targetType: PLATFORM
                    maintenanceWindowUuids:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    labels:
                      key: labels
                    target:
                      all: true
                      uuids:
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    thresholds:
                      key:
                        condition: GREATER_THAN
                        threshold: 1.4658129805029452
                    customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    thresholdUnit: STATUS
                    alertCount: 0.8008281904610115
                    createTime: 2022-12-12 13:07:18+00:00
                    defaultDestination: true
                    destinationUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    name: name
                    durationSec: 0
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get an Alert Configuration
      tags:
      - Alerts
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: configurationUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertConfiguration'
            examples:
              UpdateAlertConfigurationRequestExample:
                summary: Default updateAlertConfiguration request
                x-microcks-default: true
                value:
                  template: REPLICATION_LAG
                  active: true
                  description: description
                  targetType: PLATFORM
                  maintenanceWindowUuids:
                  - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  labels:
                    key: labels
                  target:
                    all: true
                    uuids:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  thresholds:
                    key:
                      condition: GREATER_THAN
                      threshold: 1.4658129805029452
                  customerUUID: 046b6c7f-0

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