Cisco Catalyst SD-WAN Real-Time Monitoring - Device Control API

The Real-Time Monitoring - Device Control API from Cisco Catalyst SD-WAN — 22 operation(s) for real-time monitoring - device control.

Business capability
Telecom Network Operations Management BC-2600

Operations 22

GET /device/control/affinity/config #
GET /device/control/affinity/status #
GET /device/control/connections #
GET /device/control/connectionshistory #
GET /device/control/connectionsinfo #
GET /device/control/count #
GET /device/control/localproperties #
GET /device/control/networksummary #
GET /device/control/regionconnections #
GET /device/control/statistics #
GET /device/control/status #
GET /device/control/summary #
GET /device/control/summary/device #
GET /device/control/synced/connections #
GET /device/control/synced/localproperties #
GET /device/control/synced/waninterface #
GET /device/control/validdevices #
GET /device/control/validvmanageid #
GET /device/control/validvsmarts #
GET /device/control/waninterface #
GET /device/control/waninterface/color #

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-real-time-monitoring-device-control-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-real-time-monitoring-device-control-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Monitoring and Troubleshooting Real-Time Monitoring - Device Control 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: Real-Time Monitoring - Device Control
paths:
  /device/control/affinity/config:
    get:
      tags:
      - Real-Time Monitoring - Device Control
      description: Get affinity config from device (Real Time)
      operationId: getAffinityConfig
      parameters:
      - name: deviceId
        in: query
        description: deviceId - Device IP
        required: true
        schema:
          type: string
          example: 169.254.10.10
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                Affinity config:
                  description: Affinity config
                  value:
                    data:
                    - vdevice-dataKey: 169.254.10.10--0
                      vdevice-name: 169.254.10.10
                      affc-ccl: 0(2)Y
                      affc-equil: 'Yes'
                      affc-ecl: 0(2)
                      affc-index: '0'
                      lastupdated: 1642746599493
                      affc-interface: ge0/1
                      affc-last-resort: 'No'
                      vdevice-host-name: vm3
                      affc-ervc: '2'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: System-read,System-write,Security-read,Security-write
  /device/control/affinity/status:
    get:
      tags:
      - Real-Time Monitoring - Device Control
      description: Get affinity status from device (Real Time)
      operationId: getAffinityStatus
      parameters:
      - name: deviceId
        in: query
        description: deviceId - Device IP
        required: true
        schema:
          type: string
          example: 169.254.10.10
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                Affinity status:
                  description: Affinity status
                  value:
                    data:
                    - affs-acc: 172.16.253.129(0),172.16.255.130(0)
                      vdevice-dataKey: 169.254.10.10--0
                      vdevice-name: 169.254.10.10
                      affs-index: '0'
                      lastupdated: 1642746754330
                      vdevice-host-name: vm3
                      affs-interface: ge0/1
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: System-read,System-write,Security-read,Security-write
  /device/control/connections:
    get:
      tags:
      - Real-Time Monitoring - Device Control
      description: Get connections list from device (Real Time)
      operationId: createRealTimeConnectionList_RealTimeMonitoringDeviceControl_2703
      parameters:
      - name: peer-type
        in: query
        description: Peer type
        schema:
          type: string
          enum:
          - vedge
          - vsmart
          - vmanage
          - vbond
      - name: system-ip
        in: query
        description: Peer system IP
        schema:
          type: string
      - name: deviceId
        in: query
        description: deviceId - Device IP
        required: true
        schema:
          pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
          type: string
          example: 169.254.10.10
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                Connections list:
                  description: Connections list
                  value:
                    data:
                    - domain-id: 1
                      instance: 0
                      vdevice-name: 169.254.10.10
                      behind-proxy: 'No'
                      system-ip: 172.16.253.129
                      remote-color: default
                      site-id: 129
                      private-port: 12346
                      controller-group-id: 0
                      vdevice-host-name: vm3
                      local-color: default
                      uptime: 0:05:55:35
                      peer-type: vsmart
                      v-org-name: vIPtela Inc Regression
                      protocol: dtls
                      vdevice-dataKey: 169.254.10.10-0-default-172.16.253.129-default
                      public-ip: 10.103.129.129
                      public-port: 12346
                      lastupdated: 1642727162594
                      state: up
                      private-ip: 10.103.129.129
                      uptime-date: 1642705800000
                    - domain-id: 1
                      instance: 0
                      vdevice-name: 169.254.10.10
                      behind-proxy: 'No'
                      system-ip: 172.16.255.130
                      remote-color: default
                      site-id: 130
                      private-port: 12346
                      controller-group-id: 0
                      vdevice-host-name: vm3
                      local-color: default
                      uptime: 0:05:55:35
                      peer-type: vsmart
                      v-org-name: vIPtela Inc Regression
                      protocol: dtls
                      vdevice-dataKey: 169.254.10.10-0-default-172.16.255.130-default
                      public-ip: 10.103.130.130
                      public-port: 12346
                      lastupdated: 1642727162594
                      state: up
                      private-ip: 10.103.130.130
                      uptime-date: 1642705800000
                    - domain-id: 0
                      instance: 0
                      vdevice-name: 169.254.10.10
                      behind-proxy: 'No'
                      system-ip: 169.254.10.3
                      remote-color: default
                      site-id: 202
                      private-port: 12346
                      controller-group-id: 0
                      vdevice-host-name: vm3
                      local-color: default
                      uptime: 0:05:55:35
                      peer-type: vmanage
                      v-org-name: vIPtela Inc Regression
                      protocol: dtls
                      vdevice-dataKey: 169.254.10.10-0-default-169.254.10.3-default
                      public-ip: 10.103.202.202
                      public-port: 12346
                      lastupdated: 1642727162594
                      state: up
                      private-ip: 10.103.202.202
                      uptime-date: 1642705800000
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write
  /device/control/connectionshistory:
    get:
      tags:
      - Real-Time Monitoring - Device Control
      description: Get connections history list from device (Real Time)
      operationId: createConnectionHistoryListRealTime
      parameters:
      - name: peer-type
        in: query
        description: Peer type
        schema:
          type: string
          enum:
          - vedge
          - vsmart
          - vmanage
          - vbond
      - name: system-ip
        in: query
        description: Peer system IP
        schema:
          type: string
      - name: deviceId
        in: query
        description: deviceId - Device IP
        required: true
        schema:
          pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
          type: string
          example: 169.254.10.10
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                Connections list:
                  description: Connections list
                  value:
                    data:
                    - instance: 0
                      vdevice-name: 169.254.10.10
                      remote_enum-desc: No Error.
                      system-ip: 0.0.0.0
                      remote-color: default
                      site-id: 0
                      uuid: d7e88eac-250c-4189-bc66-747615452ad9
                      peer-type: vbond
                      protocol: dtls
                      state: tear_down
                      private-ip: 10.103.135.135
                      local_enum-desc: Disconnect vBond after register reply.
                      domain-id: 0
                      rep-count: 0
                      index: 0
                      private-port: 12346
                      vdevice-host-name: vm3
                      vh-org-name: vIPtela Inc Regression
                      local-color: default
                      downtime: 2022-01-20T19:10:43+0000
                      vdevice-dataKey: 169.254.10.10-0-0-2022-01-20T19:10:43+0000
                      public-ip: 10.103.135.135
                      downtime-date: 1642705843000
                      remote_enum: NOERR
                      public-port: 12346
                      lastupdated: 1642727714927
                      local_enum: DISCVBD
                    - instance: 0
                      vdevice-name: 169.254.10.10
                      remote_enum-desc: No Error.
                      system-ip: 169.254.10.3
                      remote-color: default
                      site-id: 202
                      uuid: 387d8bf3-5306-41fe-9090-7ee61c91d9c3
                      peer-type: vmanage
                      protocol: dtls
                      state: tear_down
                      private-ip: 10.103.202.202
                      local_enum-desc: TLOC Disabled.
                      domain-id: 0
                      rep-count: 0
                      index: 1
                      private-port: 12346
                      vdevice-host-name: vm3
                      vh-org-name: vIPtela Inc Regression
                      local-color: biz-internet
                      downtime: 2022-01-20T19:10:24+0000
                      vdevice-dataKey: 169.254.10.10-0-1-2022-01-20T19:10:24+0000
                      public-ip: 10.103.202.202
                      downtime-date: 1642705824000
                      remote_enum: NOERR
                      public-port: 12346
                      lastupdated: 1642727714927
                      local_enum: DISTLOC
                    - instance: 0
                      vdevice-name: 169.254.10.10
                      remote_enum-desc: No Error.
                      system-ip: 172.16.255.130
                      remote-color: default
                      site-id: 130
                      uuid: fca7532b-9366-466a-a8f9-79922392917b
                      peer-type: vsmart
                      protocol: dtls
                      state: tear_down
                      private-ip: 10.103.130.130
                      local_enum-desc: TLOC Disabled.
                      domain-id: 1
                      rep-count: 0
                      index: 2
                      private-port: 12346
                      vdevice-host-name: vm3
                      vh-org-name: vIPtela Inc Regression
                      local-color: biz-internet
                      downtime: 2022-01-20T19:10:24+0000
                      vdevice-dataKey: 169.254.10.10-0-2-2022-01-20T19:10:24+0000
                      public-ip: 10.103.130.130
                      downtime-date: 1642705824000
                      remote_enum: NOERR
                      public-port: 12346
                      lastupdated: 1642727714927
                      local_enum: DISTLOC
                    - instance: 0
                      vdevice-name: 169.254.10.10
                      remote_enum-desc: No Error.
                      system-ip: 169.254.10.3
                      remote-color: default
                      site-id: 202
                      uuid: 387d8bf3-5306-41fe-9090-7ee61c91d9c3
                      peer-type: vmanage
                      protocol: dtls
                      state: tear_down
                      private-ip: 10.103.202.202
                      local_enum-desc: TLOC Disabled.
                      domain-id: 0
                      rep-count: 0
                      index: 5
                      private-port: 12346
                      vdevice-host-name: vm3
                      vh-org-name: vIPtela Inc Regression
                      local-color: default
                      downtime: 2022-01-20T19:09:22+0000
                      vdevice-dataKey: 169.254.10.10-0-5-2022-01-20T19:09:22+0000
                      public-ip: 10.103.202.202
                      downtime-date: 1642705762000
                      remote_enum: NOERR
                      public-port: 12346
                      lastupdated: 1642727714927
                      local_enum: DISTLOC
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: System-read,System-write,Security-read,Security-write
  /device/control/connectionsinfo:
    get:
      tags:
      - Real-Time Monitoring - Device Control
      description: Get connections list from device (Real Time)
      operationId: createRealTimeConnectionList_RealTimeMonitoringDeviceControl_3103
      parameters:
      - name: peer-type
        in: query
        description: Peer type
        schema:
          type: string
          enum:
          - vedge
          - vsmart
          - vmanage
          - vbond
      - name: system-ip
        in: query
        description: Peer system IP
        schema:
          type: string
      - name: deviceId
        in: query
        description: deviceId - Device IP
        required: true
        schema:
          pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
          type: string
          example: 169.254.10.10
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                Connections list:
                  description: Connections list
                  value:
                    data:
                    - vdevice-dataKey: 172.16.255.11---
                      vdevice-name: 172.16.255.11
                      rate: 'Per-Control Connection Rate: 300 pps'
                      lastupdated: 1646962973344
                      vdevice-host-name: vm1
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: System-read,System-write,Security-read,Security-write,Device Monitoring-read,Device Monitoring-write
  /device/control/count:
    get:
      tags:
      - Real-Time Monitoring - Device Control
      description: Get number of vedges and vsmart device in different control states
      operationId: getTotalCountForDeviceStates
      parameters:
      - name: isCached
        in: query
        description: Device State cached
        schema:
          type: boolean
          default: false
      - name: site-id
        in: query
        description: Optional site ID  to filter devices
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                Device state count:
                  description: Device state count
                  value:
                    data:
                    - name: ControlStatus
                      count: 7
                      detailsURL: ''
                      status: error
                      statusList:
                      - name: Controlup
                        status: up
                        message: devicesup
                        detailsURL: /dataservice/device/control/networksummary?state=up
                        count: 7
                      - name: Partial
                        status: warning
                        message: devicesdown
                        detailsURL: /dataservice/device/control/networksummary?state=partial
                        count: 0
                      - name: Controldown
                        status: error
                        message: devicesdown
                        detailsURL: /dataservice/device/control/networksummary?state=down
                        count: 0
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read
  /device/control/links:
    get:
      tags:
      - Real-Time Monitoring - Device Control
      description: Get connections list
      operationId: createLinkList
      parameters:
      - name: state
        in: query
        description: Device State
        required: true
        schema:
          type: string
          example: up
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                Connections list:
                  description: Connections list
                  value:
                    data:
                    - state: up
                      color1: default
                      color2: default
                      lastupdated: '1646912547015'
                      linkKey: 172.16.255.19:default-172.16.255.26:default
                      linkKeyDisplay: 172.16.255.19(default)-172.16.255.26(default)
                      adeviceId: 172.16.255.26
                      bdeviceId: 172.16.255.19
                      asystem-ip: 172.16.255.26
                      bsystem-ip: 172.16.255.19
                      asite-id: --
                      bsite-id: '100'
                      ahost-name: vm16
                      bhost-name: vm9
                      apersonality: vbond
                      bpersonality: vsmart
                    - state: up
                      color1: default
                      color2: default
                      lastupdated: '1646912512113'
                      linkKey: 172.16.255.20:default-172.16.255.26:default
                      linkKeyDisplay: 172.16.255.20(default)-172.16.255.26(default)
                      adeviceId: 172.16.255.26
                      bdeviceId: 172.16.255.20
                      asystem-ip: 172.16.255.26
                      bsystem-ip: 172.16.255.20
                      asite-id: --
                      bsite-id: '200'
                      ahost-name: vm16
                      bhost-name: vm10
                      apersonality: vbond
                      bpersonality: vsmart
                    - state: up
                      color1: default
                      color2: default
                      lastupdated: '1646912347752'
                      linkKey: 172.16.255.22:default-172.16.255.26:default
                      linkKeyDisplay: 172.16.255.22(default)-172.16.255.26(default)
                      adeviceId: 172.16.255.26
                      bdeviceId: 172.16.255.22
                      asystem-ip: 172.16.255.26
                      bsystem-ip: 172.16.255.22
                      asite-id: --
                      bsite-id: '200'
                      ahost-name: vm16
                      bhost-name: vm12
                      apersonality: vbond
                      bpersonality: vmanage
                    - state: up
                      color1: lte
                      color2: default
                      lastupdated: '1646912547013'
                      linkKey: 172.16.255.14:lte-172.16.255.19:default
                      linkKeyDisplay: 172.16.255.14(lte)-172.16.255.19(default)
                      adeviceId: 172.16.255.14
                      bdeviceId: 172.16.255.19
                      asystem-ip: 172.16.255.14
                      bsystem-ip: 172.16.255.19
                      asite-id: '400'
                      bsite-id: '100'
                      ahost-name: vm4
                      bhost-name: vm9
                      apersonality: vedge
                      bpersonality: vsmart
                    - state: up
                      color1: lte
                      color2: default
                      lastupdated: '1646912512112'
                      linkKey: 172.16.255.14:lte-172.16.255.20:default
                      linkKeyDisplay: 172.16.255.14(lte)-172.16.255.20(default)
                      adeviceId: 172.16.255.14
                      bdeviceId: 172.16.255.20
                      asystem-ip: 172.16.255.14
                      bsystem-ip: 172.16.255.20
                      asite-id: '400'
                      bsite-id: '200'
                      ahost-name: vm4
                      bhost-name: vm10
                      apersonality: vedge
                      bpersonality: vsmart
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read
  /device/control/localproperties:
    get:
      tags:
      - Real-Time Monitoring - Device Control
      description: Get local properties list (Real Time)
      operationId: createLocalPropertiesListListRealTIme
      parameters:
      - name: deviceId
        in: query
        description: deviceId - Device IP
        required: true
        schema:
          type: string
          example: 169.254.10.10
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                Local properties list:
                  description: Local properties list
                  value:
                    data:
                    - certificate-not-valid-before: Jan 26 07:37:47 2022 GMT
                      site-id: '100'
                      protocol: dtls
                      root-ca-chain-status: Installed
                      certificate-not-valid-after: Jan 26 07:37:47 2023 GMT
                      dns-name: vbond
                      vdevice-host-name: vm1
                      port-hopped: 'TRUE'
                      device-role: edge-router
                      certificate-status: Installed
                      device-type: vedge
                      uuid: a555e577-d513-4768-a695-93574a15f5cc
                      sp-organization-name: vIPtela Inc Regression
                      lastupdated: 1643348428058
                      region-id-set: N/A
                      keygen-interval: '1:00:00:00'
                      domain-id: '1'
                      time-since-port-hop: '1:21:43:52'
                      system-ip: 172.16.255.11
                      board-serial: '12346580'
                      certificate-validity: Valid
                      max-controllers: '0'
                      tls-port: '0'
                      organization-name: vIPtela Inc Regression
                      vdevice-name: 172.16.255.11
                      vsmart-list-version: '0'
                      number-vbond-peers: '0'
                      vdevice-dataKey: 172.16.255.11
                      token: Invalid
                      number-active-wan-interfaces: '1'
                      register-interval: 0:00:00:30
                      retry-interval: 0:00:00:15
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: System-read,System-write,Security-read,Security-write
  /device/control/networksummary:
    get:
      tags:
      - Real-Time Monitoring - Device Control
      description: Get list of unreachable devices
      operationId: networkSummary
      parameters:
      - name: state
        in: query
        description: Device State
        schema:
          type: string
          example: up
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
              examples:
                list of unreachable devices:
                  description: list of unreachable devices
                  value:
                    data:
                    - device-model: vedge-cloud
                      ompPeers: '2'
                      number-vsmart-peers: 2
                      local-system-ip: 172.16.255.21
                      system-ip: 172.16.255.21
                      host-name: vm11
                      site-id: '100'
                      version: 20.9.999-1766
                      uuid: 2b57ef1a-5eb2-4d8d-8676-cce19b56b26b
                      board-serial: '12345962'
                      bfdSessions: '3'
                      device-type: vedge
                      lastupdated: 1646917368708
                      reachability: reachable
                      controlConnections: '3'
                      uptime-date: 1646908860000
                      controlConnectionsToVsmarts: '2'
                    - device-model: vedge-cloud
                      ompPeers: '2'
                      number-vsmart-peers: 2
                      local-system-ip: 172.16.255.11
                      system-ip: 172.16.255.11
                      host-name: vm1
                      site-id: '100'
                      version: 20.9.999-1766
                      uuid: 84d1ab4e-0cbf-4369-a290-08fafeb80f95
                      board-serial: '12345974'
                      bfdSessions: '3'
                      device-type: vedge
                      lastupdated: 1646967284462
                      reachability: reachable
                      controlConnections: '3'
                      uptime-date: 1646909100000
                      controlConnectionsToVsmarts: '2'
                    - device-model: vsmart
                      ompPeers: '6'
                      number-vsmart-peers: 1
                      local-system-ip: 172.16.255.19
                      system-ip: 172.16.255.19
                      host-name: vm9
                      site-id: '100'
                      version: 20.9.999-1766
                      uuid: 9abd3af9-9087-497d-8b99-8fd0a7baa3f2
                      board-serial: '12345967'
                      device-type: vsmart
                      lastupdated: 1646967277159
                      reachability: reachable
                      controlConnections: '9'
                      uptime-date: 1646908920000
                      controlConnectionsToVsmarts: '1'
                    - device-model: vsmart
                      ompPeers: '6'
                      number-vsmart-peers: 1
                      local-system-ip: 172.16.255.20
                      system-ip: 172.16.255.20
                      host-name: vm10
                      site-id: '200'
                      version: 20.9.999-1766
                      uuid: 43ba3223-9df7-4cc9-a059-a12e5382d79d
                      board-serial: '12345961'
                      device-type: vsmart
                      lastupdated: 1646967275863
                      reachability: reachable
                      controlConnections: '9'
                      uptime-date: 1646908860000
                      controlConnectionsToVsmarts: '1'
                    - device-model: vedge-cloud
                      ompPeers: '2'
                      number-vsmart-peers: 2
                      local-system-ip: 172.16.255.14
                      system-ip: 172.16.255.14
                      host-name: vm4
                      site-id: '400'
                      version: 20.9.999-1766
                      uuid: a66335c5-451f-4b93-a752-4116d688f347
                      board-serial: '12345970'
                      bfdSessions: '4'
                      device-type: vedge
                      lastupdated: 1646967282559
                      reachability: reachable
                      controlConnections: '3'
                      uptime-date: 1646908980000
                      controlConnectionsToVsmarts: '2'
                    - device-model: vedge-C8000V
                      ompPeers: '2'
                      number-vsmart-peers: 2
                      local-system-ip: 172.16.255.15
                      system-ip: 172.16.255.15
                      host-name: vm5
                      site-id: '500'
                      version: 17.09.01.0.154453
                      uuid: C8K-8bda7a5d-6b75-47ec-a658-b30ca54e30eb
                      board-serial: '12345703'
                      bfdSessions: '4'
                      device-type: vedge
                      lastupdated: 1646967275462
                      reachability: reachable
                      controlConnections: '3'
                      uptime-date: 1646909400000
                      controlConnectionsToVsmarts: '2'
                    - device-model: vedge-C8000V
                      ompPeers: '2'
                      number-vsmart-peers: 2
                      local-system-ip: 172.16.255.16
                      system-ip: 172.16.255.16
                      host-name: vm6
                      site-id: '600'
                      version: 17.09.01.0.154453
                      uuid: C8K-46aa4ddc-7468-45c2-9144-2d60c2f553f3
                      board-serial: '12345702'
                      bfdSessions: '4'
                      device-type: vedge
                      lastupdated: 1646967277103
                      reachability: reachable
                      controlConnections: '3'
                      uptime-date: 1646909400000
                      controlConnectionsToVsmarts: '2'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: Device Monitoring-read
  /device/control/regionconnections:
    get:
      tags:
      - Real-Time Monitoring - Device Control
      description: Get connections list from device (Real Time)
      operationId: createRealTimeRegionConnectionList
      parameters:
      - name: deviceId
        in: query
        description: deviceId - Device IP
        required: true
        schema:
          pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
          type: string
          example: 169.254.10.10
      responses:
        '2

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