openapi: 3.2.0
info:
  title: Monitoring and Troubleshooting Real-Time Monitoring - VM 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 - VM
paths:
  /device/vm/nics:
    get:
      tags:
      - Real-Time Monitoring - VM
      description: Get vbranch vm lifecycle state (NIC)
      operationId: getVbranchVMLifecycleNics
      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:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                vBranch VM lifecycle state (NIC):
                  description: vBranch VM lifecycle state (NIC)
                  value:
                    data:
                    - vdevice-name: 172.16.255.15
                      vdevice-host-name: vm5
                      name: int-mgmt-net-subnet
                      vnic-id: '1'
                      network: int-mgmt-net
                      vdevice-dataKey: 172.16.255.15
                      lastupdated: 1642581869106
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: System-read,System-write,Routing-read,Routing-write
  /device/vm/notifications:
    get:
      tags:
      - Real-Time Monitoring - VM
      description: Get CloudDock vm lifecycle state
      operationId: getCloudDockVMLifecycleNics
      parameters:
      - name: userGroup
        in: query
        description: userGroup Name
        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
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                'CloudDock VM lifecycle state ':
                  description: 'CloudDock VM lifecycle state '
                  value:
                    data:
                    - vdevice-name: 172.16.255.15
                      vdevice-host-name: vm5
                      depname: SystemAdminTena_isrv1_0_72619ffd-df8e-4c32-b24a-3d7b03a31303
                      eventTime: '600'
                      hostname: nfvis
                      type: local
                      vmid: '1'
                      vmName: ISR
                      status_message: active
                      status_code: '200'
                      user-group: router1
                      category: Sample_Category_0001
                      vdevice-dataKey: 172.16.255.15
                      lastupdated: 1642581869106
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: System-read,System-write,Routing-read,Routing-write
  /device/vm/oper/state:
    get:
      tags:
      - Real-Time Monitoring - VM
      description: Get vbranch vm lifecycle state
      operationId: getVbranchVMLifecycle
      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:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                vBranch VM lifecycle state:
                  description: vBranch VM lifecycle state
                  value:
                    data:
                    - vdevice-dataKey: 172.16.255.15
                      vdevice-name: 172.16.255.15
                      vdevice-host-name: vm5
                      name: int-mgmt-net-subnet
                      state: Active
                      lastupdated: 1642581869106
                      vcpus: '2'
                      memory-mb: '4096'
                      color: default
                      root-disk-mb: '8192'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: System-read,System-write,Routing-read,Routing-write
  /device/vm/state:
    get:
      tags:
      - Real-Time Monitoring - VM
      description: Get vm lifecycle state
      operationId: getVMLifeCycleState
      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:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
              examples:
                VM lifecycle state:
                  description: VM lifecycle state
                  value:
                    data:
                    - vdevice-name: 172.16.255.15
                      vdevice-host-name: vm5
                      deployment_name: dep1
                      deployment_id: SystemAdminTenantIdisrv1
                      name: router1
                      state: Active
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '500':
          description: Internal Server Error
      x-roles-required: System-read,System-write,Routing-read,Routing-write