Cisco Catalyst SD-WAN Monitoring - Application Aware Routing API

openapi: 3.2.0
info:
  title: Monitoring and Troubleshooting Monitoring - Application Aware Routing 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 - Application Aware Routing
paths:
  /statistics/approute:
    get:
      tags:
      - Monitoring - Application Aware Routing
      description: Get stats raw data
      operationId: getStatDataRawData_MonitoringApplicationAwareRouting_2003
      parameters:
      - name: query
        in: query
        schema:
          type: string
        example:
          query:
            condition: AND
            rules:
            - value:
              - '24'
              field: entry_time
              type: date
              operator: last_n_hours
            - value:
              - 172.16.255.11
              field: vdevice_name
              type: string
              operator: in
            - value:
              - 3g
              - lte
              field: local_color
              type: string
              operator: in
      - name: page
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: pageSize
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: sortBy
        in: query
        schema:
          pattern: ^[a-zA-Z-_]+$
          type: string
      - name: sortOrder
        in: query
        schema:
          type: string
          enum:
          - asc
          - ASC
          - Asc
          - desc
          - DESC
          - Desc
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              example:
              - remote_color: 3g
                fec_re: 0
                vqoe_score: 10
                device_model: vedge-cloud
                latency: 1
                tx_octets: 0
                dst_ip: 10.0.101.2
                local_color: lte
                src_ip: 10.1.14.14
                sla_class_names: None
                loss: 0
                total: 600
                tx_pkts: 0
                fec_tx: 0
                rx_octets: 0
                statcycletime: 1589075400056
                state: Up
                local_system_ip: 172.16.255.14
                tenant: default
                entry_time: 1589073792008
                loss_percentage: 0
                rx_pkts: 0
                vmanage_system_ip: 172.16.255.14
                fec_rx: 0
                src_port: 12380
                jitter: 1
                remote_system_ip: 172.16.255.11
                vdevice_name: 172.16.255.14
                proto: IPSEC
                vip_idx: 190
                dst_port: 12366
                name: 172.16.255.14:lte-172.16.255.11:3g
                sla_class_list: '0'
                tunnel_color: 3g:lte
                host_name: vm4
                id: 4OBG_HEB_JLsavezVUfr
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
    post:
      tags:
      - Monitoring - Application Aware Routing
      description: Get stats raw data
      operationId: getStatsRawData_MonitoringApplicationAwareRouting_2004
      parameters:
      - name: page
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: pageSize
        in: query
        schema:
          minimum: 1
          type: integer
          format: int32
      - name: sortBy
        in: query
        schema:
          pattern: ^[a-zA-Z-_]+$
          type: string
      - name: sortOrder
        in: query
        schema:
          type: string
          enum:
          - asc
          - ASC
          - Asc
          - desc
          - DESC
          - Desc
      requestBody:
        description: Query filter
        content:
          application/json:
            schema:
              type: object
            examples:
              Query filter:
                description: Query filter
                value: "{\n  \"query\": {\n    \"condition\": \"AND\",\n    \"rules\": [\n      {\n        \"value\": [\n          \"24\"\n        ],\n        \"field\": \"entry_time\",\n        \"type\": \"date\",\n        \"operator\": \"last_n_hours\"\n      },\n      {\n        \"value\": [\n          \"172.16.255.11\"\n        ],\n        \"field\": \"vdevice_name\",\n        \"type\": \"string\",\n        \"operator\": \"in\"\n      },\n      {\n        \"value\": [\n          \"3g\",\n          \"lte\"\n        ],\n        \"field\": \"local_color\",\n        \"type\": \"string\",\n        \"operator\": \"in\"\n      }\n    ]\n  }\n}\n}"
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          device_model:
                            type: string
                          dst_ip:
                            type: string
                          dst_port:
                            type: integer
                            format: int32
                          entry_time:
                            type: string
                          fec_re:
                            type: integer
                            format: int32
                          fec_rx:
                            type: integer
                            format: int64
                          fec_tx:
                            type: integer
                            format: int64
                          host_name:
                            type: string
                          id:
                            type: string
                          jitter:
                            type: integer
                            format: int32
                          latency:
                            type: number
                          local_color:
                            type: string
                          local_system_ip:
                            type: string
                          loss:
                            type: integer
                            format: int32
                          loss_percentage:
                            type: integer
                            format: int32
                          name:
                            type: string
                          proto:
                            type: string
                          remote_color:
                            type: string
                          remote_system_ip:
                            type: string
                          rx_octets:
                            type: integer
                            format: int64
                          rx_pkts:
                            type: integer
                            format: int64
                          sla_class_list:
                            type: string
                          sla_class_names:
                            type: string
                          src_ip:
                            type: string
                          src_port:
                            type: integer
                            format: int32
                          statcycletime:
                            type: string
                          state:
                            type: string
                          tenant:
                            type: string
                          total:
                            type: integer
                            format: int32
                          tunnel_color:
                            type: string
                          tx_octets:
                            type: number
                          tx_pkts:
                            type: integer
                            format: int64
                          vdevice_name:
                            type: string
                          vip_idx:
                            type: integer
                            format: int32
                          vmanage_system_ip:
                            type: string
                          vqoe_score:
                            type: integer
                            format: int32
                        description: app route specific response
                        $$ref: '#/components/schemas/AppRouteResp'
                    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: app route response with page info
                  $$ref: '#/components/schemas/AppRouteRespWithPageInfo'
              example:
              - remote_color: 3g
                fec_re: 0
                vqoe_score: 10
                device_model: vedge-cloud
                latency: 1
                tx_octets: 0
                dst_ip: 10.0.101.2
                local_color: lte
                src_ip: 10.1.14.14
                sla_class_names: None
                loss: 0
                total: 600
                tx_pkts: 0
                fec_tx: 0
                rx_octets: 0
                statcycletime: 1589075400056
                state: Up
                local_system_ip: 172.16.255.14
                tenant: default
                entry_time: 1589073792008
                loss_percentage: 0
                rx_pkts: 0
                vmanage_system_ip: 172.16.255.14
                fec_rx: 0
                src_port: 12380
                jitter: 1
                remote_system_ip: 172.16.255.11
                vdevice_name: 172.16.255.14
                proto: IPSEC
                vip_idx: 190
                dst_port: 12366
                name: 172.16.255.14:lte-172.16.255.11:3g
                sla_class_list: '0'
                tunnel_color: 3g:lte
                host_name: vm4
                id: 4OBG_HEB_JLsavezVUfr
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
  /statistics/approute/aggregation:
    get:
      tags:
      - Monitoring - Application Aware Routing
      description: Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage
      operationId: getAggregationDataByQuery_MonitoringApplicationAwareRouting_3203
      parameters:
      - name: query
        in: query
        schema:
          type: string
        example:
          query:
            condition: AND
            rules:
            - value:
              - '24'
              field: entry_time
              type: date
              operator: last_n_hours
            - value:
              - 172.16.255.16
              field: vdevice_name
              type: string
              operator: in
            - value:
              - '100'
              field: loss_percentage
              type: number
              operator: less
          aggregation:
            field:
            - property: local_color
              sequence: 1
              order: asc
            metrics:
            - property: loss_percentage
              type: avg
            - property: latency
              type: avg
            - property: jitter
              type: avg
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    count:
                      type: integer
                      format: int32
                      example: 5
                    entry_time:
                      type: string
                      example: '1674813600000'
                    local_color:
                      type: string
                      example: 3g
                    loss_percentage:
                      type: integer
                      format: int32
                      example: 0
                  $$ref: '#/components/schemas/AppRouteAggResp'
              examples:
                Aggregated search result:
                  description: Aggregated search result
                  value: "[\n {\n   \"count\": 5,\n   \"local_color\": \"3g\",\n   \"loss_percentage\": 0\n   \"jitter\": 0\n   \"latency\": 0\n }\n ]"
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
    post:
      tags:
      - Monitoring - Application Aware Routing
      description: Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage
      operationId: getPostAggregationDataByQuery_MonitoringApplicationAwareRouting_3204
      requestBody:
        description: Stats query string
        content:
          application/json:
            schema:
              type: object
            examples:
              Stats query string:
                description: Stats query string
                value:
                  query:
                    condition: AND
                    rules:
                    - value:
                      - '24'
                      field: entry_time
                      type: date
                      operator: last_n_hours
                    - value:
                      - 172.16.255.16
                      field: vdevice_name
                      type: string
                      operator: in
                    - value:
                      - '100'
                      field: loss_percentage
                      type: number
                      operator: less
                  aggregation:
                    field:
                    - property: local_color
                      sequence: 1
                      order: asc
                    metrics:
                    - property: loss_percentage
                      type: avg
                    - property: latency
                      type: avg
                    - property: jitter
                      type: avg
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    count:
                      type: integer
                      format: int32
                      example: 5
                    entry_time:
                      type: string
                      example: '1674813600000'
                    local_color:
                      type: string
                      example: 3g
                    loss_percentage:
                      type: integer
                      format: int32
                      example: 0
                  $$ref: '#/components/schemas/AppRouteAggResp'
              examples:
                Aggregated search result:
                  description: Aggregated search result
                  value: "[\n  {\n   \"count\": 5,\n   \"local_color\": \"3g\",\n   \"loss_percentage\": 0\n   \"jitter\": 0\n   \"latency\": 0\n }\n ]"
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
  /statistics/approute/app-agg/aggregation:
    post:
      tags:
      - Monitoring - Application Aware Routing
      description: Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage
      operationId: getPostAggregationAppDataByQuery9
      requestBody:
        description: Stats query string
        content:
          application/json:
            schema:
              type: object
            examples:
              Stats query string:
                description: Stats query string
                value:
                  query:
                    field: latency
                    type: long
                    value:
                    - '1'
                    operator: greater
                  fields:
                  - latency
                  aggregation:
                    metrics:
                    - property: latency
                      type: avg
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: array
                  properties:
                    empty:
                      type: boolean
                  items:
                    type: object
                    properties:
                      latency:
                        type: string
                    $$ref: '#/components/schemas/AppRouteAppAggRespInner'
                  $$ref: '#/components/schemas/AppRouteAppAggResp'
              examples:
                Aggregated search result:
                  description: Aggregated search result
                  value:
                  - latency: 0
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
  /statistics/approute/csv:
    get:
      tags:
      - Monitoring - Application Aware Routing
      description: Get raw data with optional query as CSV
      operationId: getStatDataRawDataAsCSV_MonitoringApplicationAwareRouting_2403
      parameters:
      - name: query
        in: query
        schema:
          type: string
        example:
          query:
            condition: AND
            rules:
            - value:
              - '24'
              field: entry_time
              type: date
              operator: last_n_hours
            - value:
              - 172.16.255.11
              field: vdevice_name
              type: string
              operator: in
            - value:
              - 3g
              - lte
              field: local_color
              type: string
              operator: in
      responses:
        '200':
          description: Success
          content:
            text/csv:
              schema:
                type: string
              examples:
                Search result in csv format:
                  description: Search result in csv format
                  value: ' blob:https://<vmanageIP>/82c972bc-f9b3-4cce-bb70-1e1b033ef1cd'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
  /statistics/approute/device/tunnel/summary:
    get:
      tags:
      - Monitoring - Application Aware Routing
      description: Get statistics for top applications per tunnel in a grid table
      operationId: getStatsAppRouteDeviceTunnelSummary
      parameters:
      - name: query
        in: query
        description: Query filter
        schema:
          type: string
        example:
          query:
            condition: AND
            rules:
            - value:
              - '24'
              field: entry_time
              type: date
              operator: last_n_hours
            - value:
              - 172.16.255.11
              field: vdevice_name
              type: string
              operator: in
            - value:
              - 3g
              - lte
              field: local_color
              type: string
              operator: in
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          app_probe_class:
                            type: string
                          entry_time:
                            type: string
                          jitter:
                            type: integer
                            format: int32
                            example: 0
                          latency:
                            type: number
                          loss_percentage:
                            type: number
                          name:
                            type: string
                            example: 172.16.255.11:lte-172.16.255.16:3g
                          rx_octets:
                            type: integer
                            format: int32
                          tx_octets:
                            type: integer
                            format: int32
                        $$ref: '#/components/schemas/AppRouteTunnelSummary'
                  $$ref: '#/components/schemas/AppRouteTunnenSummarResp'
              examples:
                Statistics for top application:
                  description: Statistics for top application
                  value:
                  - name: 172.16.255.11:lte-172.16.255.15:3g
                    jitter: 0
                    rx_octets: 0
                    tx_octets: 0
                    loss_percentage: 0
                    latency: 0
                    entry_time: ''
                    app_probe_class: ''
                  - name: 172.16.255.11:lte-172.16.255.15:lte
                    jitter: 0
                    rx_octets: 0
                    tx_octets: 0
                    loss_percentage: 0
                    latency: 0
                    entry_time: ''
                    app_probe_class: ''
                  - name: 172.16.255.11:lte-172.16.255.16:3g
                    jitter: 0
                    rx_octets: 0
                    tx_octets: 0
                    loss_percentage: 0
                    latency: 0
                    entry_time: ''
                    app_probe_class: ''
                  - name: 172.16.255.11:lte-172.16.255.16:lte
                    jitter: 0
                    rx_octets: 0
                    tx_octets: 0
                    loss_percentage: 0
                    latency: 0
                    entry_time: ''
                    app_probe_class: ''
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
  /statistics/approute/device/tunnels:
    get:
      tags:
      - Monitoring - Application Aware Routing
      description: Get statistics for top applications per tunnel in a grid table
      operationId: getStatsAppRouteDeviceTunnels
      parameters:
      - name: query
        in: query
        description: Query filter
        schema:
          type: string
        example:
          query:
            condition: AND
            rules:
            - value:
              - '24'
              field: entry_time
              type: date
              operator: last_n_hours
            - value:
              - 172.16.255.11
              field: vdevice_name
              type: string
              operator: in
            - value:
              - 3g
              - lte
              field: local_color
              type: string
              operator: in
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    data:
                      type: array
                      items:
                        type: object
                        properties:
                          device_model:
                            type: string
                          dst_ip:
                            type: string
                          dst_port:
                            type: integer
                            format: int32
                          entry_time:
                            type: string
                          fec_re:
                            type: integer
                            format: int32
                          fec_rx:
                            type: integer
                            format: int64
                          fec_tx:
                            type: integer
                            format: int64
                          host_name:
                            type: string
                          id:
                            type: string
                          jitter:
                            type: integer
                            format: int32
                          latency:
                            type: number
                          local_color:
                            type: string
                          local_system_ip:
                            type: string
                          loss:
                            type: integer
                            format: int32
                          loss_percentage:
                            type: integer
                            format: int32
                          name:
                            type: string
                          proto:
                            type: string
                          remote_color:
                            type: string
                          remote_system_ip:
                            type: string
                          rx_octets:
                            type: integer
                            format: int64
                          rx_pkts:
                            type: integer
                            format: int64
                          sla_class_list:
                            type: string
                          sla_class_names:
                            type: string
                          src_ip:
                            type: string
                          src_port:
                            type: integer
                            format: int32
                          statcycletime:
                            type: string
                          state:
                            type: string
                          tenant:
                            type: string
                          total:
                            type: integer
                            format: int32
                          tunnel_color:
                            type: string
                          tx_octets:
                            type: number
                          tx_pkts:
                            type: integer
                            format: int64
                          vdevice_name:
                            type: string
                          vip_idx:
                            type: integer
                            format: int32
                          vmanage_system_ip:
                            type: string
                          vqoe_score:
                            type: integer
                            format: int32
                        description: app route specific response
                        $$ref: '#/components/schemas/AppRouteResp'
                    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: app route response with page info
                  $$ref: '#/components/schemas/AppRouteRespWithPageInfo'
              examples:
                Tunnel top statistics:
                  description: Tunnel top statistics
                  value:
                  - remote_color: lte
                    fec_re: 0
                    vqoe_score: 10
                    device_model: vedge-cloud
                    latency: 0
                    tx_octets: 0
                    dst_ip: 10.0.106.1
                    local_color: 3g
                    src_ip: 10.0.101.2
                    sla_class_names: None
                    loss: 0
                    total: 600
                    tx_pkts: 0
                    fec_tx: 0
                    rx_octets: 0
                    statcycletime: 1677160200123
                    siteid: 100
                    state: Up
                    local_system_ip: 172.16.255.11
                    tenant: default
                    entry_time: 1677159336845
                    loss_percentage: 0
                    app_probe_class: None
                    rx_pkts: 0
                    vmanage_system_ip: 172.16.255.11
                    fec_rx: 0
                    src_port: 12366
                    jitter: 0
                    remote_system_ip: 172.16.255.16
                    vdevice_name: 172.16.255.11
                    proto: IPSEC
                    vip_idx: 3718
                    dst_port: 12366
                    name: 172.16.255.11:3g-172.16.255.16:lte
                    sla_class_list: '0'
                    tunnel_color: 3g:lte
                    host_name: vm1
                    id: 0q-JfoYB04cEz_Q-t9i_
                  - remote_color: 3g
                    fec_re: 0
                    vqoe_score: 10
                    device_model: vedge-cloud
                    latency: 0
                    tx_octets: 0
                    dst_ip: 10.0.106.2
                    local_color: lte
                    src_ip: 10.0.101.1
                    sla_class_names: None
                    loss: 0
                    total: 600
                    tx_pkts: 0
                    fec_tx: 0
                    rx_octets: 0
                    statcycletime: 1677160200123
                    siteid: 100
                    state: Up
                    local_system_ip: 172.16.255.11
                    tenant: default
                    entry_time: 1677159336845
                    loss_percentage: 0
                    app_pr

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