{"type":"api","title":"Retrieves summary of network device licenses","meta":{"id":"/apps/pubhub/media/cisco-catalyst-center-api-2-3-7-9/b3d6cc9fb9f506b3bc9099912aa8a6f9d87e0f0a/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":"retrievesSummaryOfNetworkDeviceLicenses","tags":["Licenses"],"summary":"Retrieves summary of network device licenses","deprecated":false,"description":"Retrieves the summary of consumed network, DNA, and unified licenses, along with the counts of unregistered and out-of-compliance network devices, and expired and expiring network device licenses.","parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"response":{"type":"object","properties":{"networkDeviceLicenseSummary":{"type":"object","properties":{"networkLicenseSummary":{"type":"object","properties":{"essentialCount":{"type":"integer","description":"Count of consumed essential licenses"},"advantageCount":{"type":"integer","description":"Count of consumed advantage licenses"}},"description":"Summary of consumed network licenses"},"dnaLicenseSummary":{"type":"object","properties":{"essentialCount":{"type":"integer","description":"Count of consumed essential licenses"},"advantageCount":{"type":"integer","description":"Count of consumed advantage licenses"}},"description":"Summary of consumed DNA licenses"},"unifiedLicenseSummary":{"type":"object","properties":{"essentialCount":{"type":"integer","description":"Count of consumed essential licenses"},"advantageCount":{"type":"integer","description":"Count of consumed advantage licenses"}},"description":"Summary of consumed unified licenses"}},"description":"Counts of consumed network, DNA, and unified network device licenses"},"unregisteredNetworkDeviceCount":{"type":"integer","description":"Count of network devices that do not have licenses enabled"},"outOfComplianceNetworkDeviceCount":{"type":"integer","description":"Count of network devices with out-of-compliance licenses. This state is seen when the license does not have an available license in the corresponding Virtual Account that the network device is registered to in the Cisco Smart Account."},"expiredNetworkDeviceLicenseCount":{"type":"integer","description":"Count of network devices with expired licenses"},"expiringNetworkDeviceLicenseCount":{"type":"integer","description":"Count of network device licenses expiring in 30 days"}},"description":"Summary of consumed network, DNA, and unified licenses, along with the counts of unregistered and out-of-compliance network devices, and expired and expiring network device licenses"},"version":{"type":"string","description":"The version of the response"}},"description":"","$$ref":"#/components/schemas/RetrievesSummaryOfNetworkDeviceLicensesResponse"}}}},"500":{"description":"The server could not fulfill the request.","content":{}},"1XX":{"description":"Informational Responses - The server received the request and sent an informational response.","content":{}},"2XX":{"description":"Successful Responses - The server received the client request, understood it, and accepted it.","content":{}},"3XX":{"description":"Redirection Messages - The client must take additional action to complete the request.","content":{}},"4XX":{"description":"Client Error Responses - The client request caused the error.","content":{}},"5XX":{"description":"Server Error Responses - The server failed to fulfill the request.","content":{}}},"x-rapi-id":"9c8e-f921-4b0a-8f2d","x-rapi-overview":"Retrieves the summary of consumed network, DNA, and unified licenses, along with the counts of unregistered and out-of-compliance network devices, and expired and expiring network device licenses.","x-rapi-domain":"System","x-rapi-subdomain":"Licenses","x-rapi-version":"1.0.0","x-rapi-internalPath":"/intent/api/v1/networkDeviceLicenses/summary","x-rapi-publicPath":"/dna/intent/api/v1/networkDeviceLicenses/summary","x-rapi-registerInKONG":true,"x-rapi-banner":["Intent"],"x-rapi-rateLimiting":"100~MINUTE","__originalOperationId":"retrievesSummaryOfNetworkDeviceLicenses","method":"get","path":"/dna/intent/api/v1/networkDeviceLicenses/summary"}}