openapi: 3.2.0
info:
  title: Monitoring and Troubleshooting Monitoring - Device Health 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 - Device Health
paths:
  /statistics/devicehealth/history:
    get:
      tags:
      - Monitoring - Device Health
      summary: Device health history data
      description: 'Get all device health history '
      operationId: getDeviceHealthHistory
      parameters:
      - name: last_n_hours
        in: query
        schema:
          maximum: 24
          minimum: 1
          type: integer
          format: int32
          default: 12
      - name: site
        in: query
        schema:
          pattern: ^[0-9]+$
          type: string
      - name: limit
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
          default: 30
      responses:
        '200':
          description: search results matching criteria
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    cpu_load:
                      type: number
                      format: double
                      example: 1.32
                    health:
                      type: string
                      example: good
                      enum:
                      - good
                      - fair
                      - poor
                      - n/a
                    health_score:
                      type: number
                      format: double
                      example: 10
                    history:
                      type: array
                      items:
                        type: object
                        properties:
                          data:
                            type: object
                            properties:
                              jitter:
                                type: number
                                format: double
                              latency:
                                type: number
                                format: double
                              loss_percentage:
                                type: number
                                format: double
                              rx_octets:
                                type: number
                              state:
                                type: string
                                enum:
                                - Up
                                - Down
                              tx_octets:
                                type: number
                              vqoe_score:
                                type: number
                                format: double
                            $$ref: '#/components/schemas/TunnelHealthData'
                          entry_time:
                            type: number
                            example: 1657780200000
                          health:
                            type: string
                            example: good
                            enum:
                            - good
                            - fair
                            - poor
                            - n/a
                          health_score:
                            type: number
                            format: double
                            example: 10
                        $$ref: '#/components/schemas/DeviceHealthEntryItem'
                    host_name:
                      type: string
                      example: vm11
                    memory_utilization:
                      type: number
                      format: double
                      example: 43.03
                    qoe:
                      type: number
                      format: double
                      example: 10
                    reachability:
                      type: string
                      example: reachable
                    site_id:
                      type: string
                      example: '600'
                    system_ip:
                      type: string
                      example: 172.16.255.21
                  $$ref: '#/components/schemas/DeviceHealthHistoryItem'
        '400':
          description: Bad Request
  /statistics/devicehealth/overview/{type}:
    get:
      tags:
      - Monitoring - Device Health
      summary: Device health overview data
      description: 'Get all device health overview '
      operationId: getDeviceHealthOverview
      parameters:
      - name: type
        in: path
        required: true
        schema:
          pattern: ^[a-zA-Z_-]+$
          type: string
      - name: last_n_hours
        in: query
        schema:
          maximum: 24
          minimum: 1
          type: integer
          format: int32
          default: 12
      - name: site
        in: query
        schema:
          pattern: ^[0-9]+$
          type: string
      - name: personality
        in: query
        schema:
          type: string
          enum:
          - vsmart
          - vbond
          - vmanage
          - vedge
          default: vedge
      - name: limit
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
          default: 30
      responses:
        '200':
          description: search results matching criteria
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: object
                    properties:
                      fair:
                        type: array
                        items:
                          required:
                          - cpu_load
                          - health
                          - health_score
                          - host_name
                          - memory_utilization
                          - qoe
                          - reachability
                          - site_id
                          - system_ip
                          type: object
                          properties:
                            cpu_load:
                              type: number
                              format: double
                              example: 1.32
                            health:
                              type: string
                              example: good
                              enum:
                              - good
                              - fair
                              - poor
                              - n/a
                            health_score:
                              type: number
                              format: double
                              example: 10
                            host_name:
                              type: string
                              example: vm11
                            memory_utilization:
                              type: number
                              format: double
                              example: 43.03
                            qoe:
                              type: number
                              format: double
                              example: 10
                            reachability:
                              type: string
                              example: reachable
                            site_id:
                              type: string
                              example: '600'
                            system_ip:
                              type: string
                              example: 172.16.255.21
                          $$ref: '#/components/schemas/DeviceHealthDetailItem'
                      good:
                        type: array
                        items:
                          required:
                          - cpu_load
                          - health
                          - health_score
                          - host_name
                          - memory_utilization
                          - qoe
                          - reachability
                          - site_id
                          - system_ip
                          type: object
                          properties:
                            cpu_load:
                              type: number
                              format: double
                              example: 1.32
                            health:
                              type: string
                              example: good
                              enum:
                              - good
                              - fair
                              - poor
                              - n/a
                            health_score:
                              type: number
                              format: double
                              example: 10
                            host_name:
                              type: string
                              example: vm11
                            memory_utilization:
                              type: number
                              format: double
                              example: 43.03
                            qoe:
                              type: number
                              format: double
                              example: 10
                            reachability:
                              type: string
                              example: reachable
                            site_id:
                              type: string
                              example: '600'
                            system_ip:
                              type: string
                              example: 172.16.255.21
                          $$ref: '#/components/schemas/DeviceHealthDetailItem'
                      poor:
                        type: array
                        items:
                          required:
                          - cpu_load
                          - health
                          - health_score
                          - host_name
                          - memory_utilization
                          - qoe
                          - reachability
                          - site_id
                          - system_ip
                          type: object
                          properties:
                            cpu_load:
                              type: number
                              format: double
                              example: 1.32
                            health:
                              type: string
                              example: good
                              enum:
                              - good
                              - fair
                              - poor
                              - n/a
                            health_score:
                              type: number
                              format: double
                              example: 10
                            host_name:
                              type: string
                              example: vm11
                            memory_utilization:
                              type: number
                              format: double
                              example: 43.03
                            qoe:
                              type: number
                              format: double
                              example: 10
                            reachability:
                              type: string
                              example: reachable
                            site_id:
                              type: string
                              example: '600'
                            system_ip:
                              type: string
                              example: 172.16.255.21
                          $$ref: '#/components/schemas/DeviceHealthDetailItem'
                    $$ref: '#/components/schemas/DeviceHealthOverviewDetail'
                  total:
                    type: object
                    properties:
                      fair:
                        type: number
                        example: 100
                      good:
                        type: number
                        example: 100
                      poor:
                        type: number
                        example: 100
                    $$ref: '#/components/schemas/DeviceHealthOverviewTotal'
                $$ref: '#/components/schemas/DeviceHealthOverview'
        '400':
          description: Bad Request