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 wil
# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cisco-catalyst-center/refs/heads/main/openapi/cisco-catalyst-center-virtualnetworkhealthsummaries-api-openapi.yml