openapi: 3.2.0 info: title: Open API Spec for Assurance Fabric Virtual Networks Virtual Network Health Summaries API description: "### OpenAPI specification defined for the purpose of providing visibility into the fabric virtual networks and their health in Catalyst Center\n\nLayer 2 Virtual Networks are only included in health reporting for EVPN protocol deployments. The special Layer 3 VN called ‘INFRA_VN’ is also not included for user access through Assurance virtualNetworkHealthSummaries APIS. Please find INFRA_VN related health metrics under /data/api/v1/fabricSiteHealthSummaries (Ex: attributes ‘pubsubInfraVnGoodHealthPercentage’ and ‘bgpPeerInfraVnScoreGoodHealthPercentage’).\n\nThese APIs provide the latest health data until the given `endTime`. If data is not ready for the provided endTime, the request will fail with error code `400 Bad Request`, and the error message will indicate the recommended endTime to use to retrieve a complete data set. This behavior may occur if the provided endTime=currentTime, since we are not a real time system. When `endTime` is not provided, the API returns the latest data.\n\n\n**Relevant Concepts**\n| Term | Description |\n| -- | -- |\n| `Virtual Network` | A fabric virtual network is a logical network overlay created on top of a physical network fabric. This overlay network allows you to segment your network into isolated, secure, and policy-driven environments for different departments, applications, or security zones. |\n| `Fabric Site` | A fabric site is a logical subdivision of a larger network fabric, containing its own control plane nodes for management, border nodes for routing traffic between sites, and edge nodes that connect devices to the fabric. |\n| `Fabric deployments` | There are 2 types of Fabric deployments, namely 'LISP' and 'EVPN'.| \n| `LISP-based deployments` | LISP based deployments accommodate the following fabric entities: 'Fabric sites', 'Virtual networks (L2/L3)', and 'Transit Networks'. L2 VN health is not applicable for LISP based deployments.|\n| `EVPN-based deployments` | EVPN based deployments support 'Fabric sites' and 'Virtual networks (L2/L3)' currently. Transit networks is not applicable for EVPN based deployments.| \n| `Overall Virtual Network Health` | The health status of the fabric is determined by examining the session status of Virtual Networks. A valid Health score for Virtual Networks ranges from 0-100 and is categorized as follows: Good (80-100), Fair (40-80), Poor (0-40), and No Health (--).|\n| `Fabric Control Plane Health` | Health of the control plane in the virtual network. Health score ranges from 0 to 100.|\n| `VN Services Health` | Health of the virtual network services. Health score ranges from 0 to 100.|\n| `VN Exit Health` | Health of the virtual network at Exit. Health score ranges from 0 to 100.|\n**API Support Documentation**\n\n**Views**\n\nSpecified 'views' can be requested for non-count APIs. Each view corresponds to different sets of data. \n\n'views' an optional parameter which can be passed to get one or more of the specific health data summaries associated with fabric sites.\n\n'views' is also an optional field in the post request bodies.\n\n| View | Response Data |\n| --- | --- |\n| `vnInfo` | id, name, networkProtocol, vlan, vnid, layer, associatedL3Vn, totalEndpoints, totalFabricSites | \n| `overallHealth` | id, name, goodHealthPercentage, goodHealthDeviceCount, totalHealthDeviceCount, poorHealthDeviceCount, fairHealthDeviceCount, noHealthDeviceCount, vnFabricControlPlaneGoodHealthPercentage, vnFabricControlPlaneGoodHealthDeviceCount, vnFabricControlPlaneTotalDeviceCount, vnFabricControlPlanePoorHealthDeviceCount, vnFabricControlPlaneFairHealthDeviceCount, vnFabricControlPlaneNoHealthDeviceCount, vnServicesHealthPercentage, vnServicesTotalDeviceCount, vnServicesGoodHealthDeviceCount,vnServicesPoorHealthDeviceCount, vnServicesFairHealthDeviceCount, vnServicesNoHealthDeviceCount, vnExitHealthPercentage, vnExitTotalDeviceCount, vnExitGoodHealthDeviceCount, vnExitPoorHealthDeviceCount, vnExitFairHealthDeviceCount, vnStatusHealthPercentage, vnStatusTotalDeviceCount, vnStatusGoodHealthDeviceCount, vnStatusPoorHealthDeviceCount, vnStatusFairHealthDeviceCount, vnStatusNoHealthDeviceCount |\n| `vnControlPlaneHealth` | id, name, vnFabricControlPlaneGoodHealthPercentage, vnFabricControlPlaneGoodHealthDeviceCount, vnFabricControlPlaneTotalDeviceCount, vnFabricControlPlanePoorHealthDeviceCount, vnFabricControlPlaneFairHealthDeviceCount, vnFabricControlPlaneNoHealthDeviceCount, pubsubSessionGoodHealthPercentage, pubsubSessionTotalDeviceCount, pubsubSessionGoodHealthDeviceCount,pubsubSessionPoorHealthDeviceCount, pubsubSessionFairHealthDeviceCount, pubsubSessionNoHealthDeviceCount | \n| `vnServicesHealth` | id, name, vnServicesHealthPercentage, vnServicesTotalDeviceCount, vnServicesGoodHealthDeviceCount,vnServicesPoorHealthDeviceCount, vnServicesFairHealthDeviceCount, vnServicesNoHealthDeviceCount, multiCastGoodHealthPercentage, multiCastTotalDeviceCount, multiCastGoodHealthDeviceCount,multiCastPoorHealthDeviceCount, multiCastFairHealthDeviceCount, multiCastNoHealthDeviceCount, internetAvailGoodHealthPercentage, internetAvailTotalDeviceCount, internetAvailGoodHealthDeviceCount,internetAvailPoorHealthDeviceCount, internetAvailFairHealthDeviceCount, internetAvailNoHealthDeviceCount, firewallConnGoodHealthPercentage, firewallConnGoodHealthDeviceCount, firewallConnPoorHealthDeviceCount,firewallConnNoHealthDeviceCount, firewallConnFairHealthDeviceCount, firewallConnTotalDeviceCount |\n| `vnExitHealth` | id, name, vnExitHealthPercentage, vnExitTotalDeviceCount, vnExitGoodHealthDeviceCount, vnExitPoorHealthDeviceCount, vnExitFairHealthDeviceCount,, bgpPeerGoodHealthPercentage, bgpPeerTotalDeviceCount, bgpPeerGoodHealthDeviceCount,bgpPeerPoorHealthDeviceCount ,bgpPeerFairHealthDeviceCount |\n| `vnStatusHealth` | id, name, vnStatusTotalDeviceCount, vnStatusGoodHealthDeviceCount, vnStatusPoorHealthDeviceCount, vnStatusFairHealthDeviceCount, vnExitNoHealthDeviceCount, vniGoodHealthPercentage, vniTotalDeviceCount, vniGoodHealthDeviceCount,vniPoorHealthDeviceCount, vniFairHealthDeviceCount, vniNoHealthDeviceCount |\n\n When this query parameter is not added the default summaries are: \n\n [`vnInfo`, `overallHealth`]\n\n **Examples**:\n\n view=overallHealth (single view requested)\n\n view=vnInfo&view=overallHealth (multiple views requested)\n \n### **Attributes** ###\nSpecified 'attributes' can be requested for non-count APIs. Each attribute requested will be part of the API response.\n\n**Supported Attributes:**\n1.`id`,`name`, `networkProtocol`,`vlan`,`vnid`,`layer`,`associatedL3Vn`,`totalEndpoints`,`totalFabricSites`,`goodHealthPercentage`,`goodHealthDeviceCount`,`totalHealthDeviceCount`,`poorHealthDeviceCount`,`fairHealthDeviceCount`,`noHealthDeviceCount`,`vnFabricControlPlaneGoodHealthPercentage`,`vnFabricControlPlaneGoodHealthDeviceCount`, `vnFabricControlPlaneTotalDeviceCount`, `vnFabricControlPlanePoorHealthDeviceCount`, `vnFabricControlPlaneFairHealthDeviceCount`,`vnFabricControlPlaneNoHealthDeviceCount`, `vnServicesHealthPercentage`, `vnServicesTotalDeviceCount`, `vnServicesGoodHealthDeviceCount`, `vnServicesPoorHealthDeviceCount`, `vnServicesFairHealthDeviceCount`, `vnServicesNoHealthDeviceCount`, `vnExitHealthPercentage` ,`vnExitTotalDeviceCount`, `vnExitGoodHealthDeviceCount`, `vnExitPoorHealthDeviceCount`, `vnExitFairHealthDeviceCount`, `vnExitNoHealthDeviceCount`, `vnStatusHealthPercentage`, `vnStatusTotalDeviceCount`,`vnStatusGoodHealthDeviceCount`, `vnStatusPoorHealthDeviceCount`, `vnStatusFairHealthDeviceCount`, `vnStatusNoHealthDeviceCount`, `pubsubSessionGoodHealthPercentage`,`pubsubSessionTotalDeviceCount`, `pubsubSessionGoodHealthDeviceCount`,`pubsubSessionPoorHealthDeviceCount`, `pubsubSessionFairHealthDeviceCount`, `pubsubSessionNoHealthDeviceCount`, `multiCastGoodHealthPercentage`, `multiCastTotalDeviceCount`, `multiCastGoodHealthDeviceCount`, `multiCastPoorHealthDeviceCount`, `multiCastFairHealthDeviceCount`, `multiCastNoHealthDeviceCount`, `internetAvailGoodHealthPercentage`, `internetAvailTotalDeviceCount`,`internetAvailGoodHealthDeviceCount`, `internetAvailPoorHealthDeviceCount`, `internetAvailFairHealthDeviceCount`, `internetAvailNoHealthDeviceCount`, `bgpPeerGoodHealthPercentage`, `bgpPeerTotalDeviceCount`, `bgpPeerGoodHealthDeviceCount`,`bgpPeerPoorHealthDeviceCount`,`bgpPeerFairHealthDeviceCount`,`bgpPeerNoHealthDeviceCount`,`vniGoodHealthPercentage`,`vniTotalDeviceCount`, `vniGoodHealthDeviceCount`, `vniPoorHealthDeviceCount`,`vniFairHealthDeviceCount`,`vniNoHealthDeviceCount`, `firewallConnGoodHealthPercentage`, `firewallConnGoodHealthDeviceCount`, `firewallConnPoorHealthDeviceCount`,`firewallConnNoHealthDeviceCount`, `firewallConnFairHealthDeviceCount`, `firewallConnTotalDeviceCount`\nIf length of attribute list is too long, when using the query parameter for GET requests, please use `view` param instead.\n\n Examples:\n \n 1. query param:\n \n ?attribute=totalHealthDeviceCount (single attribute requested)\n \n ?attribute=totalHealthDeviceCount&attribute=goodHealthPercentage (multiple attributes requested)\n \n 2. post body:\n \n attributes=[\"totalHealthDeviceCount\",\"goodHealthPercentage\"] " termsOfService: https://www.cisco.com/c/en/us/about/legal/cloud-and-software/end_user_license_agreement.html contact: name: Cisco TAC World Wide url: https://www.cisco.com/c/en/us/support/web/tsd-cisco-worldwide-contacts.html email: tac@cisco.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html version: 3.3.1 x-provenance: method: harvested authored_by: Cisco Catalyst Center harvested_by: API Evangelist harvested_on: '2026-08-19' first_party: true provider_published: true source_host: developer.cisco.com note: 27 Cisco-published OpenAPI 3.0 Assurance documents (185 operations). Ownership confirmed from the tac@cisco.com contact, the Cisco EULA terms-of-service URL and the Cisco Catalyst Center license block carried in each document. x-evidence: - type: source url: https://developer.cisco.com/docs/catalyst-center/ - type: source url: https://developer.cisco.com/dnacenter/ servers: - url: https://developer.cisco.com/data/api/v1 tags: - name: virtualNetworkHealthSummaries paths: /virtualNetworkHealthSummaries: get: tags: - virtualNetworkHealthSummaries summary: Read list of Virtual Networks with their health summary description: 'Get a paginated list of Virtual Networks with health summary. Layer 2 Virtual Networks are only included in health reporting for EVPN protocol deployments. The special Layer 3 VN called ‘INFRA_VN’ is also not included for user access through Assurance virtualNetworkHealthSummaries APIS. Please find INFRA_VN related health metrics under /data/api/v1/fabricSiteHealthSummaries (Ex: attributes ‘pubsubInfraVnGoodHealthPercentage’ and ‘bgpPeerInfraVnScoreGoodHealthPercentage’). This API provides the latest health data until the given `endTime`. If data is not ready for the provided endTime, the request will fail with error code `400 Bad Request`, and the error message will indicate the recommended endTime to use to retrieve a complete data set. This behavior may occur if the provided endTime=currentTime, since we are not a real time system. When `endTime` is not provided, the API returns the latest data.' operationId: readVirtualNetworksSummary parameters: - name: X-CALLER-ID in: header description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request. ' required: false schema: type: string default: unknown example: ui:client360 - name: startTime in: query description: 'Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. ' schema: type: integer format: int64 example: 1705348800000 - name: endTime in: query description: 'End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. ' required: false schema: type: integer format: int64 example: 1705435200000 - name: limit in: query description: Maximum number of records to return schema: maximum: 100 minimum: 1 type: integer default: 100 - name: offset in: query description: Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1. schema: minimum: 1 type: integer default: 1 - name: sortBy in: query description: A field within the response to sort by. schema: type: string - name: order in: query description: The sort order of the field ascending or descending. schema: type: string default: asc enum: - asc - desc - name: siteHierarchy in: query description: 'The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named "Global" (Ex. `Global/AreaName/BuildingName/FloorName`) This field supports wildcard asterisk (`*`) character search support. E.g. `*/San*, */San, /San*` Examples: `?siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested) `?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaName2/BuildingName2/FloorName2` (multiple siteHierarchies requested) ' required: false style: form explode: true schema: type: array items: type: string - name: siteHierarchyId in: query description: 'The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`) This field supports wildcard asterisk (`*`) character search support. E.g. `*uuid*, *uuid, uuid*` Examples: `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2` (multiple siteHierarchyIds requested) ' required: false style: form explode: true schema: type: array items: type: string - name: id in: query description: 'The list of entity Uuids. (Ex."6bef213c-19ca-4170-8375-b694e251101c") Examples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested) id=6bef213c-19ca-4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple entity uuid with ''&'' separator) ' required: false style: form explode: true schema: type: array items: type: string - name: vnLayer in: query description: 'VN Layer information covering Layer 3 or Layer 2 VNs. ' required: false schema: type: string default: L3 enum: - L3 - L2 - name: attribute in: query description: "Supported Attributes:\n[id,name,networkProtocol,vlan,vnid,layer,associatedL3Vn,totalEndpoints,totalFabricSites,goodHealthPercentage,goodHealthDeviceCount,totalHealthDeviceCount,poorHealthDeviceCount,fairHealthDeviceCount,noHealthDeviceCount,vnFabricControlPlaneGoodHealthPercentage,vnFabricControlPlaneGoodHealthDeviceCount, vnFabricControlPlaneTotalDeviceCount, vnFabricControlPlanePoorHealthDeviceCount, vnFabricControlPlaneFairHealthDeviceCount,vnFabricControlPlaneNoHealthDeviceCount, vnServicesHealthPercentage, vnServicesTotalDeviceCount, vnServicesGoodHealthDeviceCount, vnServicesPoorHealthDeviceCount, vnServicesFairHealthDeviceCount, vnServicesNoHealthDeviceCount, vnExitHealthPercentage, vnExitTotalDeviceCount, vnExitGoodHealthDeviceCount, vnExitPoorHealthDeviceCount, vnExitFairHealthDeviceCount, vnExitNoHealthDeviceCount , vnStatusHealthPercentage, vnStatusTotalDeviceCount,vnStatusGoodHealthDeviceCount, vnStatusPoorHealthDeviceCount, vnStatusFairHealthDeviceCount, vnStatusNoHealthDeviceCount, pubsubSessionGoodHealthPercentage, pubsubSessionTotalDeviceCount, pubsubSessionGoodHealthDeviceCount, pubsubSessionPoorHealthDeviceCount, pubsubSessionFairHealthDeviceCount, pubsubSessionNoHealthDeviceCount, multiCastGoodHealthPercentage, multiCastTotalDeviceCount, multiCastGoodHealthDeviceCount, multiCastPoorHealthDeviceCount, multiCastFairHealthDeviceCount, multiCastNoHealthDeviceCount, internetAvailGoodHealthPercentage, internetAvailTotalDeviceCount,internetAvailGoodHealthDeviceCount, internetAvailPoorHealthDeviceCount, internetAvailFairHealthDeviceCount, internetAvailNoHealthDeviceCount, bgpPeerGoodHealthPercentage, bgpPeerTotalDeviceCount, bgpPeerGoodHealthDeviceCount,bgpPeerPoorHealthDeviceCount,bgpPeerFairHealthDeviceCount, bgpPeerNoHealthDeviceCount,vniGoodHealthPercentage,vniTotalDeviceCount, vniGoodHealthDeviceCount, vniPoorHealthDeviceCount,vniFairHealthDeviceCount, vniNoHealthDeviceCount, firewallConnGoodHealthPercentage, firewallConnGoodHealthDeviceCount, firewallConnPoorHealthDeviceCount,firewallConnNoHealthDeviceCount, firewallConnFairHealthDeviceCount, firewallConnTotalDeviceCount]\n\nExamples:\n\nattribute=goodHealthPercentage (single attribute requested)\n\nattribute=goodHealthPercentage&attribute=totalEndpoints (multiple attributes requested) \n" required: false style: form explode: true schema: type: array items: type: string - name: view in: query description: "The specific summary view being requested. This is an optional parameter which can be passed to get one or more of the specific health data summaries associated with virtual networks.\n\n### Response data proviced by each view: \n\n1. **vnInfo**\n[id, name, networkProtocol, vlan, vnid, layer, associatedL3Vn, totalEndpoints, totalFabricSites] \n\n2. **overallHealth**\n[id, name, goodHealthPercentage, goodHealthDeviceCount, totalHealthDeviceCount,poorHealthDeviceCount,fairHealthDeviceCount,noHealthDeviceCount,vnFabricControlPlaneGoodHealthPercentage,vnFabricControlPlaneGoodHealthDeviceCount, vnFabricControlPlaneTotalDeviceCount, vnFabricControlPlanePoorHealthDeviceCount, vnFabricControlPlaneFairHealthDeviceCount,vnFabricControlPlaneNoHealthDeviceCount, vnServicesHealthPercentage, vnServicesTotalDeviceCount, vnServicesGoodHealthDeviceCount, vnServicesPoorHealthDeviceCount, vnServicesFairHealthDeviceCount, vnServicesNoHealthDeviceCount, vnExitHealthPercentage, vnExitTotalDeviceCount, vnExitGoodHealthDeviceCount, vnExitPoorHealthDeviceCount, vnExitFairHealthDeviceCount, vnExitNoHealthDeviceCount, vnStatusHealthPercentage, vnStatusTotalDeviceCount,vnStatusGoodHealthDeviceCount, vnStatusPoorHealthDeviceCount, vnStatusFairHealthDeviceCount, vnStatusNoHealthDeviceCount]\n\n3. **vnControlPlaneHealth**\n[id, name, vnFabricControlPlaneGoodHealthPercentage, vnFabricControlPlaneGoodHealthDeviceCount, vnFabricControlPlaneTotalDeviceCount, vnFabricControlPlanePoorHealthDeviceCount, vnFabricControlPlaneFairHealthDeviceCount, vnFabricControlPlaneNoHealthDeviceCount, pubsubSessionGoodHealthPercentage, pubsubSessionTotalDeviceCount, pubsubSessionGoodHealthDeviceCount,pubsubSessionPoorHealthDeviceCount, pubsubSessionFairHealthDeviceCount, pubsubSessionNoHealthDeviceCount]\n\n4. **vnServicesHealth**\n[id, name, vnServicesHealthPercentage, vnServicesTotalDeviceCount, vnServicesGoodHealthDeviceCount,vnServicesPoorHealthDeviceCount, vnServicesFairHealthDeviceCount, vnServicesNoHealthDeviceCount, multiCastGoodHealthPercentage, multiCastTotalDeviceCount, multiCastGoodHealthDeviceCount,multiCastPoorHealthDeviceCount, multiCastFairHealthDeviceCount, multiCastNoHealthDeviceCount, internetAvailGoodHealthPercentage, internetAvailTotalDeviceCount, internetAvailGoodHealthDeviceCount,internetAvailPoorHealthDeviceCount, internetAvailFairHealthDeviceCount, internetAvailNoHealthDeviceCount,\n firewallConnGoodHealthPercentage, firewallConnGoodHealthDeviceCount, firewallConnPoorHealthDeviceCount,\n firewallConnNoHealthDeviceCount, firewallConnFairHealthDeviceCount, firewallConnTotalDeviceCount]\n\n5. **vnExitHealth**\n[id, name, vnExitHealthPercentage, vnExitTotalDeviceCount, vnExitGoodHealthDeviceCount, vnExitPoorHealthDeviceCount, vnExitFairHealthDeviceCount, vnExitNoHealthDeviceCount, bgpPeerGoodHealthPercentage, bgpPeerTotalDeviceCount, bgpPeerGoodHealthDeviceCount,bgpPeerPoorHealthDeviceCount ,bgpPeerFairHealthDeviceCount, bgpPeerNoHealthDeviceCount]\n\n6.**vnStatusHealth**\n[id, name, vnStatusTotalDeviceCount, vnStatusGoodHealthDeviceCount, vnStatusPoorHealthDeviceCount, vnStatusFairHealthDeviceCount, vnStatusNoHealthDeviceCount, vniGoodHealthPercentage, vniTotalDeviceCount, vniGoodHealthDeviceCount,vniPoorHealthDeviceCount, vniFairHealthDeviceCount, vniNoHealthDeviceCount]\n\nWhen this query parameter is not added the default summaries are: \n\n**[vnInfo, overallHealth]**\n\nExamples:\n\nview=overallHealth (single view requested)\n\nview=vnInfo&view=overallHealth&view=vnServicesHealth (multiple views requested)\n" required: false style: form explode: true schema: maxItems: 3 minItems: 1 type: array items: type: string responses: '200': $ref: '#/components/responses/VirtualNetworksSummariesResponse' '400': $ref: '#/components/responses/400' '500': $ref: '#/components/responses/500' 1XX: $ref: '#/components/responses/1XX' 2XX: $ref: '#/components/responses/2XX' 3XX: $ref: '#/components/responses/3XX' 4XX: $ref: '#/components/responses/4XX' 5XX: $ref: '#/components/responses/5XX' default: $ref: '#/components/responses/defaultError' /virtualNetworkHealthSummaries/{id}: get: tags: - virtualNetworkHealthSummaries summary: Read virtual network with its health summary from id description: 'Get health summary for a specific Virtual Network by providing the unique virtual networks id in the url path. L2 Virtual Networks are only included in health reporting for EVPN protocol deployments. The special Layer 3 VN called ‘INFRA_VN’ is also not included for user access through Assurance virtualNetworkHealthSummaries APIS. Please find INFRA_VN related health metrics under /data/api/v1/fabricSiteHealthSummaries (Ex: attributes ‘pubsubInfraVnGoodHealthPercentage’ and ‘bgpPeerInfraVnScoreGoodHealthPercentage’). This API provides the latest health data until the given `endTime`. If data is not ready for the provided endTime, the request will fail with error code `400 Bad Request`, and the error message will indicate the recommended endTime to use to retrieve a complete data set. This behavior may occur if the provided endTime=currentTime, since we are not a real time system. When `endTime` is not provided, the API returns the latest data.' operationId: virtualNetworkSummaryById parameters: - name: id in: path description: unique virtual networks id required: true schema: type: string - name: X-CALLER-ID in: header description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request. ' required: false schema: type: string default: unknown example: ui:client360 - name: endTime in: query description: 'End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. ' required: false schema: type: integer format: int64 example: 1705435200000 - name: startTime in: query description: 'Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. ' schema: type: integer format: int64 example: 1705348800000 - name: attribute in: query description: "Supported Attributes:\n[id,name,networkProtocol,vlan,vnid,layer,associatedL3Vn,totalEndpoints,totalFabricSites,goodHealthPercentage,goodHealthDeviceCount,totalHealthDeviceCount,poorHealthDeviceCount,fairHealthDeviceCount,noHealthDeviceCount,vnFabricControlPlaneGoodHealthPercentage,vnFabricControlPlaneGoodHealthDeviceCount, vnFabricControlPlaneTotalDeviceCount, vnFabricControlPlanePoorHealthDeviceCount, vnFabricControlPlaneFairHealthDeviceCount,vnFabricControlPlaneNoHealthDeviceCount, vnServicesHealthPercentage, vnServicesTotalDeviceCount, vnServicesGoodHealthDeviceCount, vnServicesPoorHealthDeviceCount, vnServicesFairHealthDeviceCount, vnServicesNoHealthDeviceCount, vnExitHealthPercentage, vnExitTotalDeviceCount, vnExitGoodHealthDeviceCount, vnExitPoorHealthDeviceCount, vnExitFairHealthDeviceCount, vnExitNoHealthDeviceCount , vnStatusHealthPercentage, vnStatusTotalDeviceCount,vnStatusGoodHealthDeviceCount, vnStatusPoorHealthDeviceCount, vnStatusFairHealthDeviceCount, vnStatusNoHealthDeviceCount, pubsubSessionGoodHealthPercentage, pubsubSessionTotalDeviceCount, pubsubSessionGoodHealthDeviceCount, pubsubSessionPoorHealthDeviceCount, pubsubSessionFairHealthDeviceCount, pubsubSessionNoHealthDeviceCount, multiCastGoodHealthPercentage, multiCastTotalDeviceCount, multiCastGoodHealthDeviceCount, multiCastPoorHealthDeviceCount, multiCastFairHealthDeviceCount, multiCastNoHealthDeviceCount, internetAvailGoodHealthPercentage, internetAvailTotalDeviceCount,internetAvailGoodHealthDeviceCount, internetAvailPoorHealthDeviceCount, internetAvailFairHealthDeviceCount, internetAvailNoHealthDeviceCount, bgpPeerGoodHealthPercentage, bgpPeerTotalDeviceCount, bgpPeerGoodHealthDeviceCount,bgpPeerPoorHealthDeviceCount,bgpPeerFairHealthDeviceCount, bgpPeerNoHealthDeviceCount,vniGoodHealthPercentage,vniTotalDeviceCount, vniGoodHealthDeviceCount, vniPoorHealthDeviceCount,vniFairHealthDeviceCount, vniNoHealthDeviceCount, firewallConnGoodHealthPercentage, firewallConnGoodHealthDeviceCount, firewallConnPoorHealthDeviceCount,firewallConnNoHealthDeviceCount, firewallConnFairHealthDeviceCount, firewallConnTotalDeviceCount]\n\nExamples:\n\nattribute=goodHealthPercentage (single attribute requested)\n\nattribute=goodHealthPercentage&attribute=totalEndpoints (multiple attributes requested) \n" required: false style: form explode: true schema: type: array items: type: string - name: view in: query description: "The specific summary view being requested. This is an optional parameter which can be passed to get one or more of the specific health data summaries associated with virtual networks.\n\n### Response data proviced by each view: \n\n1. **vnInfo**\n[id, name, networkProtocol, vlan, vnid, layer, associatedL3Vn, totalEndpoints, totalFabricSites] \n\n2. **overallHealth**\n[id, name, goodHealthPercentage, goodHealthDeviceCount, totalHealthDeviceCount,poorHealthDeviceCount,fairHealthDeviceCount,noHealthDeviceCount,vnFabricControlPlaneGoodHealthPercentage,vnFabricControlPlaneGoodHealthDeviceCount, vnFabricControlPlaneTotalDeviceCount, vnFabricControlPlanePoorHealthDeviceCount, vnFabricControlPlaneFairHealthDeviceCount,vnFabricControlPlaneNoHealthDeviceCount, vnServicesHealthPercentage, vnServicesTotalDeviceCount, vnServicesGoodHealthDeviceCount, vnServicesPoorHealthDeviceCount, vnServicesFairHealthDeviceCount, vnServicesNoHealthDeviceCount, vnExitHealthPercentage, vnExitTotalDeviceCount, vnExitGoodHealthDeviceCount, vnExitPoorHealthDeviceCount, vnExitFairHealthDeviceCount, vnExitNoHealthDeviceCount, vnStatusHealthPercentage, vnStatusTotalDeviceCount,vnStatusGoodHealthDeviceCount, vnStatusPoorHealthDeviceCount, vnStatusFairHealthDeviceCount, vnStatusNoHealthDeviceCount]\n\n3. **vnControlPlaneHealth**\n[id, name, vnFabricControlPlaneGoodHealthPercentage, vnFabricControlPlaneGoodHealthDeviceCount, vnFabricControlPlaneTotalDeviceCount, vnFabricControlPlanePoorHealthDeviceCount, vnFabricControlPlaneFairHealthDeviceCount, vnFabricControlPlaneNoHealthDeviceCount, pubsubSessionGoodHealthPercentage, pubsubSessionTotalDeviceCount, pubsubSessionGoodHealthDeviceCount,pubsubSessionPoorHealthDeviceCount, pubsubSessionFairHealthDeviceCount, pubsubSessionNoHealthDeviceCount]\n\n4. **vnServicesHealth**\n[id, name, vnServicesHealthPercentage, vnServicesTotalDeviceCount, vnServicesGoodHealthDeviceCount,vnServicesPoorHealthDeviceCount, vnServicesFairHealthDeviceCount, vnServicesNoHealthDeviceCount, multiCastGoodHealthPercentage, multiCastTotalDeviceCount, multiCastGoodHealthDeviceCount,multiCastPoorHealthDeviceCount, multiCastFairHealthDeviceCount, multiCastNoHealthDeviceCount, internetAvailGoodHealthPercentage, internetAvailTotalDeviceCount, internetAvailGoodHealthDeviceCount,internetAvailPoorHealthDeviceCount, internetAvailFairHealthDeviceCount, internetAvailNoHealthDeviceCount,\n firewallConnGoodHealthPercentage, firewallConnGoodHealthDeviceCount, firewallConnPoorHealthDeviceCount,\n firewallConnNoHealthDeviceCount, firewallConnFairHealthDeviceCount, firewallConnTotalDeviceCount]\n\n5. **vnExitHealth**\n[id, name, vnExitHealthPercentage, vnExitTotalDeviceCount, vnExitGoodHealthDeviceCount, vnExitPoorHealthDeviceCount, vnExitFairHealthDeviceCount, vnExitNoHealthDeviceCount, bgpPeerGoodHealthPercentage, bgpPeerTotalDeviceCount, bgpPeerGoodHealthDeviceCount,bgpPeerPoorHealthDeviceCount ,bgpPeerFairHealthDeviceCount, bgpPeerNoHealthDeviceCount]\n\n6.**vnStatusHealth**\n[id, name, vnStatusTotalDeviceCount, vnStatusGoodHealthDeviceCount, vnStatusPoorHealthDeviceCount, vnStatusFairHealthDeviceCount, vnStatusNoHealthDeviceCount, vniGoodHealthPercentage, vniTotalDeviceCount, vniGoodHealthDeviceCount,vniPoorHealthDeviceCount, vniFairHealthDeviceCount, vniNoHealthDeviceCount]\n\nWhen this query parameter is not added the default summaries are: \n\n**[vnInfo, overallHealth]**\n\nExamples:\n\nview=overallHealth (single view requested)\n\nview=vnInfo&view=overallHealth&view=vnServicesHealth (multiple views requested)\n" required: false style: form explode: true schema: maxItems: 3 minItems: 1 type: array items: type: string responses: '200': $ref: '#/components/responses/VirtualNetworkSummaryResponse' '400': $ref: '#/components/responses/400' '500': $ref: '#/components/responses/500' 1XX: $ref: '#/components/responses/1XX' 2XX: $ref: '#/components/responses/2XX' 3XX: $ref: '#/components/responses/3XX' 4XX: $ref: '#/components/responses/4XX' 5XX: $ref: '#/components/responses/5XX' default: $ref: '#/components/responses/defaultError' /virtualNetworkHealthSummaries/count: get: tags: - virtualNetworkHealthSummaries summary: Read Virtual Networks count description: "Get a count of virtual networks. Use available query parameters to get the count of a subset of virtual networks. Layer 2 Virtual Networks are only included for EVPN protocol deployments. The special Layer 3 VN called ‘INFRA_VN’ is also not included.\nThis API provides the latest health data until the given `endTime`. If data is not ready for the provided endTime, the request will fail with error code `400 Bad Request`, and the error message will indicate the recommended endTime to use to retrieve a complete data set. This behavior may occur if the provided endTime=currentTime, since we are not a real time system. When `endTime` is not provided, the API returns the latest data.\n " operationId: readVirtualNetworksCount parameters: - name: X-CALLER-ID in: header description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request. ' required: false schema: type: string default: unknown example: ui:client360 - name: startTime in: query description: 'Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. ' schema: type: integer format: int64 example: 1705348800000 - name: endTime in: query description: 'End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. ' required: false schema: type: integer format: int64 example: 1705435200000 - name: siteHierarchy in: query description: 'The full hierarchical breakdown of the site tree starting from Global site name and ending with the specific site name. The Root site is named "Global" (Ex. `Global/AreaName/BuildingName/FloorName`) This field supports wildcard asterisk (`*`) character search support. E.g. `*/San*, */San, /San*` Examples: `?siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested) `?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaName2/BuildingName2/FloorName2` (multiple siteHierarchies requested) ' required: false style: form explode: true schema: type: array items: type: string - name: siteHierarchyId in: query description: 'The full hierarchy breakdown of the site tree in id form starting from Global site UUID and ending with the specific site UUID. (Ex. `globalUuid/areaUuid/buildingUuid/floorUuid`) This field supports wildcard asterisk (`*`) character search support. E.g. `*uuid*, *uuid, uuid*` Examples: `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested) `?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2` (multiple siteHierarchyIds requested) ' required: false style: form explode: true schema: type: array items: type: string - name: id in: query description: 'The list of entity Uuids. (Ex."6bef213c-19ca-4170-8375-b694e251101c") Examples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested) id=6bef213c-19ca-4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple entity uuid with ''&'' separator) ' required: false style: form explode: true schema: type: array items: type: string - name: vnLayer in: query description: 'VN Layer information covering Layer 3 or Layer 2 VNs. ' required: false schema: type: string default: L3 enum: - L3 - L2 responses: '200': description: Successfully returned the requested virtual networks count content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/CountIntegerResponse' '400': $ref: '#/components/responses/400' '500': $ref: '#/components/responses/500' 1XX: $ref: '#/components/responses/1XX' 2XX: $ref: '#/components/responses/2XX' 3XX: $ref: '#/components/responses/3XX' 4XX: $ref: '#/components/responses/4XX' 5XX: $ref: '#/components/responses/5XX' default: $ref: '#/components/responses/defaultError' /virtualNetworkHealthSummaries/{id}/trendAnalytics: get: tags: - virtualNetworkHealthSummaries summary: The Trend analytics data for a virtual network in the specified time range description: "Get health time series for a specific Virtual Network by providing the unique Virtual Network id in the url path. Layer 2 Virtual Networks are only included in health reporting for EVPN protocol deployments. The special Layer 3 VN called ‘INFRA_VN’ is also not included for user access through Assurance virtualNetworkHealthSummaries APIS. \n\nThe data will be grouped based on the specified trend time interval. If startTime and endTime are not provided, the API defaults to the last 24 hours.\n\nBy default:\n- the number of records returned will be 500.\n- the records will be sorted in time ascending (`asc`) order\n\nFor EVPN , {id} is a combination of VN:FabrisiteId. ex: L2VN1:93a25378-7740-4e20-8d90-0060ad9a1be0\n\nThis API provides the latest health data until the given `endTime`. If data is not ready for the provided endTime, the request will fail with error code `400 Bad Request`, and the error message will indicate the recommended endTime to use to retrieve a complete data set. This behavior may occur if the provided endTime=currentTime, since we are not a real time system. When `endTime` is not provided, the API returns the latest data.\n" operationId: readvirtualNetworkTrendById parameters: - name: id in: path description: unique virtual network id required: true schema: type: string format: uuid - name: X-CALLER-ID in: header description: 'Caller ID is used to trace the origin of API calls and their associated queries executed on the database. It''s an optional header parameter that can be added to an API request. ' required: false schema: type: string default: unknown example: ui:client360 - name: startTime in: query description: 'Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. ' schema: type: integer format: int64 example: 1705348800000 - name: endTime in: query description: 'End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive. ' required: false schema: type: integer format: int64 example: 1705435200000 - name: trendInterval in: query description: "The time window to aggregate the metrics. \nInterval can be 5 minutes or 10 minutes or 1 hour or 1 day or 7 days\n" required: true style: form explode: false schema: type: string enum: - 5MIN - 10MIN - 1HR - 1DAY - 7DAY - name: limit in: query description: Maximum number of records to return schema: maximum: 500 minimum: 1 type: integer default: 500 - name: offset in: query description: Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1. schema: minimum: 1 type: integer default: 1 - name: order in: query description: The sort order of the field ascending or descending. schema: type: string default: asc enum: - asc - desc - name: attribute in: query description: "Supported Attributes:\n\n[goodHealthPercentage,goodHealthDeviceCount,totalHealthDeviceCount,poorHealthDeviceCount,fairHealthDeviceCount,noHealthDeviceCount,vnFabricControlPlaneGoodHealthPercentage,vnFabricControlPlaneGoodHealthDeviceCount, vnFabricControlPlaneTotalDeviceCount, vnFabricControlPlanePoorHealthDeviceCount, vnFabricControlPlaneFairHealthDeviceCount,vnFabricControlPlaneNoHealthDeviceCount, vnServicesHealthPercentage, vnServicesTotalDeviceCount, vnServicesGoodHealthDeviceCount, vnServicesPoorHealthDeviceCount, vnServicesFairHealthDeviceCount, vnServicesNoHealthDeviceCount, vnExitHealthPercentage, vnExitTotalDeviceCount, vnExitGoodHealthDeviceCount, vnExitPoorHealthDeviceCount, vnExitFairHealthDeviceCount, vnExitNoHealthDeviceCount , vnStatusHealthPercentage, vnStatusTotalDeviceCount,vnStatusGoodHealthDeviceCount, vnStatusPoorHealthDeviceCount, vnStatusFairHealthDeviceCount, vnStatusNoHealthDeviceCount, pubsubSessionGoodHealthPercentage, pubsubSessionTotalDeviceCount, pubsubSessionGoodHealthDeviceCount, pubsubSessionPoorHealthDeviceCount, pubsubSessionFairHealthDeviceCount, pubsubSessionNoHealthDeviceCount, multiCastGoodHealthPercentage, multiCastTotalDeviceCount, multiCastGoodHealthDeviceCount, multiCastPoorHealthDeviceCount, multiCastFairHealthDeviceCount, multiCastNoHealthDeviceCount, internetAvailGoodHealthPercentage, internetAvailTotalDeviceCount,internetAvailGoodHealthDeviceCount, internetAvailPoorHealthDeviceCount, internetAvailFairHealthDeviceCount, internetAvailNoHealthDeviceCount, bgpPeerGoodHealthPercentage, bgpPeerTotalDeviceCount, bgpPeerGoodHealthDeviceCount,bgpPeerPoorHealthDeviceCount,bgpPeerFairHealthDeviceCount, bgpPeerNoHealthDeviceCount,vniGoodHealthPercentage,vniTotalDeviceCount, vniGoodHealthDeviceCount, vniPoorHealthDeviceCount,vniFairHealthDeviceCount, vniNoHealthDeviceCount, firewallConnGoodHealthPercentage,firewallConnGoodHealthDeviceCount, firewallConnPoorHealthDeviceCount, firewallConnNoHealthDeviceCount,firewallConnFairHealthDeviceCount, firewallConnTotalDeviceCount]\n\nExamples:\n\nattribute=goodHealthPercentage (single attribute requested)\n\nattribute=goodHealthPercentage&attribute=totalFabricSites (multiple attributes requested) \n" required: false style: form explode: true schema: type: array items: type: string responses: '200': $ref: '#/components/responses/VirtualNetworkTrendResponse' '400': $ref: '#/components/responses/400' '500': $ref: '#/components/responses/500' 1XX: $ref: '#/components/responses/1XX' 2XX: $ref: '#/components/responses/2XX' 3XX: $ref: '#/components/responses/3XX' 4XX: $ref: '#/components/responses/4XX' 5XX: $ref: '#/components/responses/5XX' default: $ref: '#/components/responses/defaultError' components: schemas: VirtualNetworkAnalyticsAttribute: type: string description: Supported filter attributes related to clients enum: - goodHealthPercentage - goodHealthDeviceCount - totalHealthDeviceCount - fairHealthDeviceCount - poorHealthDeviceCount - noHealthDeviceCount - vnFabricControlPlaneGoodHealthPercentage - vnFabricControlPlaneGoodHealthDeviceCount - vnFabricControlPlaneTotalDeviceCount - vnFabricControlPlanePoorHealthDeviceCount - vnFabricControlPlaneFairHealthDeviceCount - vnFabricControlPlaneNoHealthDeviceCount - vnServicesHealthPercentage - vnServicesTotalDeviceCount - vnServicesGoodHealthDeviceCount - vnServicesPoorHealthDeviceCount - vnServicesFairHealthDeviceCount - vnServicesNoHealthDeviceCount - vnExitHealthPercentage - vnExitTotalDeviceCount - vnExitGoodHealthDeviceCount - vnExitPoorHealthDeviceCount - vnExitFairHealthDeviceCount - vnExitNoHealthDeviceCount - vnStatusHealthPercentage - vnStatusTotalDeviceCount - vnStatusGoodHealthDeviceCount - vnStatusPoorHealthDeviceCount - vnStatusFairHealthDeviceCount - vnStatusNoHealthDeviceCount - pubsubSessionGoodHealthPercentage - pubsubSessionTotalDeviceCount - pubsubSessionGoodHealthDeviceCount - pubsubSessionPoorHealthDeviceCount - pubsubSessionFairHealthDeviceCount - pubsubSessionNoHealthDeviceCount - multiCastGoodHealthPercentage - multiCastTotalDeviceCount - multiCastGoodHealthDeviceCount - multiCastPoorHealthDeviceCount - multiCastFairHealthDeviceCount - multiCastNoHealthDeviceCount - internetAvailGoodHealthPercentage - internetAvailTotalDeviceCount - internetAvailGoodHealthDeviceCount - internetAvailPoorHealthDeviceCount - internetAvailFairHealthDeviceCount - internetAvailNoHealthDeviceCount - bgpPeerGoodHealthPercentage - bgpPeerTotalDeviceCount - bgpPeerGoodHealthDeviceCount - bgpPeerPoorHealthDeviceCount - bgpPeerFairHealthDeviceCount - bgpPeerNoHealthDeviceCount - vniGoodHealthPercentage - vniTotalDeviceCount - vniGoodHealthDeviceCount - vniPoorHealthDeviceCount - vniFairHealthDeviceCount - vniNoHealthDeviceCount - firewallConnGoodHealthPercentage - firewallConnGoodHealthDeviceCount - firewallConnPoorHealthDeviceCount - firewallConnNoHealthDeviceCount - firewallConnFairHealthDeviceCount - firewallConnTotalDeviceCount virtualNetworkSummaryTrend: type: object properties: response: type: array description: Successfully return list of Virtual networks health trend data items: $ref: '#/components/schemas/VirtualNetworkTrend' page: $ref: '#/components/schemas/TimeBasedPagination' version: type: string example: '1.0' description: Virtual Networks score Response ErrorObject: type: object properties: errorCode: type: integer description: Application specific error code returned by the server message: type: string description: Brief message about the error condition detail: type: string description: A more detailed explanation of the error condition the parameter and its value, that caused the condition and why it caused it. TimeBasedPagination: type: object properties: limit: minimum: 1 type: integer description: Number of records to fetch in a page example: 100 offset: minimum: 1 type: integer description: Starting offset of data to fetch and returned example: 5 default: 1 timeSortOrder: type: string description: Sort order. `asc` for ascending and `desc` for descending example: asc default: asc enum: - asc - desc count: type: integer description: Number of records returned after applying applicable filtering. Field is ignored for request and updated by API in the response example: 100 VirtualNetworkAttributeValuePair: type: object properties: name: $ref: '#/components/schemas/VirtualNetworkAnalyticsAttribute' value: type: object description: This is the value of the attribute requested for analytics API. VirtualNetworksSummaries: type: object properties: response: type: array description: 'Successfully returned list of Virtual Networks ' items: $ref: '#/components/schemas/VirtualNetworkSummary' page: $ref: '#/components/schemas/PaginationResponse' version: type: string description: The version of the response example: '1.0' description: Virtual Networks summmary response schema ErrorResponse: title: Error Response type: object properties: response: type: array items: $ref: '#/components/schemas/ErrorObject' version: type: string description: The version of the response example: '1.0' description: Contains information explaining the error that occured processing this request. example: response: - errorCode: 2600 message: Error message detail: Error details externalDocs: description: Error Codes - Cisco DevNet url: https://developer.cisco.com/docs/dna-center/#!api-quick-start/error-codes PaginationResponse_sortBy: type: object properties: name: type: string description: Field name by which sort is requested example: siteHierarchy order: type: string description: Sort order. 'asc' for ascending and 'desc' for descending example: asc enum: - asc - desc description: List of field names and corresponding order used to sort the records. VirtualNetworkSummary: required: - virtualNetworksId type: object properties: id: type: string description: Unique uuid of the virtual network. example: vn1 name: type: string description: Full name of virtual network. example: vn1 vlan: type: string description: vlan. example: '121' vnid: type: string description: vnid. example: '8188' layer: type: string description: vn layer. example: L2 associatedL3Vn: type: string description: associatedL3Vn. example: Campus totalEndpoints: type: integer description: total number of Endpoints in the Virtual Network format: int64 example: 15 totalFabricSites: type: integer description: total number of FabricSites in the Virtual Network format: int64 example: 3 goodHealthPercentage: type: number description: Health percentage of sub category overallVnHealthPercentage format: double example: 50 goodHealthDeviceCount: type: integer description: Good Health Device Count format: int64 example: 5 totalHealthDeviceCount: type: integer description: Total number of devices contributing to VN health format: int64 example: 10 poorHealthDeviceCount: type: integer description: Poor Health Device Count format: int64 example: 3 fairHealthDeviceCount: type: integer description: Fair Health Device Count format: int64 example: 1 noHealthDeviceCount: type: integer description: Total number of no data devices in Virtual Network format: int64 example: 1 vnFabricControlPlaneGoodHealthPercentage: type: number description: Vn Fabric Control Plane Good Health Percentage format: double example: 50 vnFabricControlPlaneGoodHealthDeviceCount: type: integer description: Vn Fabric Control Plane Good Health Device Count format: int64 example: 5 vnFabricControlPlaneTotalDeviceCount: type: integer description: Vn Fabric Control Plane Total Device Count format: int64 example: 10 vnFabricControlPlanePoorHealthDeviceCount: type: integer description: Vn Fabric Control Plane Poor Health Device Count format: int64 example: 3 vnFabricControlPlaneFairHealthDeviceCount: type: integer description: Vn Fabric Control Plane Fair Health Device Count format: int64 example: 1 vnFabricControlPlaneNoHealthDeviceCount: type: integer description: Total number of no data devices in Virtual Network in Vn Fabric Control Plane category format: int64 example: 1 vnServicesHealthPercentage: type: number description: Vn Services Health Percentage format: double example: 50 vnServicesTotalDeviceCount: type: integer description: Vn Services Total Device Count format: int64 example: 10 vnServicesGoodHealthDeviceCount: type: integer description: Vn Services Good Health Device Count format: int64 example: 5 vnServicesPoorHealthDeviceCount: type: integer description: Vn Services Poor Health Device Count format: int64 example: 3 vnServicesFairHealthDeviceCount: type: integer description: Vn Services Fair Health Device Count format: int64 example: 1 vnServicesNoHealthDeviceCount: type: integer description: Total number of no data devices in Virtual Network in Vn Services category format: int64 example: 1 vnExitHealthPercentage: type: number description: Vn Exit Health Percentage format: double example: 50 vnExitTotalDeviceCount: type: integer description: Vn Exit Total Device Count format: int64 example: 10 vnExitGoodHealthDeviceCount: type: integer description: Vn Exit Good Health Device Count format: int64 example: 5 vnExitPoorHealthDeviceCount: type: integer description: Vn Exit Poor Health Device Count format: int64 example: 3 vnExitFairHealthDeviceCount: type: integer description: Vn Exit Fair Health Device Count format: int64 example: 1 vnExitNoHealthDeviceCount: type: integer description: Total number of no data devices in Virtual Network in Vn Exit category format: int64 example: 1 vnStatusHealthPercentage: type: number description: Vn Status Health Percentage format: double example: 50 vnStatusTotalDeviceCount: type: integer description: Vn Status Total Device Count format: int64 example: 10 vnStatusGoodHealthDeviceCount: type: integer description: Vn Status Good Health Device Count format: int64 example: 5 vnStatusPoorHealthDeviceCount: type: integer description: Vn Status Poor Health Device Count format: int64 example: 3 vnStatusFairHealthDeviceCount: type: integer description: Vn Status Fair Health Device Count format: int64 example: 1 vnStatusNoHealthDeviceCount: type: integer description: Total number of no data devices in Virtual Network in Vn Status category format: int64 example: 1 pubsubSessionGoodHealthPercentage: type: number description: Pubsub Session Good Health Percentage format: double example: 50 pubsubSessionTotalDeviceCount: type: integer description: Pubsub Session Total Device Count format: int64 example: 10 pubsubSessionGoodHealthDeviceCount: type: integer description: Pubsub Session Good Health Device Count format: int64 example: 5 pubsubSessionPoorHealthDeviceCount: type: integer description: Pubsub Session Poor Health Device Count format: int64 example: 3 pubsubSessionFairHealthDeviceCount: type: integer description: Pubsub Session Fair Health Device Count format: int64 example: 1 pubsubSessionNoHealthDeviceCount: type: integer description: Pubsub Session No Health Device Count format: int64 example: 1 multiCastGoodHealthPercentage: type: number description: Multicast Good Health Percentage format: double example: 50 multiCastTotalDeviceCount: type: integer description: Multicast Total Device Count format: int64 example: 10 multiCastGoodHealthDeviceCount: type: integer description: Multicast Good Health Device Count format: int64 example: 5 multiCastPoorHealthDeviceCount: type: integer description: Multicast Poor Health Device Count format: int64 example: 3 multiCastFairHealthDeviceCount: type: integer description: Multicast Fair Health Device Count format: int64 example: 1 multiCastNoHealthDeviceCount: type: integer description: Multicast Session No Health Device Count format: int64 example: 1 internetAvailGoodHealthPercentage: type: number description: Internet Availability Good Health Percentage format: double example: 50 internetAvailTotalDeviceCount: type: integer description: Internet Availability Total Device Count format: int64 example: 10 internetAvailGoodHealthDeviceCount: type: integer description: Internet Availability Good Health Device Count format: int64 example: 5 internetAvailPoorHealthDeviceCount: type: integer description: Internet Availability Poor Health Device Count format: int64 example: 3 internetAvailFairHealthDeviceCount: type: integer description: Internet Availability Fair Health Device Count format: int64 example: 1 internetAvailNoHealthDeviceCount: type: integer description: Internet Availability No Health Device Count format: int64 example: 1 bgpPeerGoodHealthPercentage: type: number description: Bgp Peer Good Health Percentage format: double example: 50 bgpPeerTotalDeviceCount: type: integer description: Bgp Peer Total Device Count format: int64 example: 10 bgpPeerGoodHealthDeviceCount: type: integer description: Bgp Peer Good Health Device Count format: int64 example: 5 bgpPeerPoorHealthDeviceCount: type: integer description: Bgp Peer Poor Health Device Count format: int64 example: 3 bgpPeerFairHealthDeviceCount: type: integer description: Bgp Peer Fair Health Device Count format: int64 example: 1 bgpPeerNoHealthDeviceCount: type: integer description: Bgp Peer No Health Device Count format: int64 example: 1 vniGoodHealthPercentage: type: number description: Vni Good Health Percentage format: double example: 50 vniTotalDeviceCount: type: integer description: Vni Total Device Count format: int64 example: 10 vniGoodHealthDeviceCount: type: integer description: Vni Good Health Device Count format: int64 example: 5 vniPoorHealthDeviceCount: type: integer description: Vni Poor Health Device Count format: int64 example: 1 vniFairHealthDeviceCount: type: integer description: Vni Fair Health Device Count format: int64 example: 1 vniNoHealthDeviceCount: type: integer description: Vni No Health Device Count format: int64 example: 1 networkProtocol: type: string description: Protocol of associated fabric site(s) enum: - LISP_PUBSUB - LISP_BGP - EVPN - HYBRID - UNKNOWN firewallConnGoodHealthPercentage: type: number description: Firewall Connectivity Good Health Percentage format: double example: 30 firewallConnGoodHealthDeviceCount: type: integer description: Firewall Connectivity Good Health Device Count format: int64 example: 5 firewallConnPoorHealthDeviceCount: type: integer description: Firewall Connectivity Poor Health Device Count format: int64 example: 5 firewallConnNoHealthDeviceCount: type: integer description: Firewall Connectivity No Health Device Count format: int64 example: 5 firewallConnFairHealthDeviceCount: type: integer description: Firewall Connectivity Fair Health Device Count format: int64 example: 5 firewallConnTotalDeviceCount: type: integer description: Firewall Connectivity Total Device Count format: int64 example: 5 description: Summary of virtual networks with health info. PaginationResponse: type: object properties: limit: type: integer description: The reference to the limit applied in the Pagination Request. example: 10 offset: type: integer description: The reference to the record offset applied in the Pagination Request. example: 1 count: type: integer description: Total number of records related to the resource after applying applicable filtering example: 20 sortBy: type: array description: Reference to the sortBy that was applied in the Pagination Request. items: $ref: '#/components/schemas/PaginationResponse_sortBy' VirtualNetworkTrend: type: object properties: timestamp: type: integer description: For trend API timestamp is the default groupBy attribute. format: int64 example: 1718218219000 attributes: type: array items: $ref: '#/components/schemas/VirtualNetworkAttributeValuePair' description: 'The aggregate trend response includes timestamp, attributes, aggregateAttributes, and group attributes. The attributes aggregateAttributes and groups are mutually exclusive. If a user requests trends without groupBy attributes, the response includes timestamp, attributes, and aggregateAttributes. However, if a user requests trends with groupBy attributes, the response includes timestamp, and the groups array contains attributes and aggregatedAttributes for each array element. ' CountIntegerResponse: title: Count Integer Response type: object properties: response: $ref: '#/components/schemas/CountIntegerResponse_response' version: type: string description: The version of the response example: '1.0' description: Reports CountIntegerResponse_response: type: object properties: count: type: integer description: The total number of records related to the resource format: int64 example: 1000 responses: defaultError: description: Unexpected Error 4XX: description: Client Error Responses - The client request caused the error. '400': description: The client made a request that the server could not understand (for example, the request syntax is incorrect). content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' 5XX: description: Server Error Responses - The server failed to fulfill the request. 3XX: description: Redirection Messages - The client must take additional action to complete the request. VirtualNetworksSummariesResponse: description: Virtual networks summmary response covering all virtual networks and their health. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/VirtualNetworksSummaries' examples: Response1: $ref: '#/components/examples/VirtualNetworksSummariesResponseExample1' VirtualNetworkTrendResponse: description: Virtual networks summmary response covering trend data for a given Virtual networks id. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/virtualNetworkSummaryTrend' examples: virtualNetworkTrend: $ref: '#/components/examples/virtualNetworkTrend' 1XX: description: Informational Responses - The server received the request and sent an informational response. 2XX: description: Successful Responses - The server received the client request, understood it, and accepted it. '500': description: The server could not fulfill the request due to internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' VirtualNetworkSummaryResponse: description: Health summmary response covering specific virtual Network and it's health. content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/VirtualNetworkSummary' examples: Response1: $ref: '#/components/examples/VirtualNetworkSummaryResponseExample1' examples: VirtualNetworkSummaryResponseExample1: summary: Virtual Network Summary response example value: response: id: VN_1 name: VN_1 networkProtocol: LISP vnid: 4099 totalFabricSites: 2 totalEndpoints: 0 goodHealthPercentage: 50 totalHealthDeviceCount: 10 goodHealthDeviceCount: 5 fairHealthDeviceCount: 2 poorHealthDeviceCount: 3 noHealthDeviceCount: 0 vnFabricControlPlaneGoodHealthPercentage: 80 vnFabricControlPlaneTotalDeviceCount: 5 vnFabricControlPlaneGoodHealthDeviceCount: 4 vnFabricControlPlanePoorHealthDeviceCount: 1 vnFabricControlPlaneFairHealthDeviceCount: 0 vnFabricControlPlaneNoHealthDeviceCount: 0 vnServicesHealthPercentage: 60 vnServicesTotalDeviceCount: 5 vnServicesGoodHealthDeviceCount: 3 vnServicesPoorHealthDeviceCount: 2 vnServicesFairHealthDeviceCount: 0 vnServicesNoHealthDeviceCount: 0 vnExitHealthPercentage: 80 vnExitTotalDeviceCount: 5 vnExitGoodHealthDeviceCount: 4 vnExitPoorHealthDeviceCount: 1 vnExitFairHealthDeviceCount: 0 vnExitNoHealthDeviceCount: 0 vnStatusTotalDeviceCount: 0 vnStatusGoodHealthDeviceCount: 0 vnStatusPoorHealthDeviceCount: 0 vnStatusFairHealthDeviceCount: 0 vnStatusNoHealthDeviceCount: 0 pubsubSessionGoodHealthPercentage: 80 pubsubSessionTotalDeviceCount: 5 pubsubSessionGoodHealthDeviceCount: 4 pubsubSessionPoorHealthDeviceCount: 1 pubsubSessionFairHealthDeviceCount: 0 pubsubSessionNoHealthDeviceCount: 0 multiCastTotalDeviceCount: 0 multiCastGoodHealthDeviceCount: 0 multiCastPoorHealthDeviceCount: 0 multiCastFairHealthDeviceCount: 0 multiCastNoHealthDeviceCount: 0 internetAvailGoodHealthPercentage: 60 internetAvailTotalDeviceCount: 5 internetAvailGoodHealthDeviceCount: 3 internetAvailPoorHealthDeviceCount: 1 internetAvailFairHealthDeviceCount: 1 internetAvailNoHealthDeviceCount: 0 bgpPeerGoodHealthPercentage: 80 bgpPeerTotalDeviceCount: 5 bgpPeerGoodHealthDeviceCount: 4 bgpPeerPoorHealthDeviceCount: 1 bgpPeerFairHealthDeviceCount: 0 bgpPeerNoHealthDeviceCount: 0 vniTotalDeviceCount: 0 vniGoodHealthDeviceCount: 0 vniPoorHealthDeviceCount: 0 vniFairHealthDeviceCount: 0 vniNoHealthDeviceCount: 0 firewallConnGoodHealthPercentage: 50.0 firewallConnGoodHealthDeviceCount: 2 firewallConnPoorHealthDeviceCount: 2 firewallConnNoHealthDeviceCount: 0 firewallConnFairHealthDeviceCount: 0 firewallConnTotalDeviceCount: 4 version: 1.0.0 VirtualNetworksSummariesResponseExample1: summary: Virtual Network Summary response example value: response: - id: VN_1 name: VN_1 networkProtocol: LISP vnid: 4099 totalFabricSites: 2 totalEndpoints: 0 goodHealthPercentage: 50 totalHealthDeviceCount: 10 goodHealthDeviceCount: 5 fairHealthDeviceCount: 2 poorHealthDeviceCount: 3 noHealthDeviceCount: 0 vnFabricControlPlaneGoodHealthPercentage: 80 vnFabricControlPlaneTotalDeviceCount: 5 vnFabricControlPlaneGoodHealthDeviceCount: 4 vnFabricControlPlanePoorHealthDeviceCount: 1 vnFabricControlPlaneFairHealthDeviceCount: 0 vnFabricControlPlaneNoHealthDeviceCount: 0 vnServicesHealthPercentage: 60 vnServicesTotalDeviceCount: 5 vnServicesGoodHealthDeviceCount: 3 vnServicesPoorHealthDeviceCount: 2 vnServicesFairHealthDeviceCount: 0 vnServicesNoHealthDeviceCount: 0 vnExitHealthPercentage: 80 vnExitTotalDeviceCount: 5 vnExitGoodHealthDeviceCount: 4 vnExitPoorHealthDeviceCount: 1 vnExitFairHealthDeviceCount: 0 vnExitNoHealthDeviceCount: 0 vnStatusTotalDeviceCount: 0 vnStatusGoodHealthDeviceCount: 0 vnStatusPoorHealthDeviceCount: 0 vnStatusFairHealthDeviceCount: 0 vnStatusNoHealthDeviceCount: 0 pubsubSessionGoodHealthPercentage: 80 pubsubSessionTotalDeviceCount: 5 pubsubSessionGoodHealthDeviceCount: 4 pubsubSessionPoorHealthDeviceCount: 1 pubsubSessionFairHealthDeviceCount: 0 pubsubSessionNoHealthDeviceCount: 0 multiCastTotalDeviceCount: 0 multiCastGoodHealthDeviceCount: 0 multiCastPoorHealthDeviceCount: 0 multiCastFairHealthDeviceCount: 0 multiCastNoHealthDeviceCount: 0 internetAvailGoodHealthPercentage: 60 internetAvailTotalDeviceCount: 5 internetAvailGoodHealthDeviceCount: 3 internetAvailPoorHealthDeviceCount: 1 internetAvailFairHealthDeviceCount: 1 internetAvailNoHealthDeviceCount: 0 bgpPeerGoodHealthPercentage: 80 bgpPeerTotalDeviceCount: 5 bgpPeerGoodHealthDeviceCount: 4 bgpPeerPoorHealthDeviceCount: 1 bgpPeerFairHealthDeviceCount: 0 bgpPeerNoHealthDeviceCount: 0 vniTotalDeviceCount: 0 vniGoodHealthDeviceCount: 0 vniPoorHealthDeviceCount: 0 vniFairHealthDeviceCount: 0 vniNoHealthDeviceCount: 0 firewallConnGoodHealthPercentage: 50.0 firewallConnGoodHealthDeviceCount: 2 firewallConnPoorHealthDeviceCount: 2 firewallConnNoHealthDeviceCount: 0 firewallConnFairHealthDeviceCount: 0 firewallConnTotalDeviceCount: 4 virtualNetworkTrend: summary: Virtual Network health trend response example value: response: - timestamp: 1718582400000 attributes: - name: goodHealthPercentage value: 70 - timestamp: 1718586000000 attributes: - name: goodHealthPercentage value: 50 - timestamp: 1718589600000 attributes: - name: goodHealthPercentage value: 80 - timestamp: 1718593200000 attributes: - name: goodHealthPercentage value: 60 - timestamp: 1718596800000 attributes: - name: goodHealthPercentage value: 30 - timestamp: 1718600400000 attributes: - name: goodHealthPercentage value: 50 page: limit: 6 offset: 0 timeSortOrder: asc version: 2.0 externalDocs: description: Catalyst Center Developer API resources url: https://developer.cisco.com/dnacenter/