openapi: 3.2.0
info:
  title: Others Overview - PPL API
  description: 'Other APIs

    Include APIs that do not belong to other categories'
  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: Overview - PPL
paths:
  /device/ppl/dashlet:
    get:
      tags:
      - Overview - PPL
      description: PPL dashlet
      operationId: pplDashlet
      parameters:
      - name: orderBy
        in: query
        description: orderBy
        schema:
          type: string
          enum:
          - candidateTunnel
          - ooo_severity
          - mem_usage
      - name: filter
        in: query
        description: filter
        schema:
          type: string
          enum:
          - highSegment
          - mediumSegment
          - lowSegment
      - name: lastNHours
        in: query
        description: last N Hours
        schema:
          type: string
          enum:
          - '1'
          - '3'
          - '6'
          - '12'
          - '24'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    dashLetList:
                      type: array
                      items:
                        type: object
                        properties:
                          memoryUsage:
                            type: number
                            format: double
                          numCtg:
                            type: integer
                            format: int64
                          oooSeverity:
                            type: number
                            format: double
                          previousMemoryUsage:
                            type: number
                            format: double
                          previousNumCtg:
                            type: integer
                            format: int64
                          previousOooSeverity:
                            type: number
                            format: double
                          receiverSysIp:
                            type: string
                          segment:
                            type: string
                          senderSysIp:
                            type: string
                        $$ref: '#/components/schemas/PPLDashLet'
                    high:
                      type: integer
                      format: int64
                    low:
                      type: integer
                      format: int64
                    medium:
                      type: integer
                      format: int64
                    totalSegment:
                      type: integer
                      format: int64
                  $$ref: '#/components/schemas/PPLDashLetSummary'
              examples:
                count by candidateTunnel:
                  description: count by candidateTunnel
                  value:
                    data:
                      high: 0
                      low: 0
                      totalSegment: 0
                      medium: 0
                      dashLetList: []
                  $$ref: '#/components/examples/ComViptelaVmanageServerDevicePplPplapiResponseExamplePplbycandidatetunnel'
                count by ooo_severity:
                  description: count by ooo_severity
                  value:
                    data:
                      high: 0
                      low: 1
                      totalSegment: 1
                      medium: 0
                      dashLetList:
                      - previousMemoryUsage: 0
                        memoryUsage: 0
                        senderSysIp: 172.16.255.16
                        previousNumCtg: 0
                        numCtg: 0
                        oooSeverity: 0
                        receiverSysIp: 172.16.255.15
                        previousOooSeverity: 0
                  $$ref: '#/components/examples/ComViptelaVmanageServerDevicePplPplapiResponseExamplePplbyoooseverity'
                count by mem_usage:
                  description: count by mem_usage
                  value:
                    data:
                      high: 0
                      low: 1
                      totalSegment: 1
                      medium: 0
                      dashLetList:
                      - previousMemoryUsage: 0
                        memoryUsage: 0
                        senderSysIp: 172.16.255.16
                        previousNumCtg: 0
                        numCtg: 0
                        oooSeverity: 0
                        receiverSysIp: 172.16.255.15
                        previousOooSeverity: 0
                  $$ref: '#/components/examples/ComViptelaVmanageServerDevicePplPplapiResponseExamplePplbyoooseverity'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read,Device Monitoring-write
  /device/ppl/detailList:
    get:
      tags:
      - Overview - PPL
      description: PPL detail list
      operationId: detailList
      parameters:
      - name: lastNHours
        in: query
        description: last N Hours
        schema:
          type: string
          enum:
          - '1'
          - '3'
          - '6'
          - '12'
          - '24'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    memUSage:
                      type: number
                      format: double
                    numCtg:
                      type: integer
                      format: int64
                    oooSev:
                      type: number
                      format: double
                    receiverSysIp:
                      type: string
                    senderSysIp:
                      type: string
                  $$ref: '#/components/schemas/PPLDetail'
              examples:
                PPL detail list:
                  description: PPL detail list
                  value:
                  - carrier: ATT
                    standby: 0
                    active: 1
                  - carrier: Verizon
                    standby: 0
                    active: 1
                  $$ref: '#/components/examples/ComViptelaVmanageServerDevicePplPplapiResponseExamplePpldetaillist'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read,Device Monitoring-write
  /device/ppl/segmentDetail:
    get:
      tags:
      - Overview - PPL
      description: PPL segment detail
      operationId: segmentDetail
      parameters:
      - name: lastNHours
        in: query
        description: last N Hours
        schema:
          type: string
          enum:
          - '1'
          - '3'
          - '6'
          - '12'
          - '24'
      - name: localSystemIp
        in: query
        description: Sender System Ip
        schema:
          type: string
      - name: remoteSystemIp
        in: query
        description: Receiver System Ip
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    memUSage:
                      type: number
                      format: double
                    numCtg:
                      type: integer
                      format: int64
                    oooSev:
                      type: number
                      format: double
                    receiverSysIp:
                      type: string
                    senderSysIp:
                      type: string
                  $$ref: '#/components/schemas/PPLDetail'
              examples:
                PPL segment detail:
                  description: PPL segment detail
                  value:
                  - carrier: ATT
                    standby: 0
                    active: 1
                  - carrier: Verizon
                    standby: 0
                    active: 1
                  $$ref: '#/components/examples/ComViptelaVmanageServerDevicePplPplapiResponseExamplePplsegmentdetail'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read,Device Monitoring-write