openapi: 3.0.3
info:
  title: Cumulocity Alarm Alarms Bayeux Handshake API
  version: 10.20.0
  description: 'Raise, query, acknowledge, clear, and bulk-update alarms with four severity levels (CRITICAL, MAJOR,

    MINOR, WARNING) and four statuses (ACTIVE, ACKNOWLEDGED, CLEARED). Cumulocity auto-deduplicates alarms

    by source + type so repeated raises increment the count rather than creating duplicates.

    '
servers:
- url: https://{tenant}.cumulocity.com
  variables:
    tenant:
      default: example
security:
- basicAuth: []
- bearerAuth: []
tags:
- name: Bayeux Handshake
paths:
  /notification/realtime:
    post:
      tags:
      - Bayeux Handshake
      summary: Bayeux Channel Endpoint (Handshake, Connect, Subscribe, Disconnect)
      operationId: bayeuxChannelEndpoint
      description: 'Single endpoint for the Bayeux/CometD protocol. The channel of the message body determines the

        action — `/meta/handshake`, `/meta/connect`, `/meta/subscribe`, `/meta/unsubscribe`,

        `/meta/disconnect`. Subscribe to channels such as `/measurements/{deviceId}`,

        `/events/{deviceId}`, `/alarms/{deviceId}`, `/operations/{deviceId}`, `/managedobjects/{deviceId}`.

        '
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BayeuxMessage'
      responses:
        '200':
          description: Bayeux protocol response.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BayeuxMessage'
components:
  schemas:
    BayeuxMessage:
      type: object
      required:
      - channel
      properties:
        channel:
          type: string
        clientId:
          type: string
        id:
          type: string
        data: {}
        successful:
          type: boolean
        subscription:
          type: string
        ext:
          type: object
        advice:
          type: object
        supportedConnectionTypes:
          type: array
          items:
            type: string
        connectionType:
          type: string
        version:
          type: string
        minimumVersion:
          type: string
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT