Cisco Catalyst SD-WAN Monitoring - DPI API

The Monitoring - DPI API from Cisco Catalyst SD-WAN — 15 operation(s) for monitoring - dpi.

Business capability
Network Performance Management BC-2600.30

Operations 19

GET /statistics/dpi #
POST /statistics/dpi #
POST /statistics/dpi/agg-app/aggregation #
GET /statistics/dpi/aggregation #
POST /statistics/dpi/aggregation #
GET /statistics/dpi/applications #
GET /statistics/dpi/applications/summary #
GET /statistics/dpi/csv #
GET /statistics/dpi/device/application/flowcount #
GET /statistics/dpi/device/applications #
GET /statistics/dpi/device/details/applications #
GET /statistics/dpi/doccount #
POST /statistics/dpi/doccount #
GET /statistics/dpi/fields #
POST /statistics/dpi/page #
GET /statistics/dpi/page #
POST /statistics/dpi/pktdup/aggregation #
GET /statistics/dpi/query/fields #
POST /statistics/dpi/recovery/aggregation #

Documentation

📖
Documentation
https://developer.cisco.com/docs/sdwan/administration-and-setting/
📖
APIReference
https://developer.cisco.com/docs/sdwan/administration-and-setting/
📖
Documentation
https://developer.cisco.com/docs/sdwan/ux-1-0-configuration/
📖
APIReference
https://developer.cisco.com/docs/sdwan/ux-1-0-configuration/
📖
Documentation
https://developer.cisco.com/docs/sdwan/ux-2-0-configuration/
📖
APIReference
https://developer.cisco.com/docs/sdwan/ux-2-0-configuration/
📖
Documentation
https://developer.cisco.com/docs/sdwan/feature-profiles-sd-wan-system/
📖
APIReference
https://developer.cisco.com/docs/sdwan/feature-profiles-sd-wan-system/
📖
Documentation
https://developer.cisco.com/docs/sdwan/feature-profiles-sd-wan-transport/
📖
APIReference
https://developer.cisco.com/docs/sdwan/feature-profiles-sd-wan-transport/
📖
Documentation
https://developer.cisco.com/docs/sdwan/feature-profiles-sd-wan-service/
📖
APIReference
https://developer.cisco.com/docs/sdwan/feature-profiles-sd-wan-service/
📖
Documentation
https://developer.cisco.com/docs/sdwan/feature-profiles-others/
📖
APIReference
https://developer.cisco.com/docs/sdwan/feature-profiles-others/
📖
Documentation
https://developer.cisco.com/docs/sdwan/feature-profiles-sd-routing/
📖
APIReference
https://developer.cisco.com/docs/sdwan/feature-profiles-sd-routing/
📖
Documentation
https://developer.cisco.com/docs/sdwan/feature-profiles-mobility-and-nfv/
📖
APIReference
https://developer.cisco.com/docs/sdwan/feature-profiles-mobility-and-nfv/
📖
Documentation
https://developer.cisco.com/docs/sdwan/monitoring-and-troubleshooting/
📖
APIReference
https://developer.cisco.com/docs/sdwan/monitoring-and-troubleshooting/
📖
Documentation
https://developer.cisco.com/docs/sdwan/sd-wan-services/
📖
APIReference
https://developer.cisco.com/docs/sdwan/sd-wan-services/
📖
Documentation
https://developer.cisco.com/docs/sdwan/partner-integrations/
📖
APIReference
https://developer.cisco.com/docs/sdwan/partner-integrations/
📖
Documentation
https://developer.cisco.com/docs/sdwan/others/
📖
APIReference
https://developer.cisco.com/docs/sdwan/others/

