openapi: 3.2.0 info: title: Monitoring and Troubleshooting Troubleshooting Tools - Diagnostics 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: Troubleshooting Tools - Diagnostics paths: /statistics/speedtest: get: tags: - Troubleshooting Tools - Diagnostics description: Get stats raw data operationId: getStatDataRawData_TroubleshootingToolsDiagnostics_2103 parameters: - name: query in: query description: Query string schema: type: string example: query: condition: AND rules: - value: - '24' field: entry_time type: date operator: last_n_hours aggregation: metrics: - property: latency type: avg - name: page in: query description: page number schema: minimum: 1 type: integer format: int64 - name: pageSize in: query description: page size schema: minimum: 1 type: integer format: int64 - name: sortBy in: query description: sort by(emp:entry_time) schema: pattern: ^[a-zA-Z-_]+$ type: string - name: sortOrder in: query description: sort order(emp:asc、ASC、Asc、desc、Desc、DESC) schema: type: string responses: '200': description: Success content: application/json: schema: type: object examples: Search result: description: Search result value: data: - 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 x-roles-required: default post: tags: - Troubleshooting Tools - Diagnostics description: Get stats raw data operationId: getStatsRawData_TroubleshootingToolsDiagnostics_2104 parameters: - name: page in: query description: page number schema: minimum: 1 type: integer format: int64 - name: pageSize in: query description: page size schema: minimum: 1 type: integer format: int64 - name: sortBy in: query description: sort by schema: pattern: ^[a-zA-Z-_]+$ type: string - name: sortOrder in: query description: sort order schema: type: string 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: - 172.16.255.11 field: source_local_ip type: string operator: in - value: - completed field: status type: string operator: in size: 10000 required: true responses: '200': description: Success content: application/json: schema: type: object examples: Search result: description: Search result value: header: generatedOn: 1719824542590 viewKeys: uniqueKey: [] preferenceKey: grid-raw_speedtest columns: - title: Time property: entry_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time dataType: date - title: Destination Device property: destination_local_ip dataType: string - title: Source Circuit property: source_circuit dataType: string - title: Destination Circuit property: destination_circuit dataType: string - title: Down Speed (Mbps) property: down_speed dataType: number - title: Up Speed (Mbps) property: up_speed dataType: number - title: Down Bandwidth (Mbps) property: down_bw display: formatKbpsToMbps dataType: number - title: Up Bandwidth (Mbps) property: up_bw display: formatKbpsToMbps dataType: number fields: - property: entry_time dataType: date - property: destination_local_ip dataType: string - property: source_circuit dataType: string - property: destination_circuit dataType: string - property: down_speed dataType: number - property: up_speed dataType: number - property: down_bw dataType: number display: formatKbpsToMbps - property: up_bw dataType: number display: formatKbpsToMbps - property: session_id dataType: string - property: speedtest_id dataType: string - property: logid dataType: number - property: deviceUUID dataType: string - property: status dataType: string chart: {} pageInfo: startTime: '1719821609758' endTime: '1719821609758' count: 1 data: - entry_time: 1719821609758 up_speed: 228 down_speed: 227.71 up_bw: NA down_bw: NA destination_ip: 172.16.255.16 destination_local_ip: 172.16.255.16 source_ip: 172.16.255.11 source_local_ip: 172.16.255.11 source_circuit: '' destination_circuit: -- session_id: 83a52af4-8daf-46e1-9f8c-34ab4225eff5 speedtest_id: '' logid: 4 device_uuid: C8K-9abc344d-9193-41bb-bc1d-26c834c31d5e status: completed error: None tenant: default port: '80' source_interface: Tunnel0 destination_interface: Tunnel0 source_interface_addr: 100.0.0.1 destination_interface_addr: 100.0.0.6 '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: default /statistics/speedtest/aggregation: post: tags: - Troubleshooting Tools - Diagnostics 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_TroubleshootingToolsDiagnostics_3304 requestBody: description: Stats query string content: application/json: schema: type: object examples: query string: {} required: true responses: '200': description: Success content: application/json: schema: type: object examples: query string: {} '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: default,dca get: tags: - Troubleshooting Tools - Diagnostics 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_TroubleshootingToolsDiagnostics_3303 parameters: - name: query in: query description: Query filter schema: type: string examples: query string: {} responses: '200': description: Success content: application/json: schema: type: object examples: query string: {} '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: default /statistics/speedtest/csv: get: tags: - Troubleshooting Tools - Diagnostics description: Get raw data with optional query as CSV operationId: getStatDataRawDataAsCSV_TroubleshootingToolsDiagnostics_2503 parameters: - name: query in: query description: Query string 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 examples: Search result in csv format: description: Search result in csv format value: blob:https:///82c972bc-f9b3-4cce-bb70-1e1b033ef1cd '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: default /statistics/speedtest/doccount: get: tags: - Troubleshooting Tools - Diagnostics description: Get response count of a query operationId: getCount_TroubleshootingToolsDiagnostics_3003 parameters: - name: query in: query description: Query required: true schema: type: string example: query: condition: AND rules: - value: - '24' field: entry_time type: date operator: last_n_hours responses: '200': description: Success content: application/json: schema: type: object examples: Query result count: description: Query result count value: count: 17193 '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error post: tags: - Troubleshooting Tools - Diagnostics description: Get response count of a query operationId: getCountPost_TroubleshootingToolsDiagnostics_3004 requestBody: description: Query content: application/json: schema: type: object examples: Query: description: Query 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 examples: Query result count: description: Query result count value: count: 9642 '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /statistics/speedtest/fields: get: tags: - Troubleshooting Tools - Diagnostics description: Get fields and type operationId: getStatDataFields_TroubleshootingToolsDiagnostics_2803 responses: '200': description: Success content: application/json: schema: type: object example: - dataType: string property: mac - dataType: string property: vap - dataType: number property: rssi - dataType: string property: mode - dataType: number property: bandwidth - dataType: string property: data_security - dataType: number property: rx_rate - dataType: string property: assoc_time - dataType: date property: entry_time - dataType: date property: statcycletime - dataType: string property: ssid - dataType: number property: vip_idx - dataType: date property: vip_time - dataType: string property: vdevice_name - dataType: string property: host_name - dataType: string property: device_model '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /statistics/speedtest/page: post: tags: - Troubleshooting Tools - Diagnostics description: Get stats raw data operationId: getPostStatsPaginationRawData_TroubleshootingToolsDiagnostics_2604 parameters: - name: scrollId in: query description: ES scroll Id schema: type: string example: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ== - name: count in: query description: Result size schema: type: integer format: int64 example: 10 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 required: true responses: '200': description: Success content: application/json: schema: type: object examples: Search result: description: Search result value: data: - mem_used: 19407626240 disk_avail: 9305948160 device_model: vmanage mem_cached: 6740430848 mem_util: 0.59 min1_avg: 0.92 disk_used: 5789007872 statcycletime: 1647394800045 tenant: 57501bad-32a7-4f52-8f54-8547dcd7403e entry_time: 1647393870251 runningp: 0 cpu_user: 8.63 cpu_idle_new: 88.14 vip_time: 1647393870252 min15_avg: 1.08 totalp: 2427 cpu_idle: 88.14 mem_buffers: 892911616 cpu_system: 3.23 vmanage_system_ip: 169.254.10.2 min5_avg: 1.07 cpu_min1_avg: 0.115 mem_free: 5716930560 vdevice_name: 172.16.255.201 vip_idx: 82 cpu_min15_avg: 0.135 system_ip: 172.16.255.201 cpu_user_new: 8.63 cpu_system_new: 3.23 host_name: vm201 cpu_min5_avg: 0.13375 id: 4YphkH8BPIGvVbrdtzXi - mem_used: 19534016512 disk_avail: 9304268800 device_model: vmanage mem_cached: 6747897856 mem_util: 0.6 min1_avg: 1.14 disk_used: 5790687232 statcycletime: 1647394800046 tenant: 57501bad-32a7-4f52-8f54-8547dcd7403e entry_time: 1647394110479 runningp: 0 cpu_user: 5.53 cpu_idle_new: 91.49 vip_time: 1647394110479 min15_avg: 1.1 totalp: 2323 cpu_idle: 91.49 mem_buffers: 902213632 cpu_system: 2.97 vmanage_system_ip: 169.254.10.2 min5_avg: 1.14 cpu_min1_avg: 0.1425 mem_free: 5573771264 vdevice_name: 172.16.255.201 vip_idx: 86 cpu_min15_avg: 0.1375 system_ip: 172.16.255.201 cpu_user_new: 5.53 cpu_system_new: 2.97 host_name: vm201 cpu_min5_avg: 0.1425 id: 5YphkH8BPIGvVbrdtzXi pageInfo: startTime: '1647394800045' endTime: '1647394800047' scrollId: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ== hasMoreData: true count: 2 totalCount: 11140 '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Device Monitoring-read get: tags: - Troubleshooting Tools - Diagnostics description: Get stats raw data operationId: getStatsPaginationRawData_TroubleshootingToolsDiagnostics_2603 parameters: - name: query in: query description: Query string schema: type: string example: query: condition: AND rules: - value: - '24' field: entry_time type: date operator: last_n_hours - name: scrollId in: query description: ES scroll Id schema: type: string example: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAOIWZ1NQbXpvQ29Uc0stNzZ2UzlwTEREUQ== - name: count in: query description: Result size schema: type: integer format: int64 example: 10 responses: '200': description: Success content: application/json: schema: type: object examples: Search result: description: Search result value: data: - mem_used: 19407626240 disk_avail: 9305948160 device_model: vmanage mem_cached: 6740430848 mem_util: 0.59 min1_avg: 0.92 disk_used: 5789007872 statcycletime: 1647394800045 tenant: 57501bad-32a7-4f52-8f54-8547dcd7403e entry_time: 1647393870251 runningp: 0 cpu_user: 8.63 cpu_idle_new: 88.14 vip_time: 1647393870252 min15_avg: 1.08 totalp: 2427 cpu_idle: 88.14 mem_buffers: 892911616 cpu_system: 3.23 vmanage_system_ip: 169.254.10.2 min5_avg: 1.07 cpu_min1_avg: 0.115 mem_free: 5716930560 vdevice_name: 172.16.255.201 vip_idx: 82 cpu_min15_avg: 0.135 system_ip: 172.16.255.201 cpu_user_new: 8.63 cpu_system_new: 3.23 host_name: vm201 cpu_min5_avg: 0.13375 id: 4YphkH8BPIGvVbrdtzXi - mem_used: 19534016512 disk_avail: 9304268800 device_model: vmanage mem_cached: 6747897856 mem_util: 0.6 min1_avg: 1.14 disk_used: 5790687232 statcycletime: 1647394800046 tenant: 57501bad-32a7-4f52-8f54-8547dcd7403e entry_time: 1647394110479 runningp: 0 cpu_user: 5.53 cpu_idle_new: 91.49 vip_time: 1647394110479 min15_avg: 1.1 totalp: 2323 cpu_idle: 91.49 mem_buffers: 902213632 cpu_system: 2.97 vmanage_system_ip: 169.254.10.2 min5_avg: 1.14 cpu_min1_avg: 0.1425 mem_free: 5573771264 vdevice_name: 172.16.255.201 vip_idx: 86 cpu_min15_avg: 0.1375 system_ip: 172.16.255.201 cpu_user_new: 5.53 cpu_system_new: 2.97 host_name: vm201 cpu_min5_avg: 0.1425 id: 5YphkH8BPIGvVbrdtzXi pageInfo: startTime: '1647394800045' endTime: '1647394800047' scrollId: DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAf4WcUlydS1uYzlTdXFhR05GTlBpTFJ4QQ== hasMoreData: true count: 2 totalCount: 11140 '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Device Monitoring-read /statistics/speedtest/query/fields: get: tags: - Troubleshooting Tools - Diagnostics description: Get query fields operationId: getStatQueryFields_TroubleshootingToolsDiagnostics_3403 responses: '200': description: Success content: application/json: schema: type: object examples: Query result count: description: Query result count value: data: - property: entry_time name: Event Time isRequired: true dataType: date fieldData: type: dateList options: - key: last_1_hour value: Last 1 hour number: '1' enableDateFields: false - key: last_3_hours value: Last 3 hours number: '3' enableDateFields: false - key: last_6_hours value: Last 6 hours number: '6' enableDateFields: false - key: last_12_hours value: Last 12 hours number: '12' enableDateFields: false - key: last_24_hours value: Last 24 hours number: '24' enableDateFields: false isSelected: true - key: last_168_hours value: Last 7 days number: '168' enableDateFields: false - key: custom value: Custom enableDateFields: true - property: vdevice_name name: Device name isRequired: true multiSelect: false dataType: string '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /stream/device/capture: post: tags: - Troubleshooting Tools - Diagnostics description: Create packet capture session operationId: getSessionInfoCapture requestBody: description: Packet Capture Parameters content: application/json: schema: type: object properties: bidirectional: type: boolean example: true destination_ip: type: string example: 2.2.2.2 destination_port: type: string example: '222' deviceUUID: type: string example: C8K-4d204234-4aa1-4311-8913-67beeb8651c0 interface: type: string example: GigabitEthernet5 interfaceIP: type: string example: 10.1.14.14 protocol: type: string example: '6' source_ip: type: string example: 1.1.1.1 source_port: type: string example: '111' type: type: string example: control enum: - control - data vpn: type: string example: '0' $$ref: '#/components/schemas/CreatePacketCaptureReq' required: true responses: '200': description: Success content: application/json: schema: type: object properties: '@rid': type: integer format: int32 example: 3765 JSessionId: type: string example: 2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac isNewSession: type: boolean example: true isOwner: type: boolean example: true renewalTime: type: integer format: int64 example: 1695089425303 requestStatus: type: string enum: - START - STOP - IN_PROGRESS - NOT_STARTED sessionId: type: string format: uuid example: a9fd18d5-0303-43d1-b821-2358992e0274 startTime: type: integer format: int64 example: 1695089425303 status: type: string example: success enum: - success - failure statusMessage: type: string example: ok type: type: string example: pcap user: type: string example: admin userIp: type: string example: 10.0.1.1 uuid: type: string example: C8K-86adc384-8408-4cec-acdb-8117c40a8a24 $$ref: '#/components/schemas/PacketCaptureInfo' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/capture/disable/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics description: Disable packet capture session operationId: disablePacketCaptureSession parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string example: success $$ref: '#/components/schemas/DisablePacketCaptureRes' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/capture/download/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics description: Download packet capture file operationId: downloadFile parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/octet-stream: schema: type: string format: binary '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/capture/forcedisbale/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics description: Force stop packet capture session operationId: forceStopPcapSession parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string example: success $$ref: '#/components/schemas/ForceStopPacketCaptureRes' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/capture/start/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics description: Start packet capture session operationId: startPcapSession parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: '@rid': type: integer format: int32 example: 3765 JSessionId: type: string example: 2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac isNewSession: type: boolean example: true isOwner: type: boolean example: true renewalTime: type: integer format: int64 example: 1695089425303 requestStatus: type: string enum: - START - STOP - IN_PROGRESS - NOT_STARTED sessionId: type: string format: uuid example: a9fd18d5-0303-43d1-b821-2358992e0274 startTime: type: integer format: int64 example: 1695089425303 status: type: string example: success enum: - success - failure statusMessage: type: string example: ok type: type: string example: pcap user: type: string example: admin userIp: type: string example: 10.0.1.1 uuid: type: string example: C8K-86adc384-8408-4cec-acdb-8117c40a8a24 $$ref: '#/components/schemas/PacketCaptureInfo' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/capture/status/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics description: Get packet capture session status operationId: getFileDownloadStatus parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: fileDownloadStatus: type: string example: NOT_STARTED enum: - NOT_STARTED - STARTED - IN_PROGRESS - COMPLETED - ERROR sessionStatus: type: string enum: - START - STOP - IN_PROGRESS - NOT_STARTED $$ref: '#/components/schemas/GetFileDownloadStatusRes' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/capture/stop/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics description: Stop packet capture session operationId: stopPcapSession parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: '@rid': type: integer format: int32 example: 3765 JSessionId: type: string example: 2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac isNewSession: type: boolean example: true isOwner: type: boolean example: true renewalTime: type: integer format: int64 example: 1695089425303 requestStatus: type: string enum: - START - STOP - IN_PROGRESS - NOT_STARTED sessionId: type: string format: uuid example: a9fd18d5-0303-43d1-b821-2358992e0274 startTime: type: integer format: int64 example: 1695089425303 status: type: string example: success enum: - success - failure statusMessage: type: string example: ok type: type: string example: pcap user: type: string example: admin userIp: type: string example: 10.0.1.1 uuid: type: string example: C8K-86adc384-8408-4cec-acdb-8117c40a8a24 $$ref: '#/components/schemas/PacketCaptureInfo' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/capture/vnicsInfo/{vnfId}: get: tags: - Troubleshooting Tools - Diagnostics description: Get vnic info by vrfId operationId: getVnicInfoByVnfId parameters: - name: vnfId in: path required: true schema: type: string responses: '200': description: Success content: application/json: schema: type: array properties: empty: type: boolean items: type: object properties: deploymentName: type: string network: type: string nicId: type: string vmGroupName: type: string $$ref: '#/components/schemas/VnicInfo' $$ref: '#/components/schemas/GetVnicInfoRes' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/capture/{deviceUUID}/{sessionId}: post: tags: - Troubleshooting Tools - Diagnostics description: Form post packet capture operationId: formPostPacketCapture parameters: - name: deviceUUID in: path required: true schema: type: string - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string example: success $$ref: '#/components/schemas/FormPacketCaptureRes' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: vmanage-http-stream /stream/device/log: post: tags: - Troubleshooting Tools - Diagnostics operationId: getSessionInfoLog requestBody: content: application/json: schema: type: string required: true responses: default: description: default response content: application/json: {} x-roles-required: Tools-write /stream/device/log/disable/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics operationId: disableDeviceLog parameters: - name: sessionId in: path required: true schema: type: object properties: uuid: type: string description: This is valid uuid $$ref: '#/components/schemas/Uuid' responses: default: description: default response content: application/json: {} x-roles-required: Tools-write /stream/device/log/download/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics operationId: downloadDebugLog parameters: - name: sessionId in: path description: Session Id required: true schema: type: string responses: default: description: default response content: application/octet-stream: {} x-roles-required: Tools-read /stream/device/log/renew/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics operationId: renewSessionInfo parameters: - name: sessionId in: path required: true schema: type: object properties: uuid: type: string description: This is valid uuid $$ref: '#/components/schemas/Uuid' responses: default: description: default response content: application/json: {} x-roles-required: Tools-write /stream/device/log/search/{sessionId}: post: tags: - Troubleshooting Tools - Diagnostics operationId: searchDeviceLog parameters: - name: sessionId in: path description: Session Id required: true schema: type: string requestBody: content: application/json: schema: type: string required: true responses: default: description: default response content: application/json: {} x-roles-required: Tools-read /stream/device/log/sessions: get: tags: - Troubleshooting Tools - Diagnostics operationId: getSessions responses: default: description: default response content: application/json: {} x-roles-required: Tools-read /stream/device/log/sessions/clear/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics operationId: clearSession parameters: - name: sessionId in: path description: Session Id required: true schema: type: string responses: default: description: default response content: application/json: {} x-roles-required: Tools-write /stream/device/log/type: get: tags: - Troubleshooting Tools - Diagnostics operationId: getLogType parameters: - name: uuid in: query description: Device uuid required: true schema: type: string responses: default: description: default response content: application/json: {} x-roles-required: Tools-read /stream/device/log/{logType}/{deviceUUID}/{sessionId}: post: tags: - Troubleshooting Tools - Diagnostics operationId: streamLog parameters: - name: logType in: path description: Log type required: true schema: type: string - name: deviceUUID in: path description: Device uuid required: true schema: type: string - name: sessionId in: path description: Session Id required: true schema: type: string requestBody: content: '*/*': schema: type: string required: true responses: default: description: default response content: application/json: {} x-roles-required: vmanage-http-stream /stream/device/log/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics operationId: getDeviceLog parameters: - name: sessionId in: path required: true schema: type: object properties: uuid: type: string description: This is valid uuid $$ref: '#/components/schemas/Uuid' - name: logId in: query schema: type: integer format: int64 default: -1 responses: default: description: default response content: application/json: {} x-roles-required: Tools-read /stream/device/speed: post: tags: - Troubleshooting Tools - Diagnostics operationId: getSession requestBody: content: application/json: schema: type: object properties: destinationColor: type: string example: lte destinationIfAddr: type: string example: 1.1.1.1 destinationInterface: type: string example: GigabitEthernet5 destinationIp: type: string example: 10.1.15.13 deviceUUID: type: string port: type: string example: '9999' server-list: type: array items: type: object properties: server-name: type: string server-ports: type: string $$ref: '#/components/schemas/ServerList' sourceColor: type: string example: lte sourceIfAddr: type: string example: 1.1.1.1 sourceInterface: type: string example: GigabitEthernet4 sourceIp: type: string example: 10.1.15.13 description: This is valid SpeedTestSession $$ref: '#/components/schemas/SpeedTestSession' required: true responses: '200': description: Success content: application/json: schema: type: object properties: isNewSession: type: boolean example: true isOwner: type: boolean example: true renewalTime: type: integer format: int64 example: 1692757301266 sessionId: type: string example: de26406d-21f2-4d3d-bc82-6f36553c45bf startTime: type: integer format: int64 example: 1692757301266 type: type: string example: speedTest userIp: type: string example: 172.16.255.15 uuid: type: string example: C8K-63eadff3-fa6d-4779-add0-d712a36c6f73 description: This is valid speedTestResponse $$ref: '#/components/schemas/SpeedTestResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/speed/disable/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics operationId: disableSpeedTestSession parameters: - name: sessionId in: path description: sessionId required: true schema: type: object properties: uuid: type: string description: This is valid uuid $$ref: '#/components/schemas/Uuid' examples: sessionId: description: sessionId value: 5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string example: success description: This is valid speedTestStatusResponse $$ref: '#/components/schemas/SpeedTestStatusResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/speed/interface/bandwidth: get: tags: - Troubleshooting Tools - Diagnostics operationId: getInterfaceBandwidth parameters: - name: deviceUUID in: query required: true schema: type: object properties: deviceUuid: type: string example: C8K-f9f4a977-be6c-47f7-b3b2-10e916bb24db description: This is valid DeviceUuid $$ref: '#/components/schemas/DeviceUuid' - name: circuit in: query schema: type: string - name: sourceInterface in: query schema: type: string responses: '200': description: Success content: application/json: schema: type: object properties: down_bw: type: string example: NA up_bw: type: string example: NA description: This is valid speedTestInterfaceResponse $$ref: '#/components/schemas/SpeedTestInterfaceResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Device Monitoring-read /stream/device/speed/start/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics operationId: startSpeedTest parameters: - name: sessionId in: path description: sessionId required: true schema: type: object properties: uuid: type: string description: This is valid uuid $$ref: '#/components/schemas/Uuid' examples: sessionId: description: sessionId value: 5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string example: success description: This is valid speedTestStatusResponse $$ref: '#/components/schemas/SpeedTestStatusResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/speed/status/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics operationId: getSpeedTestStatus parameters: - name: sessionId in: path description: sessionId required: true schema: type: object properties: uuid: type: string description: This is valid uuid $$ref: '#/components/schemas/Uuid' examples: sessionId: description: sessionId value: 5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string example: success description: This is valid speedTestStatusResponse $$ref: '#/components/schemas/SpeedTestStatusResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/speed/stop/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics operationId: stopSpeedTest parameters: - name: sessionId in: path description: sessionId required: true schema: type: object properties: uuid: type: string description: This is valid uuid $$ref: '#/components/schemas/Uuid' examples: sessionId: description: sessionId value: 5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string example: success description: This is valid speedTestStatusResponse $$ref: '#/components/schemas/SpeedTestStatusResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/speed/{deviceUUID}/{sessionId}: post: tags: - Troubleshooting Tools - Diagnostics operationId: saveSpeedTestResults parameters: - name: deviceUUID in: path required: true schema: type: string - name: sessionId in: path description: sessionId required: true schema: type: object properties: uuid: type: string description: This is valid uuid $$ref: '#/components/schemas/Uuid' examples: sessionId: description: sessionId value: 5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d requestBody: description: SpeedTestResult content: application/json: schema: type: object properties: down-speed: type: number format: double example: 9 error: type: string example: NA location: type: string example: NA server: type: string example: NA status: type: string example: NA up-speed: type: number format: double example: 9 description: This is valid SpeedTestResult $$ref: '#/components/schemas/SpeedTestResult' required: true responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string example: success description: This is valid speedTestStatusResponse $$ref: '#/components/schemas/SpeedTestStatusResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: vmanage-http-stream /stream/device/speed/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics operationId: getSpeedTest parameters: - name: sessionId in: path description: sessionId required: true schema: type: object properties: uuid: type: string description: This is valid uuid $$ref: '#/components/schemas/Uuid' examples: sessionId: description: sessionId value: 5be3ee01-e7fb-4d4f-81b4-35dc14f4f50d - name: logId in: query schema: type: integer format: int64 default: 0 responses: '200': description: Success content: application/json: schema: type: object properties: data: type: object properties: destination_circuit: type: string example: lte destination_ip: type: string example: 172.16.255.21 destination_local_ip: type: string example: 172.16.255.21 device_uuid: type: string example: C8K-63eadff3-fa6d-4779-add0-d712a36c6f73 down_bw: type: string example: NA down_speed: type: integer format: int64 example: 0 entry_time: type: integer format: int64 example: 1692757301266 error: type: string example: None logid: type: integer format: int64 example: 0 port: type: string example: '80' session_id: type: string example: de26406d-21f2-4d3d-bc82-6f36553c45bf source_circuit: type: string example: lte source_ip: type: string example: 172.16.255.15 source_local_ip: type: string example: 172.16.255.15 status: type: string example: progress tenant: type: string example: default up_bw: type: string example: NA up_speed: type: integer format: int64 example: 0 description: This is valid speedTestData $$ref: '#/components/schemas/SpeedTestData' description: This is valid speedTestResultResponse $$ref: '#/components/schemas/SpeedTestResultResponse' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/device/status/{deviceUUID}: post: tags: - Troubleshooting Tools - Diagnostics description: Get device status stream operationId: processDeviceStatus parameters: - name: deviceUUID in: path description: Device uuid required: true schema: type: string requestBody: content: application/json: schema: type: string required: true responses: default: description: default response content: '*/*': {} x-roles-required: vmanage-http-stream /stream/dmlog: post: tags: - Troubleshooting Tools - Diagnostics description: Create DMLog session operationId: enableDMLog requestBody: description: DMLog Parameters content: application/json: schema: type: object properties: deviceUUID: type: string example: C8K-942126aa-964b-4f49-bb37-45fede1a8f45 enableRotation: type: boolean example: false enableTimer: type: boolean example: true interfaceName: type: string example: GigabitEthernet5 modem: type: boolean example: true stopTime: type: string example: '12:34' vpn: type: string example: '0' $$ref: '#/components/schemas/CreateDMLogReq' required: true responses: '200': description: Success content: application/json: schema: type: object properties: '@rid': type: integer format: int32 example: 3765 JSessionId: type: string example: 2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac isNewSession: type: boolean example: true isOwner: type: boolean example: true renewalTime: type: integer format: int64 example: 1695089425303 requestStatus: type: string enum: - START - STOP - IN_PROGRESS - NOT_STARTED sessionId: type: string format: uuid example: a9fd18d5-0303-43d1-b821-2358992e0274 startTime: type: integer format: int64 example: 1695089425303 status: type: string example: success enum: - success - failure statusMessage: type: string example: ok type: type: string example: pcap user: type: string example: admin userIp: type: string example: 10.0.1.1 uuid: type: string example: C8K-86adc384-8408-4cec-acdb-8117c40a8a24 $$ref: '#/components/schemas/DmlogInfo' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /stream/dmlog/client/uploadFF/{sessionId}: post: tags: - Troubleshooting Tools - Diagnostics description: upload filter file operationId: clientUploadFilterFile parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string example: success $$ref: '#/components/schemas/FormDMLogRes' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error x-roles-required: Tools-read /stream/dmlog/disable/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics description: Disable dmlog session operationId: disableDMLogSession parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: status: type: string example: success $$ref: '#/components/schemas/ForceStopDMLogRes' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /stream/dmlog/download/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics description: Download dmlog file operationId: downloadDMLog parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/octet-stream: schema: type: string format: binary '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /stream/dmlog/start/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics description: Start dmlog session operationId: startDMLogSession parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: '@rid': type: integer format: int32 example: 3765 JSessionId: type: string example: 2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac isNewSession: type: boolean example: true isOwner: type: boolean example: true renewalTime: type: integer format: int64 example: 1695089425303 requestStatus: type: string enum: - START - STOP - IN_PROGRESS - NOT_STARTED sessionId: type: string format: uuid example: a9fd18d5-0303-43d1-b821-2358992e0274 startTime: type: integer format: int64 example: 1695089425303 status: type: string example: success enum: - success - failure statusMessage: type: string example: ok type: type: string example: pcap user: type: string example: admin userIp: type: string example: 10.0.1.1 uuid: type: string example: C8K-86adc384-8408-4cec-acdb-8117c40a8a24 $$ref: '#/components/schemas/DmlogInfo' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /stream/dmlog/status/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics description: Get dmlog session status operationId: getDMLogStatus parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: fileDownloadStatus: type: string example: NOT_STARTED enum: - NOT_STARTED - STARTED - IN_PROGRESS - COMPLETED - ERROR sessionStatus: type: string enum: - START - STOP - IN_PROGRESS - NOT_STARTED $$ref: '#/components/schemas/GetDMLogStatusRes' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /stream/dmlog/stop/{sessionId}: get: tags: - Troubleshooting Tools - Diagnostics description: Stop DMLog session operationId: stopDMLogSession parameters: - name: sessionId in: path required: true schema: type: string format: uuid responses: '200': description: Success content: application/json: schema: type: object properties: '@rid': type: integer format: int32 example: 3765 JSessionId: type: string example: 2j1QnIq4iFxEjwoxHfYK_zefKjpB7c3fFl483jac isNewSession: type: boolean example: true isOwner: type: boolean example: true renewalTime: type: integer format: int64 example: 1695089425303 requestStatus: type: string enum: - START - STOP - IN_PROGRESS - NOT_STARTED sessionId: type: string format: uuid example: a9fd18d5-0303-43d1-b821-2358992e0274 startTime: type: integer format: int64 example: 1695089425303 status: type: string example: success enum: - success - failure statusMessage: type: string example: ok type: type: string example: pcap user: type: string example: admin userIp: type: string example: 10.0.1.1 uuid: type: string example: C8K-86adc384-8408-4cec-acdb-8117c40a8a24 $$ref: '#/components/schemas/DmlogInfo' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error