openapi: 3.2.0 info: title: SD-WAN Services Data Collection Agent API description: Includes API operations for managing SD-WAN services such as Cloud OnRamp for SaaS and MultiCloud 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: Data Collection Agent paths: /dca/analytics: put: tags: - Data Collection Agent description: Update collection time of DCARest stat for vAnalytics operationId: createStats requestBody: description: Stats query content: application/json: schema: type: object examples: Stats query: description: Stats query value: - tenantId: 15d42ac9-94d2-4c2b-bad1-4b7d5259ce84 stats: - statisticsName: status collectionTime: 1717158934 - statisticsName: device collectionTime: 1717158934 $$ref: '#/components/examples/ComViptelaVmanageServerDcaRequestExampleDcaAnalytics' required: true responses: '202': description: Accepted content: application/json: schema: type: object examples: Stats data: description: Stats data value: {} '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/analytics/all: post: tags: - Data Collection Agent description: Get all statistics setting data operationId: getAllStatsDataDCA requestBody: description: Stats setting content: application/json: schema: type: object examples: Stats query: description: Stats query value: tenantId: - 15d42ac9-94d2-4c2b-bad1-4b7d5259ce84 - 84706b7c-6a71-4423-a55f-9bc069139e87 $$ref: '#/components/examples/ComViptelaVmanageServerDcaRequestExampleDcaAnalyticsAll' required: true responses: '200': description: Success content: application/json: schema: type: object examples: Stats index status: description: Stats index status value: - statisticsName: status tenantId: 15d42ac9-94d2-4c2b-bad1-4b7d5259ce84 collectionTime: 1717155340 '@rid': 4660 - statisticsName: device tenantId: 15d42ac9-94d2-4c2b-bad1-4b7d5259ce84 collectionTime: 1717157134 '@rid': 4661 - statisticsName: status tenantId: 84706b7c-6a71-4423-a55f-9bc069139e87 collectionTime: 1717157437 '@rid': 4662 - statisticsName: device tenantId: 84706b7c-6a71-4423-a55f-9bc069139e87 collectionTime: 1717155334 '@rid': 4696 $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleDcaAnalyticsAll' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/cloudservices/accesstoken: get: tags: - Data Collection Agent description: Get DCA access token operationId: getAccessToken responses: '200': description: Success content: application/json: schema: type: object examples: DCA access token: description: DCA access token value: token: token text exp: 1717313731 sp_org_name: my sp org name cloud: AWS region: Americas vmonitor_url: vmonitor.sdwan.cisco.com dcs_url: analytics.sdwan.cisco.com iss: urn:dms iat: 1717140931 aud: urn:vanalytics $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleAccessToken' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error post: tags: - Data Collection Agent description: Set DCA access token operationId: storeAccessToken requestBody: description: DCA access token content: application/json: schema: type: object examples: DCA access token: description: DCA access token value: token: token data exp: 1717331845 sp_org_name: my org name cloud: AWS region: Americas vmonitor_url: sdwan.cisco.com dcs_url: sdwan.cisco.com iss: urn:dms iat: 1717159044 aud: urn:vanalytics $$ref: '#/components/examples/ComViptelaVmanageServerDcaRequestExampleAccessToken' required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/cloudservices/alarm: post: tags: - Data Collection Agent description: Generate DCA alarms operationId: generateAlarm requestBody: description: DCA alarm message content: application/json: schema: type: object examples: DCA alarm message: description: DCA alarm message value: type: otp_expired message: Cloud service OTP expired required: true responses: '202': description: Accepted '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/cloudservices/idtoken: get: tags: - Data Collection Agent description: Get DCA Id token operationId: getIdToken responses: '200': description: Success content: application/json: schema: type: object examples: DCA Id token: description: DCA Id token value: token: token text exp: 1717313731 sp_org_name: my sp org name cloud: AWS region: Americas vmonitor_url: vmonitor.sdwan.cisco.com dcs_url: analytics.sdwan.cisco.com iss: urn:dms iat: 1717140931 aud: urn:vanalytics $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleIdToken' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error post: tags: - Data Collection Agent description: Set DCA Id token operationId: storeIdToken requestBody: description: DCA Id token content: application/json: schema: type: object examples: DCA Id token: description: DCA Id token value: token: token data sp_org_name: VMANAGE cloud: AWS region: Americas vmonitor_url: sdwan.cisco.com dcs_url: sdwan.cisco.com exp: 1717180644 iss: urn:dms iat: 1717159044 aud: urn:vanalytics $$ref: '#/components/examples/ComViptelaVmanageServerDcaRequestExampleIdToken' required: true responses: '200': description: Success '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/cloudservices/telemetry: get: tags: - Data Collection Agent description: Get DCA telemetry settings operationId: getTelemetrySettings responses: '200': description: Success content: application/json: schema: type: object examples: DCA telemetry settings: description: DCA telemetry settings value: - tenantId: default optIn: 'true' geography: north-america feature_name: webex-group cloudTenantId: 443d24ba-149b-4dfe-a0eb-9a4e32d525a0 org_name: my org name $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleAppTelemetry' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/data/device/state/{state_data_type}: post: tags: - Data Collection Agent description: Get device state data operationId: generateDCADeviceStateData parameters: - name: state_data_type in: path description: Device state data required: true schema: type: string requestBody: description: Query string content: application/json: schema: type: object examples: Query string: description: Query string value: tenantId: - 84706b7c-6a71-4423-a55f-9bc069139e87 count: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerDcaRequestExampleDeviceDataState' required: true responses: '200': description: Success content: application/json: schema: type: object examples: Device state: description: Device state value: header: generatedOn: 1717159047358 viewKeys: uniqueKey: - vdevice-dataKey preferenceKey: grid-ControlWanInterface columns: - title: Instance property: instance width: 100 dataType: number - title: Index property: index width: 100 dataType: number - title: Interface property: interface width: 120 dataType: string - title: Public IP property: public-ip width: 100 dataType: ip - title: Public Port property: public-port width: 100 dataType: number - title: Private IP property: private-ip width: 100 dataType: ip - title: Private Port property: private-port width: 100 dataType: number - title: Num vSmarts property: num-vsmarts width: 150 dataType: number - title: Num vManages property: num-vmanages width: 150 dataType: number - title: Weight property: weight width: 100 dataType: number - title: Color property: color width: 100 dataType: string - title: Carrier property: carrier width: 100 dataType: string - title: Preference property: preference width: 100 dataType: string - title: Max Controllers property: per-wan-max-controllers width: 100 dataType: number - title: Admin State property: admin-state width: 100 dataType: string - title: Operation State property: operation-state width: 150 dataType: string - title: Last Connection property: last-conn-time-date displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time width: 150 dataType: date - title: Restrict property: restrict-str width: 50 dataType: string - title: Control Conn Rqd property: control-str width: 50 dataType: string - title: Vbond As Stun Server property: vbond-as-stun-server width: 150 dataType: string - title: vManage Preference property: vmanage-connection-preference width: 150 dataType: string - title: Private IPv6 property: private-ipv6 width: 150 dataType: string - title: SPI Time Remaining property: spi-change width: 150 dataType: string - title: Last Resort Interface property: last-resort width: 150 dataType: string - title: Interface Changed Port property: wan-port-hopped width: 150 dataType: string - title: Time Since Last Port Hop property: wan-time-since-port-hop width: 150 dataType: string - title: Low Bandwidth Interface property: low-bandwidth-link width: 150 dataType: string - title: NAT Type property: nat-type width: 150 dataType: string - title: Region ID property: region-id width: 100 dataType: string - title: Bind Interface property: bind-interface width: 100 dataType: string - title: Last Updated property: lastupdated displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time hideable: false minWidth: 220 dataType: date fields: - property: vdevice-name dataType: string - property: vdevice-host-name dataType: string - property: instance dataType: number - property: index dataType: number - property: interface dataType: string - property: public-ip dataType: ip - property: public-port dataType: number - property: private-ip dataType: ip - property: private-port dataType: number - property: num-vsmarts dataType: number - property: num-vmanages dataType: number - property: weight dataType: number - property: color dataType: string - property: carrier dataType: string - property: preference dataType: string - property: per-wan-max-controllers dataType: number - property: admin-state dataType: string - property: operation-state dataType: string - property: last-conn-time dataType: uptime - property: last-conn-time-date dataType: date - property: restrict-str dataType: string - property: control-str dataType: string - property: vbond-as-stun-server dataType: string - property: vmanage-connection-preference dataType: string - property: private-ipv6 dataType: string - property: spi-change dataType: string - property: last-resort dataType: string - property: wan-port-hopped dataType: string - property: wan-time-since-port-hop dataType: string - property: low-bandwidth-link dataType: string - property: nat-type dataType: string - property: region-id dataType: string - property: bind-interface dataType: string - property: service-provider dataType: string - property: bandwidth-upstream dataType: number - property: bandwidth-downstream dataType: number - property: createTimeStamp dataType: date - property: lastupdated dataType: date chart: {} data: - recordId: 0:ControlWanInterfaceNode:1717138766789:7619 instance: 0 low-bandwidth-link: 'No' vdevice-name: 172.16.254.1 color: 3g nat-type: E admin-state: up interface: ge0/1 restrict-str: 'no' '@rid': 11469 private-ipv6: '::' private-ip: 10.101.2.2 per-wan-max-controllers: 2 num-vsmarts: 2 num-vmanages: 0 preference: '0' createTimeStamp: 1717138766789 weight: 1 index: 0 private-port: 12366 vdevice-host-name: vm2 vbond-as-stun-server: 'no' control-str: 'yes' carrier: default last-resort: 'No' vdevice-dataKey: 172.16.254.1-0-0 vmanage-connection-preference: '5' vmanage-system-ip: 169.254.10.9 operation-state: up public-ip: 10.101.2.2 tenantId: 84706b7c-6a71-4423-a55f-9bc069139e87 public-port: 12366 region-id: Default lastupdated: 1717138787774 wan-port-hopped: 'TRUE' pageInfo: startId: '11469' endId: '11469' moreEntries: false count: 1 $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleDeviceDataState' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/data/device/statistics/{stats_data_type}: post: tags: - Data Collection Agent description: Get device statistics data operationId: generateDCADeviceStatisticsData parameters: - name: stats_data_type in: path description: Device statistics data required: true schema: type: string requestBody: description: Query string content: application/json: schema: type: object examples: Query string: description: Query string value: tenantId: - 15d42ac9-94d2-4c2b-bad1-4b7d5259ce84 - 26cef033-8569-402e-8742-dcab44fb82e3 - 84706b7c-6a71-4423-a55f-9bc069139e87 startDate: '2024-05-31T12:20:37' endDate: '2024-05-31T12:25:37' timeZone: UTC count: 10000 $$ref: '#/components/examples/ComViptelaVmanageServerDcaRequestExampleDataDeviceStatistics' required: true responses: '200': description: Success content: application/json: schema: type: object examples: Device statistics: description: Device statistics value: header: generatedOn: 1717159053944 viewKeys: uniqueKey: [] preferenceKey: grid-raw_auditlog columns: - title: Entry_time property: entry_time displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time dataType: date - title: Log id property: logid dataType: string - title: Log module property: logmodule dataType: string fields: - property: entry_time dataType: date - property: logid dataType: string - property: logmodule dataType: string chart: {} data: [] pageInfo: hasMoreData: false count: 0 totalCount: 0 $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleDataDeviceStatistics' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/dcatenantowners: get: tags: - Data Collection Agent description: Get DCA tenant owners operationId: getDCATenantOwners responses: '200': description: Success content: application/json: schema: type: object examples: DCA service owner: description: DCA service owner value: 2755bda8-49e7-4069-8a8f-47973a6db193: - 7c72845a-6808-4a75-ad00-96d6c1741d42 342466c6-d0ed-49a8-96bf-1ad66e78dfcb: - 2f38520a-ddc2-47cd-911d-5c83f2af2fd5 - 9e5ca1f3-e313-4ac1-870a-fc20e57ea460 - 99f164ee-72df-47c5-92b5-bc2ab9f22b02 - f8eb289f-81b3-4a4d-86eb-bdd0a37f928f e3b38ba2-5f4d-492b-a624-e048028111c5: - f6c58a1d-67f6-4c76-9006-c367c37eeb0b - 30f18e33-8a12-4c17-882f-a57fd558027b $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleDcaTenantOwners' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/device: post: tags: - Data Collection Agent description: Get all devices operationId: listAllDevicesDCA requestBody: description: Query string content: application/json: schema: type: object examples: Query string: description: Query string value: tenantId: - 57501bad-32a7-4f52-8f54-8547dcd7403e - 07917db1-bb13-40a0-a075-f81e91cd3bd4 required: true responses: '200': description: Success content: application/json: schema: type: array items: type: object examples: Device lists: description: Device lists value: header: generatedOn: 1717672137403 viewKeys: uniqueKey: - system-ip preferenceKey: grid-DeviceMultitenant columns: - title: System IP property: local-system-ip width: 110 dataType: ipv4 - title: Site ID property: site-id width: 70 dataType: numberStr - title: Device Model property: device-model display: multiColumns width: 100 dataType: deviceModel - title: Version property: version width: 150 dataType: string - title: Up Since property: uptime-date displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time width: 200 dataType: date - title: Chassis Number/ID property: uuid width: 220 dataType: string - title: Connected Manager property: connectedVManages visible: true width: 500 dataType: array fields: - property: local-system-ip dataType: ipv4 - property: site-id dataType: numberStr - property: device-model dataType: deviceModel display: multiColumns - property: version dataType: string - property: uptime-date dataType: date - property: uuid dataType: string - property: connectedVManages dataType: array data: - uuid: e730d2b0-20ab-4875-81ac-4994e1386f9e device-model: vmanage version: 20.15.0-89 connectedVManages: - 169.254.10.1 site-id: '200' uptime-date: 1717477260000 local-system-ip: 172.16.255.200 tenantId: 57501bad-32a7-4f52-8f54-8547dcd7403e - uuid: 059e6962-a06e-4e03-93ca-1e32a1f65bab device-model: vsmart version: 20.15.0-47 connectedVManages: - 169.254.10.1 site-id: '129' uptime-date: 1717476420000 local-system-ip: 172.16.253.129 tenantId: 57501bad-32a7-4f52-8f54-8547dcd7403e - uuid: b368ff1a-640c-4440-8f4d-1380ef86d4e6 version: 20.15.0-47 connectedVManages: - 169.254.10.1 uptime-date: 1717476360000 local-system-ip: 172.16.255.128 tenantId: 57501bad-32a7-4f52-8f54-8547dcd7403e - uuid: 03bbab85-fa08-490b-bb1b-e787999c0e10 device-model: vedge-cloud version: 20.9.5-789 connectedVManages: - 169.254.10.1 site-id: '3' uptime-date: 1717475880000 local-system-ip: 172.16.254.2 tenantId: 07917db1-bb13-40a0-a075-f81e91cd3bd4 $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleDevice' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/device/crashlog/details: post: tags: - Data Collection Agent description: Get crash log operationId: getCrashLogs requestBody: description: Query string content: application/json: schema: type: object examples: Stats query: description: Stats query value: tenantId: - 07917db1-bb13-40a0-a075-f81e91cd3bd4 - 57501bad-32a7-4f52-8f54-8547dcd7403e required: true responses: '200': description: Success content: application/json: schema: type: object examples: Crash logs: description: Crash logs value: header: generatedOn: 1717660655976 viewKeys: uniqueKey: - vdevice-dataKey preferenceKey: grid-CrashLog columns: - title: Hostname property: vdevice-host-name hideable: false dataType: string - title: System IP property: vdevice-name hideable: false minWidth: 120 dataType: string - title: Index property: index hideable: false width: 100 dataType: number - title: Core Time property: core-time-date displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time hideable: false width: 200 dataType: date - title: Core Filename property: core-filename hideable: false width: 220 dataType: string fields: - property: vdevice-host-name dataType: string - property: vdevice-name dataType: string - property: index dataType: number - property: core-time dataType: datePrettyWithMixedTZ - property: core-time-date dataType: date - property: core-filename dataType: string - property: lastupdated dataType: date data: - vdevice-name: 172.16.254.3 createTimeStamp: 1717658754622 index: 0 core-filename: core.vdaemon.vm4.gz vdevice-host-name: vm4 core-time: Thu Jun 6 07:23:17 UTC 2024 vdevice-dataKey: 172.16.254.3-0 '@rid': 15894 vmanage-system-ip: 169.254.10.11 tenantId: 07917db1-bb13-40a0-a075-f81e91cd3bd4 lastupdated: 1717658754575 core-time-date: 1717658597000 $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleCrashlogDetails' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/device/crashlog/synced: get: tags: - Data Collection Agent description: Get device crash log operationId: getCrashLogsSynced parameters: - name: deviceId in: query description: Device Id required: true schema: type: string responses: '200': description: Success content: application/json: schema: type: object examples: Crash logs: description: Crash logs value: header: generatedOn: 1717659767636 viewKeys: uniqueKey: - vdevice-dataKey preferenceKey: grid-CrashLog columns: - title: Hostname property: vdevice-host-name hideable: false dataType: string - title: System IP property: vdevice-name hideable: false minWidth: 120 dataType: string - title: Index property: index hideable: false width: 100 dataType: number - title: Core Time property: core-time-date displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time hideable: false width: 200 dataType: date - title: Core Filename property: core-filename hideable: false width: 220 dataType: string fields: - property: vdevice-host-name dataType: string - property: vdevice-name dataType: string - property: index dataType: number - property: core-time dataType: datePrettyWithMixedTZ - property: core-time-date dataType: date - property: core-filename dataType: string - property: lastupdated dataType: date data: - vdevice-name: 172.16.254.14 createTimeStamp: 1717492338526 index: 0 core-filename: core.cfgmgr.vm14.gz vdevice-host-name: vm14 core-time: Tue Jun 4 09:09:50 UTC 2024 vdevice-dataKey: 172.16.254.14-0 '@rid': 12710 vmanage-system-ip: 169.254.10.15 tenantId: 0bb00e4a-10e1-4d8b-a754-d9e6afed547d lastupdated: 1717492338517 core-time-date: 1717492190000 - vdevice-name: 172.16.254.14 createTimeStamp: 1717492338651 index: 1 core-filename: core.vdaemon.vm14.gz vdevice-host-name: vm14 core-time: Tue Jun 4 09:09:35 UTC 2024 vdevice-dataKey: 172.16.254.14-1 '@rid': 12711 vmanage-system-ip: 169.254.10.15 tenantId: 0bb00e4a-10e1-4d8b-a754-d9e6afed547d lastupdated: 1717492338517 core-time-date: 1717492175000 $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleCrashlogSynced' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/settings/configuration/cloudservices/dca: get: tags: - Data Collection Agent description: Get DCA cloud service configuration operationId: getCloudServicesConfigurationDCA responses: '200': description: Success content: application/json: schema: type: object examples: DCA cloud service configuration: description: DCA cloud service configuration value: header: generatedOn: 1717153091638 data: tenants: - vanalyticsEnabled: true eulaAccepted: true vanalyticsEnabledTime: 1717140940 rml: false tenantId: 15d42ac9-94d2-4c2b-bad1-4b7d5259ce84 enabled: true otp: '********' cloudGatewayUrl: datamanagement-us-01.sdwan.cisco.com - vanalyticsEnabled: true eulaAccepted: true vanalyticsEnabledTime: 1717140937 rml: false tenantId: 26cef033-8569-402e-8742-dcab44fb82e3 enabled: true otp: '********' cloudGatewayUrl: datamanagement-us-01.sdwan.cisco.com - vanalyticsEnabled: true eulaAccepted: true vanalyticsEnabledTime: 1717140934 rml: false tenantId: 84706b7c-6a71-4423-a55f-9bc069139e87 enabled: true otp: '********' cloudGatewayUrl: datamanagement-us-01.sdwan.cisco.com $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleDcaCloudservicesSettings' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/settings/configuration/{type}/dca: post: tags: - Data Collection Agent description: Create analytics config data operationId: createDCAAnalyticsDataFile parameters: - name: type in: path description: Data type required: true schema: type: string enum: - analytics - callHome requestBody: description: Query string content: application/json: schema: type: object examples: Query string: description: Query string value: tenantId: - tenant1 - tenant2 required: true responses: '200': description: Success content: application/json: schema: type: object examples: Analytics config data: description: Analytics config data value: header: generatedOn: 1717561371848 data: dcs-region: N/A tenants: [] '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error deprecated: true /dca/statistics/settings/status: post: tags: - Data Collection Agent description: Get statistics setting status operationId: getStatsDBIndexStatus requestBody: description: Stats setting content: application/json: schema: type: object examples: Stats query: description: Stats query value: tenantId: - 15d42ac9-94d2-4c2b-bad1-4b7d5259ce84 - 26cef033-8569-402e-8742-dcab44fb82e3 - 84706b7c-6a71-4423-a55f-9bc069139e87 $$ref: '#/components/examples/ComViptelaVmanageServerDcaRequestExampleStatisticsSettingsStatus' required: true responses: '200': description: Success content: application/json: schema: type: object examples: Stats response: description: Stats response value: - indexName: aggregatedappsdpistatistics status: enable tenantId: 84706b7c-6a71-4423-a55f-9bc069139e87 - indexName: aggregatedappsdpistatistics status: enable tenantId: 26cef033-8569-402e-8742-dcab44fb82e3 - indexName: aggregatedappsdpistatistics status: enable tenantId: 15d42ac9-94d2-4c2b-bad1-4b7d5259ce84 - indexName: aggregatedappsdpisummary status: enable tenantId: 84706b7c-6a71-4423-a55f-9bc069139e87 - indexName: aggregatedappsdpisummary status: enable tenantId: 26cef033-8569-402e-8742-dcab44fb82e3 - indexName: aggregatedappsdpisummary status: enable tenantId: 15d42ac9-94d2-4c2b-bad1-4b7d5259ce84 - indexName: apphostingstatistics status: enable tenantId: 84706b7c-6a71-4423-a55f-9bc069139e87 - indexName: apphostingstatistics status: enable tenantId: 26cef033-8569-402e-8742-dcab44fb82e3 - indexName: apphostingstatistics status: enable tenantId: 15d42ac9-94d2-4c2b-bad1-4b7d5259ce84 - indexName: approutestatsstatistics status: enable tenantId: 84706b7c-6a71-4423-a55f-9bc069139e87 $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleStatisticsSettingsStatus' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/system/device: post: tags: - Data Collection Agent description: Get device details operationId: getDevicesDetailsDCA requestBody: description: Query string content: application/json: schema: type: object examples: Query string: description: Query string value: tenantId: - 07917db1-bb13-40a0-a075-f81e91cd3bd4 required: true responses: '200': description: Success content: application/json: schema: type: object examples: Device details: description: Device details value: header: generatedOn: 1717565961425 viewKeys: uniqueKey: - system-ip preferenceKey: grid-DeviceMultitenant columns: - title: System IP property: local-system-ip width: 110 dataType: ipv4 - title: Site ID property: site-id width: 70 dataType: numberStr - title: Device Model property: device-model display: multiColumns width: 100 dataType: deviceModel - title: Version property: version width: 150 dataType: string - title: Up Since property: uptime-date displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time width: 200 dataType: date - title: Connected Manager property: connectedVManages visible: true width: 500 dataType: array fields: - property: local-system-ip dataType: ipv4 - property: site-id dataType: numberStr - property: device-model dataType: deviceModel display: multiColumns - property: version dataType: string - property: uptime-date dataType: date - property: connectedVManages dataType: array data: - device-model: vedge-cloud version: 20.9.5-789 connectedVManages: - 169.254.10.1 site-id: '2' uptime-date: 1717475880000 local-system-ip: 172.16.254.1 tenantId: 07917db1-bb13-40a0-a075-f81e91cd3bd4 - device-model: vedge-cloud version: 20.9.5-789 connectedVManages: - 169.254.10.1 site-id: '3' uptime-date: 1717475880000 local-system-ip: 172.16.254.2 tenantId: 07917db1-bb13-40a0-a075-f81e91cd3bd4 $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleSystemDevice' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error /dca/template/device/config/attachedconfig: post: tags: - Data Collection Agent description: Get attached config to device operationId: getDCAAttachedConfigToDevice requestBody: description: Query string content: application/json: schema: type: object examples: Query string: description: Query string value: tenantId: - 57501bad-32a7-4f52-8f54-8547dcd7403e - 07917db1-bb13-40a0-a075-f81e91cd3bd4 required: true responses: '200': description: Success content: application/json: schema: type: object examples: Attached config to device: description: Attached config to device value: - deviceConfiguration: "viptela-system:system\nhost-name vm200\nsystem-ip 172.16.255.200\nsite-id 200\nadmin-tech-on-failure\nno vrrp-advt-with-phymac\nsp-organization-name \"MY ORG\"\norganization-name \"MY ORG\"\nvbond vbond\naaa\n auth-order local radius tacacs\n usergroup all\n !\n usergroup basic\n task system read\n task interface read\n !\n usergroup global\n !\n usergroup netadmin\n !\n usergroup network_operations\n task policy read write\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n usergroup security_operations\n task security read write\n !\n usergroup tenantadmin\n !\n user admin\n password $6$681c9c8f17cc6e08$xFwi15faKVz/0.v5C1eeztUMus0iTwyLF.artuRBYD1cc7vTMsNomIVkqdmOcR4fmAGCZFAb6ACtir4oRkE6O0\n !\n ciscotacro-user true\n ciscotacrw-user true\n!\nlogging\n disk\n enable\n !\n!\nssh-server\n cipher aes-128-192\n kex-algo sha1\n!\nntp\n parent\n no enable\n stratum 5\n exit\n!\n!\nsnmp\nno shutdown\nview v2\n oid 1.3.6.1\n!\ncommunity $8$5EAF66F834F9B7194399D513C741AB2A\n view v2\n authorization read-only\n!\ntrap target vpn 0 10.0.1.1 16662\n group-name test\n community-name $8$5EAF66F834F9B7194399D513C741AB2A\n!\ntrap group test\n all\n level critical major minor\n exit\nexit\n!\nvpn 0\ndns 10.0.99.1 secondary\ndns 171.70.168.183 primary\nhost api.cisco.com ip 72.163.8.72\nhost certmanager-webservices.websecurity.digicert.com ip 216.168.246.82\nhost certmanager-webservices.websecurity.symantec.com ip 216.168.246.82\nhost proxy.esl.cisco.com ip 173.36.224.108\nhost vbond ip 10.103.128.128 10.103.135.135\nhost viptela.testbed ip 10.0.1.1\ninterface eth0\n ip address 10.0.1.200/24\n ipv6 dhcp-client\n no shutdown\n!\ninterface eth1\n ip address 10.103.200.200/16\n tunnel-interface\n allow-service all\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service stun\n allow-service https\n !\n no shutdown\n!\ninterface eth2\n ip address 10.0.100.200/24\n no shutdown\n!\ninterface eth3\n ip address 10.104.1.200/24\n no shutdown\n!\ninterface eth4\n ip address 10.105.0.200/24\n no shutdown\n!\nip route 0.0.0.0/0 10.0.12.13\nip route 0.0.0.0/0 10.103.254.254\nip route 46.4.105.116/32 10.0.1.1\nip route 171.70.168.0/24 10.0.1.1\nip route 173.36.224.108/32 10.0.1.1\n!\nvpn 512\n!" deviceIP: 169.254.10.1 tenantId: 57501bad-32a7-4f52-8f54-8547dcd7403e - deviceConfiguration: "viptela-system:system\nsystem-ip 172.16.254.5\ndomain-id 1\nsite-id 6\nadmin-tech-on-failure\nsp-organization-name \"MY ORG\"\norganization-name \"MY ORG-Apple Inc\"\nvbond vbond\n!\nmemory free low-watermark processor 166245\nservice timestamps debug datetime msec\nservice timestamps log datetime msec\nno service tcp-small-servers\nno service udp-small-servers\nplatform console serial\nplatform qfp utilization monitor load 80\nplatform sslvpn use-pd\nhostname vm6\nusername admin privilege 15 secret 9 $9$pPlT8B.3SExgjE$aA9M6arkumX.SK6odu9soQK05qqbXNIeRfBJ7X5vV8Q\nvrf definition 1\nrd 1:1\naddress-family ipv4\n exit-address-family\n!\naddress-family ipv6\n exit-address-family\n!\n!\nvrf definition 11\nrd 11:11\naddress-family ipv4\n exit-address-family\n!\naddress-family ipv6\n exit-address-family\n!\n!\nvrf definition 20\nrd 20:20\naddress-family ipv4\n exit-address-family\n!\naddress-family ipv6\n exit-address-family\n!\n!\nvrf definition Mgmt-intf\nrd 1:512\naddress-family ipv4\n exit-address-family\n!\naddress-family ipv6\n exit-address-family\n!\n!\nno ip finger\nno ip rcmd rcp-enable\nno ip rcmd rsh-enable\nip host vbond 10.103.128.128 10.103.135.135\nip route 0.0.0.0 0.0.0.0 10.101.254.254\nip route 0.0.0.0 0.0.0.0 10.102.254.254\nip scp server enable\nip ssh pubkey-chain\nusername admin\n key-hash ssh-rsa 5cc0b10027d65dd46667acf4464f49f5 vtest@enrtp-vtest-280\n !\n!\n!\nno ip ssh bulk-mode\nip tcp RST-count 10 RST-window 5000\nip http server\nip http secure-server\nip nat settings central-policy\nip nat settings gatekeeper-size 1024\nipv6 unicast-routing\nipv6 rip vrf-mode enable\ninterface GigabitEthernet1\nno shutdown\nvrf forwarding Mgmt-intf\nip address 10.0.1.6 255.255.255.0\nnegotiation auto\nexit\ninterface GigabitEthernet2\nno shutdown\nvrf forwarding 1\nip address 10.0.6.6 255.255.255.0\nnegotiation auto\nexit\ninterface GigabitEthernet3\nno shutdown\nip address 10.101.6.6 255.255.0.0\nnegotiation auto\nexit\ninterface GigabitEthernet4\nno shutdown\nip address 10.0.100.6 255.255.255.0\nnegotiation auto\nexit\ninterface GigabitEthernet5\nno shutdown\nip address 10.102.6.6 255.255.0.0\nnegotiation auto\nexit\ninterface GigabitEthernet6\nno shutdown\nvrf forwarding 20\nip address 10.0.32.6 255.255.255.0\nnegotiation auto\nexit\ninterface GigabitEthernet7\nno shutdown\nvrf forwarding 11\nip address 10.0.33.6 255.255.255.0\nnegotiation auto\nexit\ninterface Tunnel1\nno shutdown\nip unnumbered GigabitEthernet3\ntunnel source GigabitEthernet3\ntunnel mode sdwan\nexit\ninterface Tunnel2\nno shutdown\nip unnumbered GigabitEthernet5\ntunnel source GigabitEthernet5\ntunnel mode sdwan\nexit\ncontrol-plane\n!\nno logging console\nno logging trap\nno logging queue-limit\naaa authentication login default local\naaa authorization console\naaa authorization exec default local\nlogin on-success log\nredundancy\n!\nvtp mode server\nradius-server cache expiry 24\nno crypto ikev2 diagnose error\nsnmp-server community private view v2 ro\nsnmp-server host 10.0.100.1 version 2c private udp-port 16662\nsnmp-server view v2 1.3.6.1 included\nfhrp version vrrp v3\nline aux 0\n!\nline con 0\nstopbits 1\n!\nline vty 0 4\ntransport input ssh\n!\nline vty 5 80\ntransport input none\n!\nno process cpu extended history\nsdwan\ninterface GigabitEthernet2\nexit\ninterface GigabitEthernet3\n tunnel-interface\n encapsulation ipsec\n color 3g\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n no allow-service snmp\n no allow-service bfd\n exit\nexit\ninterface GigabitEthernet4\nexit\ninterface GigabitEthernet5\n tunnel-interface\n encapsulation ipsec\n color lte\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n no allow-service snmp\n no allow-service bfd\n exit\nexit\ninterface GigabitEthernet6\nexit\ninterface GigabitEthernet7\nexit\nappqoe\n no tcpopt enable\n no dreopt enable\n no httpopt enable\n!\nomp\n no shutdown\n graceful-restart\n no as-dot-notation\n timers\n graceful-restart-timer 120\n exit\n address-family ipv4\n advertise connected\n advertise static\n !\n address-family ipv6\n advertise connected\n advertise static\n !\n!\n!\nsslproxy\nno enable\nrsa-key-modulus 2048\ncertificate-lifetime 730\neckey-type P256\nca-tp-label PROXY-SIGNING-CA\nsettings expired-certificate drop\nsettings untrusted-certificate drop\nsettings unknown-status drop\nsettings certificate-revocation-check none\nsettings unsupported-protocol-versions drop\nsettings unsupported-cipher-suites drop\nsettings failure-mode close\nsettings minimum-tls-ver TLSv1\ndual-side optimization enable\n!" deviceIP: 169.254.10.13 tenantId: 07917db1-bb13-40a0-a075-f81e91cd3bd4 $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleAttachedConfig' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error deprecated: true /dca/template/policy/definition/approute: post: tags: - Data Collection Agent description: Get template policy definitions operationId: getTemplatePolicyDefinitionsDCA requestBody: description: Query string content: application/json: schema: type: object examples: Query string: description: Query string value: tenantId: - 07917db1-bb13-40a0-a075-f81e91cd3bd4 required: true responses: '200': description: Success content: application/json: schema: type: array items: type: object examples: Template policy definition: description: Template policy definition value: header: generatedOn: 1717667065133 viewKeys: uniqueKey: [] preferenceKey: grid-PolicyDefinition columns: - title: Name property: name hideable: false dataType: string - title: Type property: type display: keyvalue keyvalueProperty: type hideable: false keyvalue: - key: data value: Data - key: appRoute value: App Route - key: control value: Custom Control - key: cflowd value: Cflowd - key: mesh value: Mesh - key: hubAndSpoke value: Hub and Spoke - key: vpnMembershipGroup value: VPN Membership - key: qosMap value: QoS Map - key: vpnQosMap value: VPN QoS Map - key: rewriteRule value: Rewrite Rule - key: acl value: Access Control List(IPv4) - key: aclv6 value: Access Control List(IPv6) - key: deviceAccessPolicy value: Device Access Control List(IPv4) - key: deviceAccessPolicyv6 value: Device Access Control List(IPv6) - key: vedgeRoute value: Route - key: zoneBasedFW value: Zone Based - key: fxoPort value: FXO - key: fxsPort value: FXS - key: fxsDidPort value: FXS DID - key: dialPeer value: Dial Peer - key: srstPhoneProfile value: SRST Phone - key: priIsdnPort value: PRI ISDN dataType: string - title: Description property: description dataType: string - title: Mode property: mode dataType: string - title: Reference Count property: referenceCount hideable: true dataType: string - title: Updated By property: owner dataType: string - title: Last Updated property: lastUpdated displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time dataType: date fields: - property: name dataType: string - property: type dataType: string display: keyvalue - property: description dataType: string - property: mode dataType: string - property: id dataType: string - property: defaultAction dataType: object - property: sequences dataType: array - property: referenceCount dataType: string - property: owner dataType: string - property: lastUpdated dataType: date data: - name: my_aar_policy definitionId: 3e3edb25-5002-4b3c-b889-33c70e60da87 type: appRoute description: my_aar_policy owner: admin lastUpdated: 1717666867890 infoTag: '' mode: '' optimized: 'false' referenceCount: 0 references: [] $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExamplePolicyDefApproute' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error deprecated: true /dca/template/policy/list/vpn: post: tags: - Data Collection Agent description: Get VPN details operationId: getVPNListsDCA requestBody: description: Query string content: application/json: schema: type: object examples: Query string: description: Query string value: tenantId: - 07917db1-bb13-40a0-a075-f81e91cd3bd4 required: true responses: '200': description: Success content: application/json: schema: type: array items: type: object examples: VPN: description: VPN value: header: generatedOn: 1717496151334 viewKeys: uniqueKey: [] preferenceKey: grid-PolicyList columns: - title: Name property: name hideable: false dataType: string - title: Entries property: entries hideable: true dataType: array - title: Internet Protocal property: type hideable: true dataType: string - title: Reference Count property: referenceCount hideable: true dataType: string - title: Updated By property: owner dataType: string - title: Last Updated property: lastUpdated displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time dataType: date fields: - property: name dataType: string - property: type dataType: string - property: description dataType: string - property: listId dataType: string - property: entries dataType: array - property: type dataType: string - property: referenceCount dataType: string - property: owner dataType: string - property: lastUpdated dataType: date data: - listId: 37d48573-ca30-450a-8ec2-8fc7852477a0 name: VPN_100 type: vpn description: Desc Not Required entries: - vpn: '100' lastUpdated: 1717495776426 owner: tenantadmin readOnly: false version: '0' infoTag: '' referenceCount: 0 references: [] $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExamplePolicyVpnList' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error deprecated: true /dca/template/policy/vedge: post: tags: - Data Collection Agent description: Get vEdge template list operationId: getVedgeTemplateListDCA requestBody: description: Query string content: application/json: schema: type: object examples: Query string: description: Query string value: tenantId: - 07917db1-bb13-40a0-a075-f81e91cd3bd4 required: true responses: '200': description: Success content: application/json: schema: type: array items: type: object examples: vEdge template: description: vEdge template value: header: generatedOn: 1717667785825 viewKeys: uniqueKey: [] preferenceKey: grid-VEdgePolicy columns: - title: Name property: policyName hideable: false dataType: string - title: Description property: policyDescription dataType: string - title: Devices Attached property: devicesAttached hideable: false dataType: number - title: Device Templates property: mastersAttached hideable: false dataType: number - title: Updated By property: lastUpdatedBy dataType: string - title: Last Updated property: lastUpdatedOn displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time dataType: date fields: - property: policyName dataType: string - property: policyDescription dataType: string - property: devicesAttached dataType: number - property: mastersAttached dataType: number - property: lastUpdatedBy dataType: string - property: lastUpdatedOn dataType: date data: - mastersAttached: 0 lastUpdatedBy: tenantadmin policyName: Reject_99_101 policyDefinitionEdit: '{"assembly":[{"definitionId":"a325fc61-c9c1-467d-92d4-6c5caa217685","type":"vedgeRoute"}],"settings":{}}' policyDefinition: '{"assembly":[{"definitionId":"a325fc61-c9c1-467d-92d4-6c5caa217685","type":"vedgeRoute"}],"settings":{}}' createdOn: 1717495890136 policyDescription: Reject_99_101 '@rid': 11804 policyId: 2266c613-b2f3-4028-bcbc-0a95311bc787 createdBy: tenantadmin devicesAttached: 0 policyType: feature tenantId: 07917db1-bb13-40a0-a075-f81e91cd3bd4 lastUpdatedOn: 1717495890136 - mastersAttached: 0 lastUpdatedBy: tenantadmin policyName: policy_99_100 policyDefinitionEdit: '{"assembly":[{"definitionId":"6b192cd9-9ebd-4dec-9555-5d7cba993739","type":"deviceaccesspolicy"},{"definitionId":"8923d524-ced5-4ab3-9967-6abbe46fb372","type":"vedgeRoute"}],"settings":{"appVisibility":true,"logFrequency":100}}' policyDefinition: '{"assembly":[{"definitionId":"6b192cd9-9ebd-4dec-9555-5d7cba993739","type":"deviceaccesspolicy"},{"definitionId":"8923d524-ced5-4ab3-9967-6abbe46fb372","type":"vedgeRoute"}],"settings":{"appVisibility":true,"logFrequency":100}}' createdOn: 1717568343247 policyDescription: policy_99_100 '@rid': 11838 policyId: 9ac90533-a873-404c-a735-ebe8e7719b3a createdBy: tenantadmin devicesAttached: 0 policyType: feature tenantId: 07917db1-bb13-40a0-a075-f81e91cd3bd4 lastUpdatedOn: 1717568343247 $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleVedgePolicy' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error deprecated: true /dca/template/policy/vsmart: post: tags: - Data Collection Agent description: Get vSmart template list operationId: getVsmartTemplateListDCA requestBody: description: Query string content: application/json: schema: type: object examples: Query string: description: Query string value: tenantId: - 07917db1-bb13-40a0-a075-f81e91cd3bd4 required: true responses: '200': description: Success content: application/json: schema: type: array items: type: object examples: vSmart template: description: vSmart template value: header: generatedOn: 1717495213603 viewKeys: uniqueKey: [] preferenceKey: grid-VSmartPolicy columns: - title: Name property: policyName hideable: false dataType: string - title: Description property: policyDescription dataType: string - title: Type property: policyType display: keyvalue keyvalueProperty: policyType hideable: false keyvalue: - key: cli value: CLI - key: feature value: UI Policy Builder dataType: string - title: Activated property: isPolicyActivated display: iconAndText iconProperty: isPolicyActivated hideable: false icon: - key: 'true' value: images/policy_active.png - key: 'false' value: images/policy_inactive.png dataType: string - title: Updated By property: lastUpdatedBy dataType: string - title: Policy Version property: policyVersion dataType: string - title: Last Updated property: lastUpdatedOn displayFormat: DD MMM YYYY h:mm:ss A z inputFormat: unix-time dataType: date fields: - property: policyName dataType: string - property: policyDescription dataType: string - property: policyType dataType: string display: keyvalue - property: isPolicyActivated dataType: string display: iconAndText - property: lastUpdatedBy dataType: string - property: policyVersion dataType: string - property: lastUpdatedOn dataType: date data: - policyVersion: 06042024T095611718 lastUpdatedBy: tenantadmin policyCli: "viptela-policy:policy\n control-policy Test\n default-action accept\n !\n lists\n site-list Test\n site-id 100 \n !\n !\n!\napply-policy\n site-list Test\n control-policy Test in\n control-policy Test out\n !\n!" policyName: Test policyXml: "\n\n DCA AUT VMANAGE-Apple Inc\n3cc401fa-aac4-490d-ae58-0e48be929633\nvsmart_policy_config-6bb37b09-b16b-41b0-aacf-06464f7c81d8\n \n \n \n Test\n \n 100\n \n \n \n \n Test\n accept\n \n \n \n \n Test\n \n in\n Test\n \n \n out\n Test\n \n \n \n\n" policyDefinition: '{"assembly":[{"definitionId":"b2fa4139-9c37-4fdf-abd1-0a6c6f9725c9","type":"control","entries":[{"direction":"in","siteLists":["7b66f7a5-4f56-4e24-8034-992296f67d92"]},{"direction":"out","siteLists":["7b66f7a5-4f56-4e24-8034-992296f67d92"]}]}],"regionRoleAssembly":[]}' createdOn: 1717494971718 policyXmlVersion: vsmart_policy_config-6bb37b09-b16b-41b0-aacf-06464f7c81d8 isPolicyActivated: true policyDescription: Test '@rid': 11062 policyId: 3cc401fa-aac4-490d-ae58-0e48be929633 createdBy: tenantadmin policyType: feature tenantId: 07917db1-bb13-40a0-a075-f81e91cd3bd4 lastUpdatedOn: 1717494971718 $$ref: '#/components/examples/ComViptelaVmanageServerDcaResponseExampleVsmartPolicy' '400': description: Bad Request '403': description: Forbidden '500': description: Internal Server Error deprecated: true