Specifications

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cisco-catalyst-sdwan-monitoring-dpi-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cisco-catalyst-sdwan-monitoring-dpi-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Monitoring and Troubleshooting Monitoring - DPI 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 - DPI
paths:
  /statistics/dpi:
    get:
      tags:
      - Monitoring - DPI
      description: Get DPI stats raw data
      operationId: getDPIStatsRawData
      parameters:
      - name: query
        in: query
        schema:
          type: string
        example:
          query:
            condition: AND
            rules:
            - value:
              - '24'
              field: entry_time
              type: date
              operator: last_n_hours
      - 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
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        application:
                          type: string
                          example: icmp
                        create_time:
                          type: integer
                          format: int64
                          example: 1664150420729
                        dest_ip:
                          type: string
                          example: 10.74.49.77
                        dest_port:
                          type: integer
                          format: int32
                          example: 771
                        device_model:
                          type: string
                          example: vedge-C8000V
                        entry_time:
                          type: integer
                          format: int64
                          example: 1664150431860
                        expire_time:
                          type: integer
                          format: int64
                          example: 1664150421784
                        family:
                          type: string
                          example: network-service
                        host_name:
                          type: string
                          example: C8Kv-77
                        ip_proto:
                          type: integer
                          format: int32
                          example: 1
                        octets:
                          type: integer
                          format: int32
                          example: 4032
                        packets:
                          type: integer
                          format: int32
                          example: 7
                        source_ip:
                          type: string
                          example: 10.124.10.249
                        source_port:
                          type: integer
                          format: int32
                          example: 0
                        vdevice_name:
                          type: string
                          example: 1.1.70.7
                        vip_idx:
                          type: integer
                          format: int32
                          example: 172060
                        vpn_id:
                          type: integer
                          format: int32
                          example: 512
                      $$ref: '#/components/schemas/DPIDataObject'
                  pageInfo:
                    type: object
                    properties:
                      count:
                        type: integer
                        format: int32
                        example: 398
                      endTime:
                        type: string
                        example: '1664148997536'
                      startTime:
                        type: string
                        example: '1664159158463'
                    $$ref: '#/components/schemas/DPIResponsePageInfo'
                $$ref: '#/components/schemas/DPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read
    post:
      tags:
      - Monitoring - DPI
      description: Get DPI stats raw data
      operationId: getDPIStatsRawDataPost
      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: User
        content:
          application/json:
            schema:
              type: object
            examples:
              Query filter:
                description: Query filter
                value:
                  query:
                    condition: AND
                    rules:
                    - value:
                      - '24'
                      field: entry_time
                      type: date
                      operator: last_n_hours
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        application:
                          type: string
                          example: icmp
                        create_time:
                          type: integer
                          format: int64
                          example: 1664150420729
                        dest_ip:
                          type: string
                          example: 10.74.49.77
                        dest_port:
                          type: integer
                          format: int32
                          example: 771
                        device_model:
                          type: string
                          example: vedge-C8000V
                        entry_time:
                          type: integer
                          format: int64
                          example: 1664150431860
                        expire_time:
                          type: integer
                          format: int64
                          example: 1664150421784
                        family:
                          type: string
                          example: network-service
                        host_name:
                          type: string
                          example: C8Kv-77
                        ip_proto:
                          type: integer
                          format: int32
                          example: 1
                        octets:
                          type: integer
                          format: int32
                          example: 4032
                        packets:
                          type: integer
                          format: int32
                          example: 7
                        source_ip:
                          type: string
                          example: 10.124.10.249
                        source_port:
                          type: integer
                          format: int32
                          example: 0
                        vdevice_name:
                          type: string
                          example: 1.1.70.7
                        vip_idx:
                          type: integer
                          format: int32
                          example: 172060
                        vpn_id:
                          type: integer
                          format: int32
                          example: 512
                      $$ref: '#/components/schemas/DPIDataObject'
                  pageInfo:
                    type: object
                    properties:
                      count:
                        type: integer
                        format: int32
                        example: 398
                      endTime:
                        type: string
                        example: '1664148997536'
                      startTime:
                        type: string
                        example: '1664159158463'
                    $$ref: '#/components/schemas/DPIResponsePageInfo'
                $$ref: '#/components/schemas/DPIResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read
  /statistics/dpi/agg-app/aggregation:
    post:
      tags:
      - Monitoring - DPI
      description: Get raw aggregated data and display applications with the highest utilization for a device
      operationId: getAggAppDataPost
      parameters:
      - name: site-id
        in: query
        schema:
          pattern: ^[0-9]+$
          type: string
      requestBody:
        description: Query filter
        content:
          application/json:
            schema:
              type: object
            examples:
              Query filter:
                description: Query filter
                value:
                  query:
                    condition: AND
                    rules:
                    - value:
                      - '24'
                      field: entry_time
                      type: date
                      operator: last_n_hours
                    - value:
                      - 1.1.60.7
                      field: vdevice_name
                      type: string
                      operator: in
                  aggregation:
                    field:
                    - property: family
                      size: 200
                      sequence: 1
                    metrics:
                    - property: octets
                      type: sum
                      order: desc
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        count:
                          type: integer
                          format: int32
                          example: 398
                        family:
                          type: string
                          example: network-service
                        octets:
                          type: integer
                          format: int32
                          example: 18768
                      $$ref: '#/components/schemas/DPIAggregationResponseData'
                  header:
                    type: object
                    properties:
                      columns:
                        type: array
                        items:
                          type: object
                          properties:
                            dataType:
                              type: string
                              example: number
                            isDisplay:
                              type: boolean
                            property:
                              type: string
                              example: octets
                            title:
                              type: string
                              example: Octets
                          $$ref: '#/components/schemas/DPIAggregationResponseHeaderColumns'
                      fields:
                        type: array
                        items:
                          type: object
                          properties:
                            dataType:
                              type: string
                              example: number
                            property:
                              type: string
                              example: octets
                          $$ref: '#/components/schemas/DPIAggregationResponseHeaderFields'
                      generatedOn:
                        type: integer
                        format: int64
                        example: 1664160118911
                    $$ref: '#/components/schemas/DPIAggregationResponseHeader'
                $$ref: '#/components/schemas/DPIAggregationResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read,RBAC VPN-read,RBAC VPN-write
  /statistics/dpi/aggregation:
    get:
      tags:
      - Monitoring - DPI
      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: getDPIStatsAggregationData
      parameters:
      - name: query
        in: query
        schema:
          type: string
        example:
          query:
            condition: AND
            rules:
            - value:
              - '24'
              field: entry_time
              type: date
              operator: last_n_hours
          aggregation:
            field:
            - property: family
              size: 200
              sequence: 1
            metrics:
            - property: octets
              type: sum
              order: desc
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        count:
                          type: integer
                          format: int32
                          example: 398
                        family:
                          type: string
                          example: network-service
                        octets:
                          type: integer
                          format: int32
                          example: 18768
                      $$ref: '#/components/schemas/DPIAggregationResponseData'
                  header:
                    type: object
                    properties:
                      columns:
                        type: array
                        items:
                          type: object
                          properties:
                            dataType:
                              type: string
                              example: number
                            isDisplay:
                              type: boolean
                            property:
                              type: string
                              example: octets
                            title:
                              type: string
                              example: Octets
                          $$ref: '#/components/schemas/DPIAggregationResponseHeaderColumns'
                      fields:
                        type: array
                        items:
                          type: object
                          properties:
                            dataType:
                              type: string
                              example: number
                            property:
                              type: string
                              example: octets
                          $$ref: '#/components/schemas/DPIAggregationResponseHeaderFields'
                      generatedOn:
                        type: integer
                        format: int64
                        example: 1664160118911
                    $$ref: '#/components/schemas/DPIAggregationResponseHeader'
                $$ref: '#/components/schemas/DPIAggregationResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read
    post:
      tags:
      - Monitoring - DPI
      description: Get raw aggregated data and display applications with the highest utilization for a device
      operationId: getDPIStatsAggregationDataPost
      requestBody:
        description: User
        content:
          application/json:
            schema:
              type: object
            examples:
              Query filter:
                description: Query filter
                value:
                  query:
                    condition: AND
                    rules:
                    - value:
                      - '24'
                      field: entry_time
                      type: date
                      operator: last_n_hours
                    - value:
                      - 1.1.60.7
                      field: vdevice_name
                      type: string
                      operator: in
                  aggregation:
                    field:
                    - property: family
                      size: 200
                      sequence: 1
                    metrics:
                    - property: octets
                      type: sum
                      order: desc
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        count:
                          type: integer
                          format: int32
                          example: 398
                        family:
                          type: string
                          example: network-service
                        octets:
                          type: integer
                          format: int32
                          example: 18768
                      $$ref: '#/components/schemas/DPIAggregationResponseData'
                  header:
                    type: object
                    properties:
                      columns:
                        type: array
                        items:
                          type: object
                          properties:
                            dataType:
                              type: string
                              example: number
                            isDisplay:
                              type: boolean
                            property:
                              type: string
                              example: octets
                            title:
                              type: string
                              example: Octets
                          $$ref: '#/components/schemas/DPIAggregationResponseHeaderColumns'
                      fields:
                        type: array
                        items:
                          type: object
                          properties:
                            dataType:
                              type: string
                              example: number
                            property:
                              type: string
                              example: octets
                          $$ref: '#/components/schemas/DPIAggregationResponseHeaderFields'
                      generatedOn:
                        type: integer
                        format: int64
                        example: 1664160118911
                    $$ref: '#/components/schemas/DPIAggregationResponseHeader'
                $$ref: '#/components/schemas/DPIAggregationResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read,RBAC VPN-read,RBAC VPN-write
  /statistics/dpi/applications:
    get:
      tags:
      - Monitoring - DPI
      description: Get detailed DPI application flows list in a grid table
      operationId: getAggAppFlows
      parameters:
      - name: query
        in: query
        required: true
        schema:
          type: string
        example:
          query:
            condition: AND
            rules:
            - value:
              - '24'
              field: entry_time
              type: date
              operator: last_n_hours
      - name: limit
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        application:
                          type: string
                          example: ipfix
                        octets:
                          type: number
                          example: 72535008
                      $$ref: '#/components/schemas/DPIAppResponseData'
                  header:
                    type: object
                    properties:
                      chart:
                        type: object
                        properties:
                          series:
                            type: array
                            items:
                              type: string
                          title:
                            type: string
                            example: view.statistics.clientViewDpiApplication.dpiApplication
                          xAxis:
                            type: array
                            items:
                              type: string
                          xAxisLabel:
                            type: string
                            example: view.statistics.clientViewDpiApplication.time
                          yAxis:
                            type: array
                            items:
                              type: string
                          yAxisLabel:
                            type: string
                            example: view.statistics.clientViewDpiApplication.count
                        $$ref: '#/components/schemas/DPIAppResponseHeaderChart'
                      columns:
                        type: array
                        items:
                          type: object
                          properties:
                            dataType:
                              type: string
                              example: string
                            hideable:
                              type: boolean
                            property:
                              type: string
                              example: application
                            title:
                              type: string
                              example: Application
                          $$ref: '#/components/schemas/DPIAppResponseHeaderColumns'
                      fields:
                        type: array
                        items:
                          type: object
                          properties:
                            dataType:
                              type: string
                              example: string
                            property:
                              type: string
                              example: application
                          $$ref: '#/components/schemas/DPIAppResponseHeaderFields'
                      generatedOn:
                        type: number
                        example: 1664506834428
                      viewKeys:
                        type: object
                        properties:
                          preferenceKey:
                            type: string
                            example: grid-dpi_applications
                          uniqueKey:
                            type: array
                            items:
                              type: string
                        $$ref: '#/components/schemas/DPIAppResponseHeaderViewKeys'
                    $$ref: '#/components/schemas/DPIAppResponseHeader'
                $$ref: '#/components/schemas/DPIAppResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read,RBAC VPN-read
  /statistics/dpi/applications/summary:
    get:
      tags:
      - Monitoring - DPI
      description: Get detailed DPI application flows summary
      operationId: getAggAppFlowsSummary
      parameters:
      - name: query
        in: query
        required: true
        schema:
          type: string
        example:
          query:
            condition: AND
            rules:
            - value:
              - '24'
              field: entry_time
              type: date
              operator: last_n_hours
      - name: limit
        in: query
        schema:
          type: integer
          format: int32
      - name: site-id
        in: query
        schema:
          pattern: ^[0-9]+$
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        application:
                          type: string
                          example: ipfix
                        octets:
                          type: number
                          example: 72535008
                      $$ref: '#/components/schemas/DPIAppResponseData'
                  header:
                    type: object
                    properties:
                      chart:
                        type: object
                        properties:
                          series:
                            type: array
                            items:
                              type: string
                          title:
                            type: string
                            example: view.statistics.clientViewDpiApplication.dpiApplication
                          xAxis:
                            type: array
                            items:
                              type: string
                          xAxisLabel:
                            type: string
                            example: view.statistics.clientViewDpiApplication.time
                          yAxis:
                            type: array
                            items:
                              type: string
                          yAxisLabel:
                            type: string
                            example: view.statistics.clientViewDpiApplication.count
                        $$ref: '#/components/schemas/DPIAppResponseHeaderChart'
                      columns:
                        type: array
                        items:
                          type: object
                          properties:
                            dataType:
                              type: string
                              example: string
                            hideable:
                              type: boolean
                            property:
                              type: string
                              example: application
                            title:
                              type: string
                              example: Application
                          $$ref: '#/components/schemas/DPIAppResponseHeaderColumns'
                      fields:
                        type: array
                        items:
                          type: object
                          properties:
                            dataType:
                              type: string
                              example: string
                            property:
                              type: string
                              example: application
                          $$ref: '#/components/schemas/DPIAppResponseHeaderFields'
                      generatedOn:
                        type: number
                        example: 1664506834428
                      viewKeys:
                        type: object
                        properties:
                          preferenceKey:
                            type: string
                            example: grid-dpi_applications
                          uniqueKey:
                            type: array
                            items:
                              type: string
                        $$ref: '#/components/schemas/DPIAppResponseHeaderViewKeys'
                    $$ref: '#/components/schemas/DPIAppResponseHeader'
                $$ref: '#/components/schemas/DPIAppResponse'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read
  /statistics/dpi/csv:
    get:
      tags:
      - Monitoring - DPI
      description: Get raw data with optional query as CSV
      operationId: getDPIStatsRawDataAsCSV
      parameters:
      - name: query
        in: query
        schema:
          type: string
        example:
          query:
            condition: AND
            rules:
            - value:
              - '24'
              field: entry_time
              type: date
              operator: last_n_hours
      responses:
        '200':
          description: Success
          content:
            text/csv:
              schema:
                type: string
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read
  /statistics/dpi/device/application/flowcount:
    get:
      tags:
      - Monitoring - DPI
      description: Get application flow count p

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