Cisco Catalyst SD-WAN Monitoring - Alarms Details API

openapi: 3.2.0
info:
  title: Monitoring and Troubleshooting Monitoring - Alarms Details API
  description: "Includes API operations for the following:\n  Real-time monitoring\n  Accessing statistics APIs and statistics bulk APIs\n  Retrieving device state\n  Managing alarms and events"
  contact:
    email: vmanage@cisco.com
  license:
    name: Commercial License
    url: https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html
  version: 26.1.0+2026-01-06
  x-provenance:
    method: harvested
    authored_by: Cisco Catalyst SD-WAN
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    provider_published: true
    source_host: pubhub.devnetcloud.com
    note: 4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host.
  x-evidence:
  - type: source
    url: https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/
  - type: source
    url: https://developer.cisco.com/docs/sdwan/
servers:
- url: /dataservice
tags:
- name: Monitoring - Alarms Details
paths:
  /alarms:
    post:
      tags:
      - Monitoring - Alarms Details
      description: Get alarms for given query.
      operationId: postRawAlarmData
      parameters:
      - name: page
        in: query
        description: Specify page number. Value should be a positive integer
        schema:
          minimum: 1
          type: integer
          format: int64
      - name: pageSize
        in: query
        description: Specify page size. Value should be a positive integer
        schema:
          minimum: 1
          type: integer
          format: int64
      - name: sortBy
        in: query
        description: Specify a field by which alarms need to be sorted
        schema:
          pattern: ^[a-zA-Z-_]+$
          type: string
      - name: sortOrder
        in: query
        description: Select sorting order. Use ASC for ascending and DESC for descending
        schema:
          type: string
      - name: site-id
        in: query
        description: Specify the site-id to filter the alarms
        schema:
          pattern: ^[0-9]+$
          type: string
      - name: includeTenants
        in: query
        description: Specify whether the tenant alarms need to be visible or not from provider view.
        schema:
          type: boolean
      requestBody:
        description: Alarm query string
        content:
          application/json:
            schema:
              type: object
            examples:
              Get active alarms:
                description: Get active alarms
                value:
                  query:
                    condition: AND
                    rules:
                    - field: entry_time
                      operator: last_n_hours
                      type: date
                      value:
                      - '10'
                    - field: active
                      type: boolean
                      value:
                      - 'true'
                      operator: equal
                $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive'
              Get alarms filter by hours:
                description: Get alarms filter by hours
                value:
                  query:
                    condition: AND
                    rules:
                    - field: entry_time
                      operator: last_n_hours
                      type: date
                      value:
                      - '10'
                  size: 100
                $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours'
              Get alarms filter between dates:
                description: Get alarms filter between dates
                value:
                  query:
                    condition: AND
                    rules:
                    - field: entry_time
                      type: date
                      value:
                      - 2024-04-30T19:30:00 UTC
                      - 2024-05-30T17:30:00 UTC
                      operator: between
                  size: 10000
                $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates'
              Get alarms filter by type:
                description: Get alarms filter by type
                value:
                  query:
                    condition: AND
                    rules:
                    - field: entry_time
                      operator: last_n_hours
                      type: date
                      value:
                      - '10'
                    - field: rule_name_display
                      operator: in
                      type: string
                      value:
                      - Memory_Usage
                  size: 10000
                $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType'
              Get alarms filter by system ip:
                description: Get alarms filter by system ip
                value:
                  query:
                    condition: AND
                    rules:
                    - field: entry_time
                      operator: last_n_hours
                      type: date
                      value:
                      - '10'
                    - field: system_ip
                      operator: in
                      type: string
                      value:
                      - 1.1.1.1
                  size: 100
                $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp'
              Get alarms filter by severity:
                description: Get alarms filter by severity
                value:
                  query:
                    condition: AND
                    rules:
                    - field: entry_time
                      operator: last_n_hours
                      type: date
                      value:
                      - '10'
                    - field: severity
                      operator: in
                      type: string
                      value:
                      - Critical
                  size: 100
                $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity'
              Get alarms filter by site-id:
                description: Get alarms filter by site-id
                value:
                  query:
                    condition: AND
                    rules:
                    - field: entry_time
                      operator: last_n_hours
                      type: date
                      value:
                      - '10'
                    - field: site_id
                      operator: in
                      type: string
                      value:
                      - '400'
                      - '500'
                  size: 100
                $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        acknowledged:
                          type: boolean
                        active:
                          type: boolean
                        cleared_by:
                          type: string
                          format: uuid
                          example: 0a0dca23-11d5-4014-bfbb-976d3c6de492
                        cleared_events:
                          type: array
                          items:
                            type: string
                            format: uuid
                        cleared_time:
                          type: integer
                          format: int64
                          example: 1652894923722
                        component:
                          type: string
                          example: Schedule Telemetry collection
                        consumed_events:
                          type: array
                          items:
                            type: object
                            $$ref: '#/components/schemas/OneOfAlarmConsumedEventsItems'
                        devices:
                          type: array
                          items:
                            type: object
                            properties:
                              system-ip:
                                type: string
                                example: 19.19.19.1
                            $$ref: '#/components/schemas/AlarmDevices'
                        entry_time:
                          type: integer
                          format: int64
                          example: 1652906591837
                        eventname:
                          type: string
                          example: telemetry-data-collection-failure
                        id:
                          type: string
                          example: HHbp2IABUbH5BDy9BhJe
                        message:
                          type: string
                          example: Scheduled telemetry data collection failed on 19.19.19.1
                        possible_causes:
                          type: array
                          items:
                            type: string
                        receive_time:
                          type: integer
                          format: int64
                        rule_name_display:
                          type: string
                          example: Telemetry data save failed
                        rulename:
                          type: string
                          example: cpu-usage
                        severity:
                          type: string
                          enum:
                          - Minor
                          - Major
                          - Critical
                          - Medium
                        severity_number:
                          type: integer
                          format: int64
                          example: 4
                        site_id:
                          type: integer
                          format: int64
                          example: 100
                        statcycletime:
                          type: integer
                          format: int64
                        suppressed:
                          type: boolean
                          example: false
                        suppressed_by:
                          type: object
                          example:
                            system-ip:
                              type: string
                              example: 172.16.255.11
                            component:
                              type: string
                              example: BFD
                        system_ip:
                          type: string
                          example: 172.16.255.26
                        tenant:
                          type: string
                          example: default
                        type:
                          type: string
                          example: Telemetry data save failed
                        uuid:
                          type: string
                          format: uuid
                          example: f6f83721-3a69-42d1-841f-94e015957fb7
                        values:
                          type: array
                          items:
                            type: object
                            properties:
                              empty:
                                type: boolean
                            additionalProperties:
                              type: string
                            $$ref: '#/components/schemas/GeneralSchema'
                        values_short_display:
                          type: array
                          items:
                            type: object
                            properties:
                              empty:
                                type: boolean
                            additionalProperties:
                              type: string
                            $$ref: '#/components/schemas/GeneralSchema'
                      description: Represents any kind of alarm
                      $$ref: '#/components/schemas/Alarm'
                  pageInfo:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: number of alarms to be fetched
                        format: int64
                      endTime:
                        type: integer
                        description: end time of alarms to be fetched
                        format: int64
                      startTime:
                        type: integer
                        description: start time of alarms to be fetched
                        format: int64
                    $$ref: '#/components/schemas/PageInfo'
                description: AlarmResponse is used for GET/POST /alarms call.
                $$ref: '#/components/schemas/AlarmResponse'
              examples:
                200 Response:
                  description: 200 Response
                  value:
                    header:
                      generatedOn: 1717671384603
                      viewKeys:
                        uniqueKey: []
                        preferenceKey: grid-Alarms
                      columns:
                      - title: Impacted Entities
                        property: values_short_display
                        minWidth: 250
                        dataType: jsonArray
                      - title: Severity
                        property: severity
                        display: iconAndText
                        iconProperty: severity
                        hideable: false
                        icon:
                        - key: Minor
                          value: images/event_minor.png
                        - key: Major
                          value: images/event_major.png
                        - key: Critical
                          value: images/event_critical.png
                        - key: Medium
                          value: images/event_other.png
                        minWidth: 70
                        dataType: string
                      - title: Alarm Name
                        property: rule_name_display
                        minWidth: 160
                        dataType: string
                      - title: Message
                        property: message
                        minWidth: 250
                        dataType: string
                      - title: Date & Time
                        property: entry_time
                        displayFormat: DD MMM YYYY h:mm:ss A z
                        inputFormat: unix-time
                        minWidth: 200
                        dataType: date
                      - title: Cleared Date & Time
                        property: cleared_time
                        displayFormat: DD MMM YYYY h:mm:ss A z
                        inputFormat: unix-time
                        minWidth: 200
                        dataType: date
                      fields:
                      - property: values_short_display
                        dataType: jsonArray
                      - property: severity
                        dataType: string
                        display: iconAndText
                      - property: rule_name_display
                        dataType: string
                      - property: message
                        dataType: string
                      - property: possible_causes
                        dataType: string
                      - property: entry_time
                        dataType: date
                      - property: cleared_time
                        dataType: date
                      chart: {}
                    pageInfo:
                      startTime: '1717671338582'
                      endTime: '1717669597190'
                      count: 60
                    data:
                    - entry_time: 1717671338582
                      uuid: 59a93996-719d-4550-bbd5-1ba8c60b3d31
                      message: failed to sync root cert to device (ca9ec973-ba93-48ea-ad40-dea43b32d9f5, vm10, 172.16.255.20) on 06 Jun 2024 10:55:38 UTC
                      type: rootca-sync-failure
                      component: System
                      severity: Critical
                      severity_number: 1
                      devices:
                      - system-ip: 172.16.255.20
                      active: 'true'
                      values:
                      - system-ip: 172.16.255.20
                        host-name: vm10
                      acknowledged: 'false'
                      cleared_by: ''
                      suppressed: 'false'
                      suppressed_by: ''
                      rulename: rootca-sync-failure
                      rule_name_display: ROOTCA_SYNC_FAILURE
                      values_short_display:
                      - host-name: vm10
                        system-ip: 172.16.255.20
                      cleared_time: 0
                      statcycletime: 1717671338582
                      tenant: default
                      eventname: rootca-sync-failure
                      receive_time: 1717671338582
                      system_ip: 172.16.255.20
                      host_name: vm10
                      site_id: ''
                      update_time: 1717671338595
                    - entry_time: 1717671338582
                      uuid: 3bdf551c-5dbd-4add-9884-285d1f475d18
                      message: failed to sync root cert to device (353e002d-1d66-403e-b94b-86a890761803, vm9, 172.16.255.19) on 06 Jun 2024 10:55:38 UTC
                      type: rootca-sync-failure
                      component: System
                      severity: Critical
                      severity_number: 1
                      devices:
                      - system-ip: 172.16.255.19
                      active: 'true'
                      values:
                      - system-ip: 172.16.255.19
                        host-name: vm9
                      acknowledged: 'false'
                      cleared_by: ''
                      suppressed: 'false'
                      suppressed_by: ''
                      rulename: rootca-sync-failure
                      rule_name_display: ROOTCA_SYNC_FAILURE
                      values_short_display:
                      - host-name: vm9
                        system-ip: 172.16.255.19
                      cleared_time: 0
                      statcycletime: 1717671338582
                      tenant: default
                      eventname: rootca-sync-failure
                      receive_time: 1717671338582
                      system_ip: 172.16.255.19
                      host_name: vm9
                      site_id: ''
                      update_time: 1717671338618
                  $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineResponseAlarm'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Alarms-read
    get:
      tags:
      - Monitoring - Alarms Details
      description: Get alarms for given query. If query is empty then last 30 mins data will be returned.
      operationId: getRawAlarmData
      parameters:
      - name: query
        in: query
        description: Query
        allowEmptyValue: true
        schema:
          type: string
        examples:
          Empty:
            description: Empty
          Get active alarms:
            description: Get active alarms
            value:
              query:
                condition: AND
                rules:
                - field: entry_time
                  operator: last_n_hours
                  type: date
                  value:
                  - '10'
                - field: active
                  type: boolean
                  value:
                  - 'true'
                  operator: equal
            $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByActive'
          Get alarms filter by hours:
            description: Get alarms filter by hours
            value:
              query:
                condition: AND
                rules:
                - field: entry_time
                  operator: last_n_hours
                  type: date
                  value:
                  - '10'
              size: 100
            $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByHours'
          Get alarms filter between dates:
            description: Get alarms filter between dates
            value:
              query:
                condition: AND
                rules:
                - field: entry_time
                  type: date
                  value:
                  - 2024-04-30T19:30:00 UTC
                  - 2024-05-30T17:30:00 UTC
                  operator: between
              size: 10000
            $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBetweenDates'
          Get alarms filter by type:
            description: Get alarms filter by type
            value:
              query:
                condition: AND
                rules:
                - field: entry_time
                  operator: last_n_hours
                  type: date
                  value:
                  - '10'
                - field: rule_name_display
                  operator: in
                  type: string
                  value:
                  - Memory_Usage
              size: 10000
            $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterByType'
          Get alarms filter by system ip:
            description: Get alarms filter by system ip
            value:
              query:
                condition: AND
                rules:
                - field: entry_time
                  operator: last_n_hours
                  type: date
                  value:
                  - '10'
                - field: system_ip
                  operator: in
                  type: string
                  value:
                  - 1.1.1.1
              size: 100
            $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySystemIp'
          Get alarms filter by severity:
            description: Get alarms filter by severity
            value:
              query:
                condition: AND
                rules:
                - field: entry_time
                  operator: last_n_hours
                  type: date
                  value:
                  - '10'
                - field: severity
                  operator: in
                  type: string
                  value:
                  - Critical
              size: 100
            $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySeverity'
          Get alarms filter by site-id:
            description: Get alarms filter by site-id
            value:
              query:
                condition: AND
                rules:
                - field: entry_time
                  operator: last_n_hours
                  type: date
                  value:
                  - '10'
                - field: site_id
                  operator: in
                  type: string
                  value:
                  - '400'
                  - '500'
              size: 100
            $$ref: '#/components/examples/ComViptelaVmanageServerCorrelationEngineRequestFilterBySites'
      - name: site-id
        in: query
        description: Specify the site-id to filter the alarms
        schema:
          pattern: ^[0-9]+$
          type: string
      - name: includeTenants
        in: query
        description: Specify whether the tenant alarms need to be visible or not from provider view.
        schema:
          type: boolean
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        acknowledged:
                          type: boolean
                        active:
                          type: boolean
                        cleared_by:
                          type: string
                          format: uuid
                          example: 0a0dca23-11d5-4014-bfbb-976d3c6de492
                        cleared_events:
                          type: array
                          items:
                            type: string
                            format: uuid
                        cleared_time:
                          type: integer
                          format: int64
                          example: 1652894923722
                        component:
                          type: string
                          example: Schedule Telemetry collection
                        consumed_events:
                          type: array
                          items:
                            type: object
                            $$ref: '#/components/schemas/OneOfAlarmConsumedEventsItems'
                        devices:
                          type: array
                          items:
                            type: object
                            properties:
                              system-ip:
                                type: string
                                example: 19.19.19.1
                            $$ref: '#/components/schemas/AlarmDevices'
                        entry_time:
                          type: integer
                          format: int64
                          example: 1652906591837
                        eventname:
                          type: string
                          example: telemetry-data-collection-failure
                        id:
                          type: string
                          example: HHbp2IABUbH5BDy9BhJe
                        message:
                          type: string
                          example: Scheduled telemetry data collection failed on 19.19.19.1
                        possible_causes:
                          type: array
                          items:
                            type: string
                        receive_time:
                          type: integer
                          format: int64
                        rule_name_display:
                          type: string
                          example: Telemetry data save failed
                        rulename:
                          type: string
                          example: cpu-usage
                        severity:
                          type: string
                          enum:
                          - Minor
                          - Major
                          - Critical
                          - Medium
                        severity_number:
                          type: integer
                          format: int64
                          example: 4
                        site_id:
                          type: integer
                          format: int64
                          example: 100
                        statcycletime:
                          type: integer
                          format: int64
                        suppressed:
                          type: boolean
                          example: false
                        suppressed_by:
                          type: object
                          example:
                            system-ip:
                              type: string
                              example: 172.16.255.11
                            component:
                              type: string
                              example: BFD
                        system_ip:
                          type: string
                          example: 172.16.255.26
                        tenant:
                          type: string
                          example: default
                        type:
                          type: string
                          example: Telemetry data save failed
                        uuid:
                          type: string
                          format: uuid
                          example: f6f83721-3a69-42d1-841f-94e015957fb7
                        values:
                          type: array
                          items:
                            type: object
                            properties:
                              empty:
                                type: boolean
                            additionalProperties:
                              type: string
                            $$ref: '#/components/schemas/GeneralSchema'
                        values_short_display:
                          type: array
                          items:
                            type: object
                            properties:
                              empty:
                                type: boolean
                            additionalProperties:
                              type: string
                            $$ref: '#/components/schemas/GeneralSchema'
                      description: Represents any kind of alarm
                      $$ref: '#/components/schemas/Alarm'
                  pageInfo:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: number of alarms to be fetched
                        format: int64
                      endTime:
                        type: integer
                        description: end time of alarms to be fetched
                        format: int64
                      startTime:
                        type: integer
                        description: start time of alarms to be fetched
                        format: int64
                    $$ref: '#/components/schemas/PageInfo'
                description: AlarmResponse is used for GET/POST /alarms call.
                $$ref: '#/components/schemas/AlarmResponse'
              examples:
                Alarms:
                  description: Alarms
                  value:
                    header:
                      generatedOn: 1717671384603
                      viewKeys:
                        uniqueKey: []
                        preferenceKey: grid-Alarms
                      columns:
                      - title: Impacted Entities
                        property: values_short_display
                        minWidth: 250
                        dataType: jsonArray
                      - title: Severity
                        property: severity
                        display: iconAndText
                        iconProperty: severity
                        hideable: false
                        icon:
                        - key: Minor
                          value: images/event_minor.png
                        - key: Major
                          value: images/event_major.png
                        - key: Critical
                          value: images/event_critical.png
                        - key: Medium
                          value: images/event_other.png
                        minWidth: 70
                        dataType: string
                      - title: Alarm Name
                        pr

# --- truncated at 32 KB (262 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-sdwan/refs/heads/main/openapi/cisco-catalyst-sdwan-monitoring-alarms-details-api-openapi.yml