Gets the total Network device counts based on the provided query parameters - Cisco Catalyst Center API 2.3.7.9

{"type":"api","title":"Gets the total Network device counts based on the provided query parameters","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/a58b8872fdc3116cb1a0478252ee81e8011d37c2/6a3cd7ca-617e-374c-a10b-740a529a993e","info":{"title":"Intent API","description":"Cisco Catalyst Center Platform v. 2.3.7.9","version":"2.3.7.9"},"tags":[{"name":"Authentication","description":"Access Token Request"},{"name":"Sites","description":"Create sites, assign devices to them and get site health"},{"name":"Topology","description":"Get topology details and overall network health"},{"name":"Devices","description":"Manage network devices"},{"name":"Clients","description":"Get client (by MAC Address) health, status, and information"},{"name":"Users","description":"Obtain information about *Users* and associated connections and devices"},{"name":"Issues","description":"Obtain issue details, impacted hosts, and suggested actions for remediation"},{"name":"Site Design","description":"Design/provision NFV device to site/area/building/floor"},{"name":"Network Settings","description":"Manage Network Settings"},{"name":"Software Image Management (SWIM)","description":"Manage activation and distribution of software images"},{"name":"Device Onboarding (PnP)","description":"Zero-touch deployment of network devices"},{"name":"Configuration Templates","description":"Configure and manage CLI templates"},{"name":"Configuration Archive","description":"Export device configurations to an encrypted zip file"},{"name":"SDA","description":"(BETA) Configure and manage SDA wired fabric border devices"},{"name":"Sensors","description":"Manage sensor test templates"},{"name":"Wireless","description":"Configure and manage SSIDs, Wireless, and RF profiles in non-fabric wireless network"},{"name":"Command Runner","description":"Retrieve real-time device configuration and CLI keywords"},{"name":"Discovery","description":"Discover network devices and manage discovery jobs"},{"name":"Path Trace","description":"Network route and flow analysis"},{"name":"File","description":"Get configuration files by namespace and ID"},{"name":"Task","description":"Get information about asynchronous tasks"},{"name":"Tag","description":"Assign administrator-defined tags to network devices"},{"name":"Application Policy","description":"Create and manage applications, application sets, and application policies"},{"name":"Applications","description":"Intent API to get a list of applications for a specific site, a device, or a client device's MAC address"},{"name":"ITSM","description":"Provide the details of the various third party integrations that are supported"},{"name":"Event Management","description":"Event based notification to external handlers"},{"name":"Security Advisories","description":"Provides the details of advisories on the network and devices"},{"name":"Compliance","description":"Provides compliance status data on the devices"}],"x-parser-conf":{"expand":0,"labelConfig":{"endpoint":"summary"}},"openapi":"3.0.1","servers":[{"url":"/"}]},"spec":{"operationId":"getsTheTotalNetworkDeviceCountsBasedOnTheProvidedQueryParameters_","tags":["Devices"],"summary":"Gets the total Network device counts based on the provided query parameters.","deprecated":false,"description":"Gets the total Network device counts. When there is no start and end time specified returns the latest interfaces total count. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-2.0.1-resolved.yaml","parameters":[{"name":"startTime","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.\n\nIf `startTime` is not provided, API will default to current time.\n","schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"endTime","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.\n","required":false,"schema":{"type":"number","default":"application/json"},"in":"query"},{"name":"id","description":"The list of entity Uuids. (Ex.\"6bef213c-19ca-4170-8375-b694e251101c\")\nExamples: id=6bef213c-19ca-4170-8375-b694e251101c (single entity uuid requested)\nid=6bef213c-19ca-4170-8375-b694e251101c&id=32219612-819e-4b5e-a96b-cf22aca13dd9&id=2541e9a7-b80d-4955-8aa2-79b233318ba0 (multiple entity uuid with '&' separator)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteHierarchy","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`)\n\nThis field supports wildcard asterisk (*) character search support. E.g. */San*, */San, /San*\n\nExamples:\n\n`?siteHierarchy=Global/AreaName/BuildingName/FloorName` (single siteHierarchy requested)\n\n`?siteHierarchy=Global/AreaName/BuildingName/FloorName&siteHierarchy=Global/AreaName2/BuildingName2/FloorName2` (multiple siteHierarchies requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteHierarchyId","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`)\n\nThis field supports wildcard asterisk (*) character search support. E.g. `*uuid*, *uuid, uuid*\n\nExamples:\n\n`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid `(single siteHierarchyId requested)\n\n`?siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid&siteHierarchyId=globalUuid/areaUuid2/buildingUuid2/floorUuid2` (multiple siteHierarchyIds requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"siteId","description":"The UUID of the site. (Ex. `flooruuid`)\n\nThis field supports wildcard asterisk (*) character search support. E.g.*flooruuid*, *flooruuid, flooruuid*\n\nExamples:\n\n`?siteId=id1` (single id requested)\n\n`?siteId=id1&siteId=id2&siteId=id3` (multiple ids requested)\n","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"managementIpAddress","description":"The list of entity management IP Address. It can be either Ipv4 or Ipv6 address or combination of both(Ex. \"121.1.1.10\")\n\nThis field supports wildcard (`*`) character-based search. Ex: `*1.1*` or `1.1*` or `*1.1`\n\nExamples:\nmanagementIpAddresses=121.1.1.10\nmanagementIpAddresses=121.1.1.10&managementIpAddresses=172.20.1.10&managementIpAddresses=200:10&=managementIpAddresses172.20.3.4 (multiple entity IP Address with & separator)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"macAddress","description":"The macAddress of the network device or client\nThis field supports wildcard (`*`) character-based search. \nEx: `*AB:AB:AB*` or `AB:AB:AB*` or `*AB:AB:AB`\nExamples:\n\n`macAddress=AB:AB:AB:CD:CD:CD` (single macAddress requested)\n\n`macAddress=AB:AB:AB:CD:CD:DC&macAddress=AB:AB:AB:CD:CD:FE` (multiple macAddress requested)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"family","description":"The list of network device family names Examples:family=Switches and Hubs (single network device family name )family=Switches and Hubs&family=Router&family=Wireless Controller (multiple Network device family names with & separator). This field is not case sensitive.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"type","description":"The list of network device type This field supports wildcard (`*`) character-based search. Ex: `*9407R*` or `*9407R` or `9407R*`Examples:type=SwitchesCisco Catalyst 9407R Switch (single network device types )type=Cisco Catalyst 38xx stack-able ethernet switch&type=Cisco 3945 Integrated Services Router G2 (multiple Network device types with & separator)","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"role","description":"The list of network device role. Examples:role=CORE, role=CORE&role=ACCESS&role=ROUTER (multiple Network device roles with & separator). This field is not case sensitive.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"serialNumber","description":"The list of network device serial numbers. This field supports wildcard (`*`) character-based search. Ex: `*MS1SV*` or `MS1SV*` or `*MS1SV`\nExamples:\nserialNumber=9FUFMS1SVAX serialNumber=9FUFMS1SVAX&FCW2333Q0BY&FJC240617JX(multiple Network device serial number with & separator)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"maintenanceMode","description":"The device maintenanceMode status true or false","required":false,"schema":{"type":"boolean","default":"application/json"},"in":"query"},{"name":"softwareVersion","description":"The list of network device software version This field supports wildcard (`*`) character-based search. Ex: `*17.8*` or `*17.8` or `17.8*`\nExamples:\nsoftwareVersion=2.3.4.0 (single network device software version )\nsoftwareVersion=17.9.3.23&softwareVersion=17.7.1.2&softwareVersion=*.17.7 (multiple Network device software versions with & separator)\n","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"healthScore","description":"The list of entity health score categories Examples:healthScore=good,healthScore=good&healthScore=fair (multiple entity healthscore values with & separator). This field is not case sensitive.","schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"fabricSiteId","description":"The fabric site Id or list to fabric site Ids to filter the data This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: `?fabricSiteId=fabricSiteUuid) ?fabricSiteId=fabricSiteUuid1&fabricSiteId=fabricSiteUuid2 (multiple fabricSiteIds requested)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"l2Vn","description":"The L2 Virtual Network Id or list to Virtual Network Ids to filter the data This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: `?l2Vn=virtualNetworkId ?l2Vn=virtualNetworkId1&l2Vn=virtualNetworkId2 (multiple virtualNetworkId's requested)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"l3Vn","description":"The L3 Virtual Network Id or list to Virtual Network Ids to filter the data This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: `?l3Vn=virtualNetworkId ?l3Vn=virtualNetworkId1&l3Vn=virtualNetworkId2 (multiple virtualNetworkId's requested)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"transitNetworkId","description":"The Transit Network Id or list to Transit Network Ids to filter the data This field supports wildcard asterisk (*) character search support. E.g. *uuid*, *uuid, uuid* Examples: `?transitNetworkId=transitNetworkId ?transitNetworkId=transitNetworkuuid1&transitNetworkId=transitNetworkuuid1 (multiple transitNetworkIds requested)","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"},{"name":"fabricRole","description":"The list of fabric device role. Examples: fabricRole=BORDER, fabricRole=BORDER&fabricRole=EDGE (multiple fabric device roles with & separator) Available values : BORDER, EDGE, MAP-SERVER, LEAF, SPINE, TRANSIT-CP, EXTENDED-NODE, WLC, UNIFIED-AP","required":false,"schema":{"type":"string","default":"application/json"},"in":"query"}],"responses":{"200":{"description":"Response object containing total count of the records after applying requested filters","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"count":{"type":"integer","description":""}},"description":""},"version":{"type":"string","description":""}},"description":"","$$ref":"#/components/schemas/GetsTheTotalNetworkDeviceCountsBasedOnTheProvidedQueryParametersResponse"}}}},"400":{"description":"The client made a request that the server could not understand (for example, the request syntax is incorrect).","content":{}},"401":{"description":"The client's authentication credentials included with the request are missing or invalid.","content":{}},"403":{"description":"The server recognizes the authentication credentials, but the client is not authorized to perform this request.","content":{}},"404":{"description":"The client made a request for a resource that does not exist.","content":{}},"405":{"description":"The client made a request using an http method which is not supported for this resource.","content":{}},"415":{"description":"The client sent a request body in a format that the server does not support (for example, XML to a server that only accepts JSON).","content":{}},"500":{"description":"The server could not fulfill the request due to internal server error","content":{}},"502":{"description":"There is a bad gateway connection from the client to the server.","content":{}},"default":{"description":"Unexpected Error","content":{}}},"x-rapi-id":"f0a6-e96b-44fb-a549","x-rapi-overview":"Gets the total Network device counts. When there is no start and end time specified returns the latest interfaces total count. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceNetworkDevices-2.0.1-resolved.yaml","x-rapi-domain":"Know Your Network","x-rapi-subdomain":"Devices","x-rapi-version":"1.0.0","x-rapi-internalPath":"/data/api/v1/networkDevices/count","x-rapi-publicPath":"/dna/data/api/v1/networkDevices/count","x-rapi-registerInKONG":true,"x-rapi-banner":[],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"getsTheTotalNetworkDeviceCountsBasedOnTheProvidedQueryParameters.","method":"get","path":"/dna/data/api/v1/networkDevices/count"}}