generated: '2026-08-19' method: searched status: published source: https://github.com/cisco-en-programmability/catc-mcp-oss deployment: mode: local-stdio install: git clone https://github.com/cisco-en-programmability/catc-mcp-oss && git checkout release/ && docker build -t catalyst-center-mcp:local . && docker run --rm -p 127.0.0.1:7001:7001 catalyst-center-mcp:local package: https://github.com/cisco-en-programmability/catc-mcp-oss auth: none verified: searched deployment_note: There is NO Cisco-hosted remote MCP endpoint. The operator builds the Docker image from a release branch matching their controller version and runs it themselves; it then serves a streamable-HTTP endpoint on http://localhost:7001/v1/mcp or speaks stdio as a client-launched child process. The MCP endpoint itself requires no inbound credential — the README states "The local server does not require an inbound header" — and the server authenticates upstream to Catalyst Center with CATALYST_CENTER_USERNAME / CATALYST_CENTER_PASSWORD environment variables. Cisco explicitly warns the server adds no authorization layer and does not enforce read-only access. server: name: catalyst-center transport: - http - stdio local_endpoint: http://localhost:7001/v1/mcp health: http://localhost:7001/v1/health readiness: http://localhost:7001/v1/readiness license: Apache-2.0 implementation: FastMCP (Python) release_branch: release/2.3.7.11 bundle_version: 2.3.7.x clients_documented: - Claude Desktop - Cursor - VS Code - Codex agents: - catalyst_client_troubleshooting_agent - catalyst_flexible_reports_agent - catalyst_network_engineer_agent tool_count: 516 tool_methods: GET: 514 POST: 1 null: 1 tool_catalog_note: Every bundled tool is a JSON file under catalyst_center_mcp/bundled_tools/ carrying the backing Catalyst Center HTTP method, URI and a JSON Schema parameter object — the tool list below is read verbatim from release/2.3.7.11, not derived. 514 of 516 tools are GET, so the shipped bundle is overwhelmingly read-oriented. tools: - name: null method: null uri: null api_version: null description: null parameters: [] required: [] - name: api_applications method: GET uri: /dna/intent/api/v1/application-health api_version: 2.3.7.9 description: Intent API to get a list of applications for a specific site, a device, or a client device's MAC address. For a combination of a specific application with site and/or device the API gets list of issues/devices/endpoints. parameters: - applicationHealth - applicationName - deviceId - endTime - limit - macAddress - offset - siteId - startTime required: [] - name: api_ciscoCatalystCenterNodesConfigurationSummary method: GET uri: /dna/intent/api/v1/nodes-config api_version: 2.3.7.9 description: Provides details about the current Cisco Catalyst Center node configuration, such as API version, node name, NTP server, intracluster link, LACP mode, network static routes, DNS server, subnet mask, host IP, default gate parameters: [] required: [] - name: api_ciscoCatalystCenterPackagesSummary method: GET uri: /dna/intent/api/v1/dnac-packages api_version: 2.3.7.9 description: Provides information such as name, version of packages installed on the Cisco Catalyst Center. parameters: [] required: [] - name: api_ciscoCatalystCenterReleaseSummary method: GET uri: /dna/intent/api/v1/dnac-release api_version: 2.3.7.9 description: Provides information such as API version, mandatory core packages for installation or upgrade, optional packages, Cisco Catalyst Center name and version, supported direct updates, and tenant ID. parameters: [] required: [] - name: api_ciscoISEServerIntegrationStatus method: GET uri: /dna/intent/api/v1/ise-integration-status api_version: 2.3.7.9 description: Checks Cisco ISE server integration workflow status. This reports integration progress, completion, failures, and integration step status only. It does not return the configured ISE server state; configured ISE server st parameters: [] required: [] - name: api_clientProximity method: GET uri: /dna/intent/api/v1/client-proximity api_version: 2.3.7.9 description: 'This intent API will provide client proximity information for a specific wireless user. Proximity is defined as presence on the same floor at the same time as the specified wireless user. The Proximity workflow requires ' parameters: - number_days - time_resolution - username required: - username - name: api_complianceDetailsOfDevice method: GET uri: /dna/intent/api/v1/compliance/{deviceUuid}/detail api_version: 2.3.7.9 description: '**Tool Dependency: CRITICAL** This tool retrieves DETAILED compliance report information for a SPECIFIC device. Use this tool only when the user asks for compliance DETAILS, a compliance breakdown, a full compliance rep' parameters: - category - complianceType - deviceUuid - diffList - remediationSupported - status required: - deviceUuid - name: api_complianceRemediation method: POST uri: /dna/intent/api/v1/compliance/networkDevices/{id}/issues/remediation/provision api_version: 2.3.7.9 description: Remediates configuration compliance issues. Compliance issues related to 'Routing', 'HA Remediation', 'Software Image', 'Securities Advisories', 'SD-Access Unsupported Configuration', 'Workflow', etc. will not be address parameters: - Content-Type - id required: - Content-Type - id - name: api_countClientsEnergy method: GET uri: /dna/data/api/v1/energy/clients/count api_version: 2.3.7.9 description: 'Retrieves the total count of client devices that provide energy data, filtered according to the specified query parameters. For detailed information about the usage of the API, please refer to the Open API specification ' parameters: - X-CALLER-ID - deviceCategory - deviceSubCategory - endTime - id - siteHierarchy - siteHierarchyId - siteId - startTime required: [] - name: api_countDevicesEnergy method: GET uri: /dna/data/api/v1/energy/networkDevices/count api_version: 2.3.7.9 description: Retrieves the total count of network devices that provide energy data, filtered according to the specified query parameters. For detailed information about the usage of the API, please refer to the Open API specification parameters: - X-CALLER-ID - deviceCategory - deviceSubCategory - endTime - id - siteHierarchy - siteHierarchyId - siteId - startTime required: [] - name: api_countOfEventSubscriptions method: GET uri: /dna/intent/api/v1/event/subscription/count api_version: 2.3.7.9 description: Returns the count of event subscriptions that have been configured or created. Use this tool when the user asks about the number of active event subscriptions. It can answer questions like How many event subscriptions ar parameters: - eventIds required: [] - name: api_countOfEvents method: GET uri: /dna/intent/api/v1/events/count api_version: 2.3.7.9 description: Get the count of registered events with provided eventIds or tags as mandatory parameters: - eventId - tags required: - tags - name: api_countOfNetworkDeviceConfigurationFiles method: GET uri: /dna/intent/api/v1/networkDeviceConfigFiles/count api_version: 2.3.7.9 description: Internal diagnostic counter. Returns a raw integer count of stored records, optionally filtered by owning device id and file type. Intended only for back-end housekeeping pipelines. Not used to answer user-facing questio parameters: - fileType - id - networkDeviceId required: [] - name: api_countOfNetworkDeviceImageUpdates method: GET uri: /dna/intent/api/v1/networkDeviceImageUpdates/count api_version: 2.3.7.9 description: Returns the count of network device image updates based on the given filter criteria parameters: - endTime - hostName - id - imageName - managementAddress - networkDeviceId - parentId - startTime - status required: [] - name: api_countOfNetworkProductNames method: GET uri: /dna/intent/api/v1/productNames/count api_version: 2.3.7.9 description: Count of product names based on filter criteria parameters: - productId - productName required: [] - name: api_countOfNotifications method: GET uri: /dna/intent/api/v1/event/event-series/count api_version: 2.3.7.9 description: Get the Count of Published Notifications based on the various inputs from the user. It can answer questions like How many notifications are there for event X? or Give me the count of all notifications and many more combi parameters: - category - domain - endTime - eventIds - severity - source - startTime - subDomain - type required: [] - name: api_countOfSecurityServiceInsertionSummaries method: GET uri: /dna/intent/api/v1/securityServiceInsertionSummaries/count api_version: 2.3.7.9 description: Retrieves the total count of Security Service Insertion (SSI) summaries. parameters: [] required: [] - name: api_countOfSecurityServiceInsertions method: GET uri: /dna/intent/api/v1/securityServiceInsertions/count api_version: 2.3.7.9 description: Retrieves the count of Security Service Insertions. parameters: [] required: [] - name: api_countSitesEnergy method: GET uri: /dna/data/api/v1/energy/sites/count api_version: 2.3.7.9 description: 'Retrieves the total count of sites that provide energy data, filtered according to the specified query parameters. For detailed information about the usage of the API, please refer to the Open API specification document ' parameters: - X-CALLER-ID - deviceCategory - endTime - siteHierarchy - siteHierarchyId - siteId - siteName - siteType - startTime - taskId required: [] - name: api_countSitesEnergyForTheGivenTaskID method: GET uri: /dna/data/api/v1/energy/sites/query/count api_version: 2.3.7.9 description: Gets count sites energy task result for the given task ID. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-c parameters: - X-CALLER-ID - taskId required: [] - name: api_countTheNumberOfEvents method: GET uri: /dna/data/api/v1/assuranceEvents/count api_version: 2.3.7.9 description: API to fetch the count of assurance events that match the filter criteria. Please refer to the 'API Support Documentation' section to understand which fields are supported. For detailed information about the usage of the parameters: - X-CALLER-ID - apMac - clientMac - deviceFamily - endTime - messageType - networkDeviceId - networkDeviceName - severity - siteHierarchyId - siteId - startTime required: - deviceFamily - name: api_countTheNumberOfNetworkDevices method: GET uri: /dna/intent/api/v1/networkDevices/count api_version: 2.3.7.9 description: API to fetch the count of network devices using basic filters. Use the `/dna/intent/api/v1/networkDevices/query/count` API if you need advanced filtering. parameters: - family - id - managementAddress - managementState - reachabilityStatus - role - serialNumber - stackDevice - status required: [] - name: api_countsGlobalIPAddressPools method: GET uri: /dna/intent/api/v1/ipam/globalIpAddressPools/count api_version: 2.3.7.9 description: 'Returns the total count of global IP address pools. PRECEDENCE Apply sections in order. Higher sections override lower sections when they conflict. S0 Scope and hard boundaries S0.1 Count-only tool for global pools. S0' parameters: [] required: [] - name: api_countsIPAddressSubpools method: GET uri: /dna/intent/api/v1/ipam/siteIpAddressPools/count api_version: 2.3.7.9 description: 'Returns the total count of IP address subpools. PRECEDENCE Apply sections in order. Higher sections override lower sections when they conflict. S0 Scope and hard boundaries S0.1 Count-only tool for subpools. S0.2 Do no' parameters: - siteId required: [] - name: api_countsSubpoolsOfAGlobalIPAddressPool method: GET uri: /dna/intent/api/v1/ipam/globalIpAddressPools/{globalIpAddressPoolId}/subpools/count api_version: 2.3.7.9 description: 'Counts the number of IP address subpools within a specific global IP address pool. PRECEDENCE Apply sections in order. Higher sections override lower sections when they conflict. S0 Scope and hard boundaries S0.1 Count' parameters: - globalIpAddressPoolId required: - globalIpAddressPoolId - name: api_custom_promptSupportGETAPI method: GET uri: /dna/intent/api/v1/network-device/custom-prompt api_version: 2.3.7.9 description: Returns supported custom prompts by Catalyst Center parameters: [] required: [] - name: api_deviceComplianceStatus method: GET uri: /dna/intent/api/v1/compliance/{deviceUuid} api_version: 2.3.7.9 description: Get detailed compliance breakdown by type (PSIRT, EOX, CONFIG, IMAGE) with source-level violations for a device. parameters: - deviceUuid required: - deviceUuid - name: api_devices method: GET uri: /dna/intent/api/v1/device-health api_version: 2.3.7.9 description: Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services. parameters: - deviceRole - endTime - health - limit - offset - siteId - startTime required: [] - name: api_disasterRecoveryOperationalStatus method: GET uri: /dna/intent/api/v1/disasterrecovery/system/operationstatus api_version: 2.3.7.9 description: Returns the status of Disaster Recovery operation performed on the system. parameters: [] required: [] - name: api_disasterRecoveryStatus method: GET uri: /dna/intent/api/v1/disasterrecovery/system/status api_version: 2.3.7.9 description: Detailed and Summarized status of DR components (Active, Standby and Witness system's health). parameters: [] required: [] - name: api_downloadAFileByFileId method: GET uri: /dna/intent/api/v1/file/{fileId} api_version: 2.3.7.9 description: Downloads a file specified by fileId parameters: - fileId required: - fileId - name: api_downloadFlexibleReport method: GET uri: /dna/data/api/v1/flexible-report/report/content/{reportId}/{executionId} api_version: 2.3.7.9 description: 'This is used to download the flexible report. The API returns report content. Save the response to a file by converting the response data as a blob and setting the file format available from content-disposition response ' parameters: - Content-Type - executionId - reportId required: - Content-Type - reportId - executionId - name: api_downloadReportContent method: GET uri: /dna/intent/api/v1/data/reports/{reportId}/executions/{executionId} api_version: 2.3.7.9 description: Returns report content. Save the response to a file by converting the response data as a blob and setting the file format available from content-disposition response header. parameters: - executionId - reportId required: - reportId - executionId - name: api_downloadsASpecificICAPPacketCaptureFile method: GET uri: /dna/data/api/v1/icap/captureFiles/{id}/download api_version: 2.3.7.9 description: Downloads a specific ICAP packet capture file. 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-sp parameters: - X-CALLER-ID - id required: - id - name: api_eventArtifactCount method: GET uri: /dna/system/api/v1/event/artifact/count api_version: 2.3.7.9 description: 'Get the total count of registered event artifacts. Event artifacts are event definitions or templates available in the system. It can answer questions like How many event artifacts are there? or Give me the count of all ' parameters: [] required: [] - name: api_fetchTheCountOfEndpoints method: GET uri: /dna/intent/api/v1/endpoint-analytics/endpoints/count api_version: 2.3.7.9 description: Fetch the total count of endpoints that match the given filter criteria. parameters: - aiSpoofingTrustLevel - ancPolicy - authMethod - changedProfileTrustLevel - concurrentMacTrustLevel - deviceType - hardwareManufacturer - hardwareModel - ip - ipBlocklistDetected - macAddress - macAddresses - natTrustLevel - operatingSystem - postureStatus - profilingStatus - randomMac - registered - trustScore - unauthPortDetected - weakCredDetected required: [] - name: api_get802_11beProfileByID method: GET uri: /dna/intent/api/v1/wirelessSettings/dot11beProfiles/{id} api_version: 2.3.7.9 description: This API allows the user to get 802.11be Profile by ID parameters: - id required: - id - name: api_get802_11beProfiles method: GET uri: /dna/intent/api/v1/wirelessSettings/dot11beProfiles api_version: 2.3.7.9 description: This API allows the user to get 802.11be Profile(s) configured under Wireless Settings parameters: - isMuMimoDownLink - isMuMimoUpLink - isOfDmaDownLink - isOfDmaMultiRu - isOfDmaUpLink - limit - offset - profileName required: [] - name: api_get802_11beProfilesCount method: GET uri: /dna/intent/api/v1/wirelessSettings/dot11beProfiles/count api_version: 2.3.7.9 description: This API allows the user to get count of all 802.11be Profile(s) parameters: [] required: [] - name: api_getAAAAttributeAPI method: GET uri: /dna/system/api/v1/users/external-servers/aaa-attribute api_version: 2.3.7.9 description: Get the current value of the custom AAA attribute. parameters: [] required: [] - name: api_getAAAOverrideVlanSettingsBySite method: GET uri: /dna/intent/api/v1/sites/{siteId}/wirelessSettings/flexConnectAaaOverride api_version: 2.3.7.9 description: This API allows the user to get all Flex Connect AAA Override VLAN settings at the given site parameters: - siteId required: - siteId - name: api_getAAARadiusAttributesConfigurationFeatureTemplate method: GET uri: /dna/intent/api/v1/featureTemplates/wireless/aaaRadiusAttributesConfigurations/{id} api_version: 2.3.7.9 description: This API allows users to retrieve a specific AAA Radius Attributes configuration feature template by ID. parameters: - id required: - id - name: api_getAIEndpointAnalyticsAttributeDictionaries method: GET uri: /dna/intent/api/v1/endpoint-analytics/dictionaries api_version: 2.3.7.9 description: Fetches the list of attribute dictionaries. parameters: - includeAttributes required: [] - name: api_getANCPolicies method: GET uri: /dna/intent/api/v1/endpoint-analytics/anc-policies api_version: 2.3.7.9 description: Fetches the list of ANC policies available in ISE. parameters: [] required: [] - name: api_getAPAuthorizationListByID method: GET uri: /dna/intent/api/v1/wirelessSettings/apAuthorizationLists/{id} api_version: 2.3.7.9 description: This API allows the user to get an AP Authorization List by AP Authorization List ID that captured in wireless settings design. parameters: - id required: - id - name: api_getAPAuthorizationListByNetworkDeviceId method: GET uri: /dna/intent/api/v1/wirelessControllers/{networkDeviceId}/apAuthorizationLists api_version: 2.3.7.9 description: This API allows the user to get an AP Authorization List details configured for the given provisioned network device Id. Obtain the network device ID value by using the API GET call '/dna/intent/api/v1/network-device/ip- parameters: - networkDeviceId required: - networkDeviceId - name: api_getAPAuthorizationListCount method: GET uri: /dna/intent/api/v1/wirelessSettings/apAuthorizationLists/count api_version: 2.3.7.9 description: This API allows the user to get count of all AP Authorization lists. parameters: [] required: [] - name: api_getAPAuthorizationLists method: GET uri: /dna/intent/api/v1/wirelessSettings/apAuthorizationLists api_version: 2.3.7.9 description: Retrieves the AP Authorization Lists that are created in the Catalyst Centre network Design for wireless. If an AP Authorization List name is given as query parameter, then returns respective AP Authorization List detail parameters: - apAuthorizationListName - limit - offset required: [] - name: api_getAPPnPLocationSetting method: GET uri: /dna/intent/api/v1/systemSettings/apPnPLocation api_version: 2.3.7.9 description: Retrieve the current AP PnP Location setting from the system.Once the AP PnP Location Setting is enabled, the Access Point's assigned Site name will be configured as the AP Location during the PnP Claim process. This app parameters: [] required: [] - name: api_getAPProfileByID method: GET uri: /dna/intent/api/v1/wirelessSettings/apProfiles/{id} api_version: 2.3.7.9 description: This API allows the user to get a AP Profile by AP Profile ID that captured in wireless settings design parameters: - id required: - id - name: api_getAPProfiles method: GET uri: /dna/intent/api/v1/wirelessSettings/apProfiles api_version: 2.3.7.9 description: This API allows the user to get AP profiles that are captured in wireless settings design. parameters: - apProfileName - limit - offset required: [] - name: api_getAPProfilesCount method: GET uri: /dna/intent/api/v1/wirelessSettings/apProfiles/count api_version: 2.3.7.9 description: This API returns the total number of AP Profiles available. parameters: [] required: [] - name: api_getAScheduledReport method: GET uri: /dna/intent/api/v1/data/reports/{reportId} api_version: 2.3.7.9 description: Get scheduled report configuration by reportId parameters: - reportId required: - reportId - name: api_getAccessPointConfigurationTaskResult method: GET uri: /dna/intent/api/v1/wireless/accesspoint-configuration/details/{task_id} api_version: 2.3.7.9 description: Users can query the access point configuration result using this intent API parameters: - task_id required: - task_id - name: api_getAccessPointRebootTaskResult method: GET uri: /dna/intent/api/v1/device-reboot/apreboot/status api_version: 2.3.7.9 description: Users can query the access point reboot status using this intent API parameters: - parentTaskId required: [] - name: api_getAccessPoint_s_FactoryResetStatus method: GET uri: /dna/intent/api/v1/wirelessAccessPoints/factoryResetRequestStatus api_version: 2.3.7.9 description: This API returns each AP Factory Reset initiation status. parameters: - taskId required: - taskId - name: api_getAccessPointsPositions method: GET uri: /dna/intent/api/v2/floors/{floorId}/accessPointPositions api_version: 2.3.7.9 description: Retrieve all Access Points positions assigned for a specific floor parameters: - floorId - limit - macAddress - model - name - offset - type required: - floorId - name: api_getAccessPointsPositionsCount method: GET uri: /dna/intent/api/v2/floors/{floorId}/accessPointPositions/count api_version: 2.3.7.9 description: Retrieve Access Points positions count assigned for a specific floor parameters: - floorId - macAddress - model - name - type required: - floorId - name: api_getActivities method: GET uri: /dna/intent/api/v1/activities api_version: 2.3.7.9 description: Returns activity(s) based on filter criteria parameters: - description - endTime - limit - offset - order - recurring - sortBy - startTime - status - type required: [] - name: api_getActivityByID method: GET uri: /dna/intent/api/v1/intent/api/v1/activities/{id} api_version: 2.3.7.9 description: Returns the activity with the given ID parameters: - id required: - id - name: api_getAdvancedSSIDConfigurationFeatureTemplate method: GET uri: /dna/intent/api/v1/featureTemplates/wireless/advancedSSIDConfigurations/{id} api_version: 2.3.7.9 description: This API allows users to retrieve a specific Advanced SSID configuration feature template by ID. parameters: - id required: - id - name: api_getAllBackup method: GET uri: /dna/system/api/v1/backups api_version: 1.0.0-oas3 description: '**Pick this tool for backup INVENTORY and backup HISTORY questions.** This tool lists backups available in the configured Catalyst Center backup storage with optional filtering, sorting, and pagination. It returns backu' parameters: - limit - offset - order - query - sortBy required: [] - name: api_getAllExecutionDetailsForAGivenReport method: GET uri: /dna/intent/api/v1/data/reports/{reportId}/executions api_version: 2.3.7.9 description: Get details of all executions for a given report parameters: - reportId required: - reportId - name: api_getAllFlexibleReportSchedules method: GET uri: /dna/data/api/v1/flexible-report/schedules api_version: 2.3.7.9 description: Get all flexible report schedules parameters: - Content-Type required: - Content-Type - name: api_getAllGlobalCredentialsV2 method: GET uri: /dna/intent/api/v2/global-credential api_version: 2.3.7.9 description: API to get device credentials' details. It fetches all global credentials of all types at once, without the need to pass any input parameters. parameters: [] required: [] - name: api_getAllHealthScoreDefinitionsForGivenFilters method: GET uri: /dna/intent/api/v1/healthScoreDefinitions api_version: 2.3.7.9 description: 'Get all health score defintions. Supported filters are id, name and overall health include status. A health score definition can be different across device type. So, deviceType in the query param is important and defaul' parameters: - X-CALLER-ID - attribute - deviceType - id - includeForOverallHealth - limit - offset required: [] - name: api_getAllITSMIntegrationSettings method: GET uri: /dna/intent/api/v1/integration-settings/itsm/instances api_version: 2.3.7.9 description: Fetches all ITSM Integration settings instances and their configurations based on the user inputs. It can answer questions like What ITSM integrations are configured? or List all ITSM integration settings and their detai parameters: - order - page - page_size - sortBy required: [] - name: api_getAllInterfaces method: GET uri: /dna/intent/api/v1/interface api_version: 2.3.7.9 description: Returns all available interfaces. This endpoint can return a maximum of 500 interfaces. The API returns a paginated response based on 'limit' and 'offset' parameters, allowing up to 500 records per page. 'limit' specifie parameters: - lastInputTime - lastOutputTime - limit - offset required: [] - name: api_getAllKeywordsOfCLIsAcceptedByCommandRunner method: GET uri: /dna/intent/api/v1/network-device-poller/cli/legit-reads api_version: 2.3.7.9 description: Get valid keywords parameters: [] required: [] - name: api_getAllTheCustomIssueDefinitionsBasedOnTheGivenFilters method: GET uri: /dna/intent/api/v1/customIssueDefinitions api_version: 2.3.7.9 description: Retrieve the existing syslog-based custom issue definitions. The supported filters are id, name, profileId, definition enable status, priority, severity, facility and mnemonic. The issue definition configurations may va parameters: - X-CALLER-ID - facility - id - isEnabled - limit - mnemonic - name - offset - order - priority - profileId - severity - sortBy required: [] - name: api_getAllTheDetailsAndSuggestedActionsOfAnIssueForTheG_34a1791b method: GET uri: /dna/data/api/v1/assuranceIssues/{id} api_version: 2.3.7.9 description: Returns all the details and suggested actions of an issue for the given issue id. https://github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-IssuesList-1.0.0-resolved.yaml parameters: - Accept-Language - X-CALLER-ID - attribute - id - view required: - id - name: api_getAllowedMacAddress method: GET uri: /dna/intent/api/v1/security/threats/rogue/allowed-list api_version: 2.3.7.9 description: Intent API to fetch all the allowed mac addresses in the system. parameters: - Content-Type - limit - offset required: - Content-Type - name: api_getAllowedMacAddressCount method: GET uri: /dna/intent/api/v1/security/threats/rogue/allowed-list/count api_version: 2.3.7.9 description: Intent API to fetch the count of allowed mac addresses in the system. parameters: - Content-Type required: - Content-Type - name: api_getAnchorCapableDevices method: GET uri: /dna/intent/api/v1/wirelessControllers/anchorCapableDevices api_version: 2.3.7.9 description: This API allows the user to get Anchor capable devices parameters: [] required: [] - name: api_getAnchorGroupByID method: GET uri: /dna/intent/api/v1/wirelessSettings/anchorGroups/{id} api_version: 2.3.7.9 description: This API allows the user to get an AnchorGroup by AnchorGroup ID parameters: - id required: - id - name: api_getAnchorGroups_v2_3_7_10 method: GET uri: /dna/intent/api/v1/wirelessSettings/anchorGroups api_version: 2.3.7.10 description: This API allows the user to get AnchorGroups that captured in wireless settings design. parameters: - limit - offset required: [] - name: api_getAnchorManagedAPLocationsForSpecificWirelessController method: GET uri: /dna/intent/api/v1/wirelessControllers/{networkDeviceId}/anchorManagedApLocations api_version: 2.3.7.9 description: For managed-site relation queries, return managed=true on first match across Primary/Secondary/Anchor, and return managed=false only after all three are checked with no match. For runtime managed-site detail controller/W parameters: - limit - networkDeviceId - offset required: - networkDeviceId - name: api_getApplicationCount method: GET uri: /dna/intent/api/v2/applications-count api_version: 2.3.7.9 description: Get the number of all existing applications parameters: - scalableGroupType required: - scalableGroupType - name: api_getApplicationPolicy method: GET uri: /dna/intent/api/v1/app-policy api_version: 2.3.7.9 description: Get all existing application policies parameters: - policyScope required: [] - name: api_getApplicationPolicyDefault method: GET uri: /dna/intent/api/v1/app-policy-default api_version: 2.3.7.9 description: Get default application policy parameters: [] required: [] - name: api_getApplicationPolicyQueuingProfile method: GET uri: /dna/intent/api/v1/app-policy-queuing-profile api_version: 2.3.7.9 description: Get all or by name, existing application policy queuing profiles parameters: - name required: [] - name: api_getApplicationPolicyQueuingProfileCount method: GET uri: /dna/intent/api/v1/app-policy-queuing-profile-count api_version: 2.3.7.9 description: Get the number of all existing application policy queuing profile parameters: [] required: [] - name: api_getApplicationSetCount method: GET uri: /dna/intent/api/v2/application-policy-application-set-count api_version: 2.3.7.9 description: Get the number of all existing application sets parameters: - scalableGroupType required: - scalableGroupType - name: api_getApplicationSet_s method: GET uri: /dna/intent/api/v2/application-policy-application-set api_version: 2.3.7.9 description: Get application set/s by offset/limit or by name parameters: - attributes - limit - name - offset required: - attributes - offset - limit - name: api_getApplicationSets method: GET uri: /dna/intent/api/v1/application-policy-application-set api_version: 2.3.7.9 description: Get appllication-sets by offset/limit or by name parameters: - limit - name - offset required: [] - name: api_getApplicationSetsCount method: GET uri: /dna/intent/api/v1/application-policy-application-set-count api_version: 2.3.7.9 description: Get the number of existing application-sets parameters: [] required: [] - name: api_getApplication_s method: GET uri: /dna/intent/api/v2/applications api_version: 2.3.7.9 description: Get application/s by offset/limit or by name parameters: - attributes - limit - name - offset required: - attributes - offset - limit - name: api_getApplications method: GET uri: /dna/intent/api/v1/applications api_version: 2.3.7.9 description: Get applications by offset/limit or by name parameters: - limit - name - offset required: [] - name: api_getApplicationsCount method: GET uri: /dna/intent/api/v1/applications-count api_version: 2.3.7.9 description: Get the number of all existing applications parameters: [] required: [] - name: api_getAuditLogParentRecords method: GET uri: /dna/data/api/v1/event/event-series/audit-log/parent-records api_version: 2.3.7.9 description: Get Parent Audit Log Event instances from the Event-Hub parameters: - category - context - description - deviceId - domain - endTime - eventHierarchy - eventId - instanceId - isSystemEvents - limit - name - offset - order - severity - siteId - sortBy - source - startTime - subDomain - userId required: [] - name: api_getAuditLogRecords method: GET uri: /dna/data/api/v1/event/event-series/audit-logs api_version: 2.3.7.9 description: Get Audit Log Event instances from the Event-Hub parameters: - category - context - description - deviceId - domain - endTime - eventHierarchy - eventId - instanceId - isSystemEvents - limit - name - offset - order - parentInstanceId - severity - siteId - sortBy - source - startTime - subDomain - userId required: [] - name: api_getAuditLogSummary method: GET uri: /dna/data/api/v1/event/event-series/audit-log/summary api_version: 2.3.7.9 description: Get Audit Log Summary from the Event-Hub parameters: - category - context - description - deviceId - domain - endTime - eventHierarchy - eventId - instanceId - isParentOnly - isSystemEvents - name - parentInstanceId - severity - siteId - source - startTime - subDomain - userId required: [] - name: api_getAuthenticationAndPolicyServers method: GET uri: /dna/intent/api/v1/authentication-policy-servers api_version: 2.3.7.9 description: Retrieves configured Authentication and Policy Servers, including AAA servers and ISE servers, with server attributes such as IP address, server state, role, authentication port, accounting port, and ISE enablement. This parameters: - isIseEnabled - role - state required: [] - name: api_getBackupById method: GET uri: /dna/system/api/v1/backups/{id} api_version: 1.0.0-oas3 description: '**Pick this tool for ONE specific backup when you already know the backup ID.** This tool retrieves the full details for a specific backup by backup UUID, including installed packages, versions, compatibility errors, st' parameters: - id required: - id - name: api_getBackupConfiguration method: GET uri: /dna/system/api/v1/backupConfiguration api_version: 1.0.0-oas3 description: '**Pick this tool for backup SETTINGS and configuration questions.** This tool retrieves the current Catalyst Center backup configuration, including retention policy, configured storage type, mount path, and whether an e' parameters: [] required: [] - name: api_getBackupRestoreExecution method: GET uri: /dna/system/api/v1/backupRestoreExecutions/{id} api_version: 1.0.0-oas3 description: '**Pick this tool for ONE specific backup or restore execution when you already know the execution ID.** This tool retrieves the full details for one backup or restore execution by execution UUID, including error diagnos' parameters: - id required: - id - name: api_getBackupRestoreExecutions method: GET uri: /dna/system/api/v1/backupRestoreExecutions api_version: 1.0.0-oas3 description: '**Pick this tool for backup JOB HISTORY and restore JOB HISTORY questions.** This tool lists backup and restore execution history with optional filtering by backup, job type, status, pagination, and sorting. **Use this' parameters: - backupId - jobType - limit - offset - order - sortBy - status required: [] - name: api_getBackupStorages method: GET uri: /dna/system/api/v1/backupStorages api_version: 1.0.0-oas3 description: '**Pick this tool for mounted BACKUP STORAGE CAPACITY and backup disk usage questions.** This tool retrieves mounted backup storage information such as mount point, filesystem details, total capacity, used capacity, and ' parameters: - storageType required: - storageType - name: api_getBugAffectingTheNetworkDeviceByDeviceIdAndBugId method: GET uri: /dna/intent/api/v1/networkBugs/results/networkDevices/{networkDeviceId}/bugs/{id} api_version: 2.3.7.9 description: Get bug affecting the network device by device Id and bug id parameters: - id - networkDeviceId required: - networkDeviceId - id - name: api_getBugsAffectingTheNetworkDevice method: GET uri: /dna/intent/api/v1/networkBugs/results/networkDevices/{networkDeviceId}/bugs api_version: 2.3.7.9 description: Get bugs affecting the network device parameters: - id - limit - networkDeviceId - offset - order - severity - sortBy required: - networkDeviceId - name: api_getBusinessAPIExecutionDetails method: GET uri: /dna/intent/api/v1/dnacaap/management/execution-status/{executionId} api_version: 2.3.7.9 description: Retrieves the execution details of a Business API parameters: - executionId required: - executionId - name: api_getCMDBSyncStatus method: GET uri: /dna/intent/api/v1/cmdb-sync/detail api_version: 2.3.7.9 description: This API allows to retrieve the detail of CMDB sync status.It accepts two query parameter "status","date".The supported values for status field are "Success","Failed","Unknown" and date field should be in "YYYY-MM-DD" fo parameters: - date - status required: [] - name: api_getChassisDetailsForDevice method: GET uri: /dna/intent/api/v1/network-device/{deviceId}/chassis api_version: 2.3.7.9 description: Returns chassis details for given device ID parameters: - deviceId required: - deviceId - name: api_getCleanAirConfigurationFeatureTemplate method: GET uri: /dna/intent/api/v1/featureTemplates/wireless/cleanAirConfigurations/{id} api_version: 2.3.7.9 description: This API allows users to retrieve a specific Clean Air configuration feature template by ID. parameters: - id required: - id - name: api_getClientDetail method: GET uri: /dna/intent/api/v1/client-detail api_version: 2.3.7.9 description: Returns detailed Client information retrieved by Mac Address for any given point of time. parameters: - macAddress - timestamp required: - macAddress - name: api_getClientEnergyByID method: GET uri: /dna/data/api/v1/energy/clients/{id} api_version: 2.3.7.9 description: Retrieves client device energy data for a specified time range based on the client ID. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-e parameters: - X-CALLER-ID - attribute - endTime - id - startTime - view required: - id - name: api_getClientEnrichmentDetails method: GET uri: /dna/intent/api/v1/client-enrichment-details api_version: 2.3.7.9 description: Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user, the devices that the user is connected to and the assurance issues that the user is impacted by parameters: - entity_type - entity_value - issueCategory required: - entity_type - entity_value - name: api_getClientEnrichmentDetailsV2 method: GET uri: /dna/intent/api/v2/client-enrichment-details api_version: 2.3.7.10 description: Retrieve Catalyst Center client enrichment context for a known network user identifier or endpoint MAC address. Use this release-specific OpenAPI enrichment endpoint when the request is about enriched client context, ass parameters: - entity_type - entity_value - issueCategory required: - entity_type - entity_value - name: api_getClientsEnergy method: GET uri: /dna/data/api/v1/energy/clients api_version: 2.3.7.9 description: Retrieves a list of client devices with energy data based on the specified query parameters. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/c parameters: - X-CALLER-ID - attribute - cursor - deviceCategory - deviceSubCategory - endTime - id - limit - order - siteHierarchy - siteHierarchyId - siteId - sortBy - startTime - view required: [] - name: api_getComplianceDetail method: GET uri: /dna/intent/api/v1/compliance/detail api_version: 2.3.7.9 description: 'LIST, SHOW, or IDENTIFY which specific devices are compliant or non-compliant. Returns detailed device compliance records including compliance type, status, state, last sync/update time, and remediation support. NOT for' parameters: - complianceStatus - complianceType - deviceUuid - limit - offset required: - limit - complianceStatus - name: api_getComplianceDetailCount method: GET uri: /dna/intent/api/v1/compliance/detail/count api_version: 2.3.7.9 description: '"Count NON_COMPLIANT devices for RUNNING_CONFIG" "How many non-compliant for RUNNING_CONFIG?" "How many non-compliant for IMAGE?" "Count NON_COMPLIANT for NETWORK_PROFILE" "Count non-compliant devices for PSIRT" "How man' parameters: - complianceStatus - complianceType required: - complianceStatus - name: api_getComplianceStatus method: GET uri: /dna/intent/api/v1/compliance api_version: 2.3.7.9 description: This tool retrieves high-level device-level compliance status records for all devices or specific device(s). Use this tool when the user asks for the compliance status/state of a device, or asks to list actual device com parameters: - complianceStatus - deviceUuid - limit - offset required: - limit - complianceStatus - name: api_getComplianceStatusCount method: GET uri: /dna/intent/api/v1/compliance/count api_version: 2.3.7.9 description: '"How many devices are compliant?" "How many devices are non-compliant?" "Count of compliant devices" "Total non-compliant devices" — USE THIS API for all these questions. This API returns the TRUE TOTAL count of devices' parameters: - complianceStatus required: - complianceStatus - name: api_getConfigTaskDetails method: GET uri: /dna/intent/api/v1/network-device-config/task api_version: 2.3.7.9 description: Returns a config task result details by specified id parameters: - parentTaskId required: - parentTaskId - name: api_getConfigurationArchiveDetails method: GET uri: /dna/intent/api/v1/network-device-config api_version: 2.3.7.9 description: '**Use Cases - Pick this tool for ANY of these question types about a device''s configuration archive / archive history / configuration changes / config drift:** - "When was the last archive of device X?" / "latest archive' parameters: - createdBy - createdTime - deviceId - fileType - limit - offset required: [] - name: api_getConfigurationFileDetailsByID method: GET uri: /dna/intent/api/v1/networkDeviceConfigFiles/{id} api_version: 2.3.7.9 description: Retrieves the details of a specific network device configuration file using the `id`. parameters: - id required: - id - name: api_getConfigurationsForADeployedLayer2FeatureOnAWiredDevice method: GET uri: /dna/intent/api/v1/wired/networkDevices/{id}/configFeatures/deployed/layer2/{feature} api_version: 2.3.7.9 description: The API returns configurations for a deployed layer 2 feature on a wired device. parameters: - feature - id required: - id - feature - name: api_getConfigurationsForAnIntendedLayer2FeatureOnAWiredDevice method: GET uri: /dna/intent/api/v1/wired/networkDevices/{id}/configFeatures/intended/layer2/{feature} api_version: 2.3.7.9 description: This API returns the configurations for an intended layer 2 feature on a wired device. Even after the intended configurations are deployed using the API /dna/intent/api/v1/networkDevices/{id}/configFeatures/intended/depl parameters: - feature - id required: - id - feature - name: api_getConfigurationsForIntendedLayer2FeaturesOnAWiredDevice method: GET uri: /dna/intent/api/v1/intent/api/v1/wired/networkDevices/{id}/configFeatures/intended/layer2 api_version: 2.3.7.9 description: This API returns the configurations for the intended layer 2 features on a wired device. Even after the intended configurations are deployed using the API /intent/api/v1/networkDevices/{id}/configFeatures/intended/deploy parameters: - feature - id required: - id - feature - name: api_getConnectedDeviceDetail method: GET uri: /dna/intent/api/v1/network-device/{deviceUuid}/interface/{interfaceUuid}/neighbor api_version: 2.3.7.9 description: '**Tool Dependency: IMPORTANT** This tool retrieves neighbor device details for a SPECIFIC device and interface. Use this tool when user asks for neighbor/connected device information on a particular interface. The respo' parameters: - deviceUuid - interfaceUuid required: - deviceUuid - interfaceUuid - name: api_getConnectorTypes method: GET uri: /dna/system/api/v1/event/config/connector-types api_version: 2.3.7.9 description: Get the list of connector types parameters: [] required: [] - name: api_getCountOfAllDiscoveryJobs method: GET uri: /dna/intent/api/v1/discovery/count api_version: 2.3.7.9 description: Returns the count of all available discovery jobs parameters: [] required: [] - name: api_getCountOfAnchorGroups method: GET uri: /dna/intent/api/v1/wirelessSettings/anchorGroups/count api_version: 2.3.7.9 description: This API allows the user to get count of all AnchorGroups parameters: [] required: [] - name: api_getCountOfBugsAffectingTheNetworkDevice method: GET uri: /dna/intent/api/v1/networkBugs/results/networkDevices/{networkDeviceId}/bugs/count api_version: 2.3.7.9 description: Get count of bugs affecting the network device parameters: - id - networkDeviceId - severity required: - networkDeviceId - name: api_getCountOfFieldNoticeNetworkDevices method: GET uri: /dna/intent/api/v1/fieldNotices/results/networkDevices/count api_version: 2.3.7.9 description: Return only the COUNT of network devices matching field-notice scan criteria. Use this tool only when the user explicitly asks for a count, number, or 'how many' devices, such as 'How many devices have field notices?' or parameters: - networkDeviceId - noticeCount - scanStatus required: [] - name: api_getCountOfFieldNoticeNetworkDevicesForTheNotice method: GET uri: /dna/intent/api/v1/fieldNotices/results/notices/{id}/networkDevices/count api_version: 2.3.7.9 description: Get count of field notice network devices for the notice parameters: - id - networkDeviceId - scanStatus required: - id - name: api_getCountOfFieldNotices method: GET uri: /dna/intent/api/v1/fieldNotices/results/notices/count api_version: 2.3.7.9 description: Get the count of confirmed field notices. Use this tool for questions like 'how many field notices do I have?' or 'how many total field notices are detected?'. For unqualified in-my-network or detected field notice count parameters: - deviceCount - id - type required: [] - name: api_getCountOfFieldNoticesAffectingTheNetworkDevice method: GET uri: /dna/intent/api/v1/fieldNotices/results/networkDevices/{networkDeviceId}/notices/count api_version: 2.3.7.9 description: 'Get the count of confirmed field notices affecting a network device. Use this after resolving the device id for questions like ''how many notices affect this device?''. Return only the confirmed field notice count. Do not ' parameters: - id - networkDeviceId - type required: - networkDeviceId - name: api_getCountOfFieldNoticesResultsTrendOverTime method: GET uri: /dna/intent/api/v1/fieldNotices/resultsTrend/count api_version: 2.3.7.9 description: Get count of field notices results trend over time parameters: - scanTime required: [] - name: api_getCountOfNetworkBugDevices method: GET uri: /dna/intent/api/v1/networkBugs/results/networkDevices/count api_version: 2.3.7.9 description: Get the count of network devices that have network bugs detected by the network bug scan. Use this count tool for questions like 'how many devices have bugs?', 'count devices with network bugs', 'how many devices have fa parameters: - bugCount - networkDeviceId - scanMode - scanStatus required: [] - name: api_getCountOfNetworkBugDevicesForTheBug method: GET uri: /dna/intent/api/v1/networkBugs/results/bugs/{id}/networkDevices/count api_version: 2.3.7.9 description: 'Get the count of network devices affected or impacted by a specific network bug ID. Use this tool for questions like ''how many devices are impacted by CSCwd12345?'' or ''count devices affected by bug CSCwr77118''. A CSC ID ' parameters: - id - networkDeviceId - scanMode - scanStatus required: - id - name: api_getCountOfNetworkBugs method: GET uri: /dna/intent/api/v1/networkBugs/results/bugs/count api_version: 2.3.7.9 description: Get the count of detected network bugs affecting devices in the network. Use this count tool for questions like 'how many network bugs do I have?', 'how many bugs are detected?', 'how many total network bugs are detected parameters: - deviceCount - id - severity required: [] - name: api_getCountOfNetworkBugsResultsTrendOverTime method: GET uri: /dna/intent/api/v1/networkBugs/resultsTrend/count api_version: 2.3.7.9 description: Get count of network bugs results trend over time parameters: - scanTime required: [] - name: api_getCountOfProfilingRules method: GET uri: /dna/intent/api/v1/endpoint-analytics/profiling-rules/count api_version: 2.3.7.9 description: This API fetches the count of profiling rules based on the filter values provided in the query parameters. The filter parameters are same as that of 'GET /profiling-rules' API, excluding the pagination and sort parameter parameters: - includeDeleted - ruleType required: [] - name: api_getCountOfSecurityAdvisoriesAffectingTheNetworkDevice method: GET uri: /dna/intent/api/v1/securityAdvisories/results/networkDevices/{networkDeviceId}/advisories/count api_version: 2.3.7.9 description: '**Tool Dependency: CRITICAL** This tool retrieves the COUNT of security advisories, PSIRTs, and vulnerabilities affecting a specific network device. It can be called in two ways: 1. **With networkDeviceId only**: Retur' parameters: - cvssBaseScore - id - networkDeviceId - securityImpactRating required: - networkDeviceId - name: api_getCountOfSecurityAdvisoriesAffectingTheNetworkDevices method: GET uri: /dna/intent/api/v1/securityAdvisories/results/advisories/count api_version: 2.3.7.9 description: 'Return the total count of security advisories, PSIRTs, and vulnerabilities affecting all devices in the network. Use this API to answer questions like ''How many security advisories affected the devices?'' or ''What is the ' parameters: - cvssBaseScore - deviceCount - id - securityImpactRating required: [] - name: api_getCountOfSecurityAdvisoriesResultsTrendOverTime method: GET uri: /dna/intent/api/v1/securityAdvisories/resultsTrend/count api_version: 2.3.7.9 description: Get count of security advisories results trend over time. parameters: - scanTime required: [] - name: api_getCountOfSecurityAdvisoryNetworkDevices method: GET uri: /dna/intent/api/v1/securityAdvisories/results/networkDevices/count api_version: 2.3.7.9 description: Get count of security advisory network devices parameters: - advisoryCount - networkDeviceId - scanMode - scanStatus required: [] - name: api_getCountOfSecurityAdvisoryNetworkDevicesForTheSecur_ffbe1ab0 method: GET uri: /dna/intent/api/v1/securityAdvisories/results/advisories/{id}/networkDevices/count api_version: 2.3.7.9 description: Return the count of network devices affected by a specific security advisory, PSIRT, or vulnerability. Use this API to answer questions like 'Count of devices that are affected by the security advisory cisco-sa-20160525- parameters: - id - networkDeviceId - scanMode - scanStatus required: - id - name: api_getDetailsOfASingleAssuranceEvent method: GET uri: /dna/data/api/v1/assuranceEvents/{id} api_version: 2.3.7.9 description: API to fetch the details of an assurance event using event `id`. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/cata parameters: - X-CALLER-ID - attribute - id - view required: - id - name: api_getDetailsOfASingleNetworkDevice method: GET uri: /dna/intent/api/v1/networkDevices/{id} api_version: 2.3.7.9 description: API to fetch the details of network device using the `id`. Use the `/dna/intent/api/v1/networkDevices/query` API for advanced filtering. The API supports views to fetch only the required fields. Refer features for more d parameters: - id - views required: - id - name: api_getDetailsOfASingleProfilingRule method: GET uri: /dna/intent/api/v1/endpoint-analytics/profiling-rules/{ruleId} api_version: 2.3.7.9 description: Fetches details of the profiling rule for the given 'ruleId'. parameters: - ruleId required: - ruleId - name: api_getDeviceByID method: GET uri: /dna/intent/api/v1/network-device/{id} api_version: 2.3.7.9 description: Returns the network device details for the given device ID parameters: - id required: - id - name: api_getDeviceBySerialNumber method: GET uri: /dna/intent/api/v1/network-device/serial-number/{serialNumber} api_version: 2.3.7.9 description: Returns the network device with given serial number parameters: - serialNumber required: - serialNumber - name: api_getDeviceConfigById method: GET uri: /dna/intent/api/v1/network-device/{networkDeviceId}/config api_version: 2.3.7.9 description: Returns the device config by specified device ID parameters: - networkDeviceId required: - networkDeviceId - name: api_getDeviceConfigCount method: GET uri: /dna/intent/api/v1/network-device/config/count api_version: 2.3.7.9 description: Returns the count of device configs parameters: [] required: [] - name: api_getDeviceControllabilitySettings method: GET uri: /dna/intent/api/v1/networkDevices/deviceControllability/settings api_version: 2.3.7.9 description: Device Controllability is a system-level process on Catalyst Center that enforces state synchronization for some device-layer features. Its purpose is to aid in the deployment of required network settings that Catalyst C parameters: [] required: [] - name: api_getDeviceCredentialSettingsForASite method: GET uri: /dna/intent/api/v1/sites/{id}/deviceCredentials api_version: 2.3.7.9 description: '**Tool Dependency: CRITICAL** This tool retrieves the device credential settings configured for a site. It returns credential ID references only — **NOT** the actual credential details. You **MUST ALWAYS** resolve every' parameters: - _inherited - id required: - id - _inherited - name: api_getDeviceDeploymentStatus method: GET uri: /dna/intent/api/v1/wired/networkDevices/{networkDeviceId}/configFeatures/intended/deviceDeployments api_version: 2.3.7.9 description: Returns device deployment status based on filter criteria. parameters: - networkDeviceId required: - networkDeviceId - name: api_getDeviceDeploymentStatusCount method: GET uri: /dna/intent/api/v1/icapSettings/deviceDeployments/count api_version: 2.3.7.9 description: Returns the count of device deployment status(s) based on filter criteria. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmab parameters: - deployActivityId - networkDeviceIds required: [] - name: api_getDeviceEnergyByID method: GET uri: /dna/data/api/v1/energy/networkDevices/{id} api_version: 2.3.7.9 description: Retrieves network device energy data for a specified time range based on the device ID. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco- parameters: - X-CALLER-ID - attribute - endTime - id - startTime - view required: - id - name: api_getDeviceEnrichmentDetailsV2 method: GET uri: /dna/intent/api/v2/device-enrichment-details api_version: 2.3.7.10 description: Retrieve Catalyst Center network device enrichment context for a known device ID, device MAC address, or device management IP address. Use this release-specific OpenAPI enrichment endpoint when the request is about enric parameters: - entity_type - entity_value required: - entity_type - entity_value - name: api_getDeviceHistory method: GET uri: /dna/intent/api/v1/onboarding/pnp-device/history api_version: 2.3.7.9 description: Returns history for a specific device. Serial number is a required parameter parameters: - serialNumber - sort - sortOrder required: - serialNumber - name: api_getDeviceInterfaceCount method: GET uri: /dna/intent/api/v1/interface/network-device/{deviceId}/count api_version: 2.3.7.9 description: Returns the interface count for the given device parameters: - deviceId required: - deviceId - name: api_getDeviceInterfaceVLANs method: GET uri: /dna/intent/api/v1/network-device/{id}/vlan api_version: 2.3.7.9 description: Returns Device Interface VLANs. If parameter value is null or empty, it won't return any value in response. parameters: - id - interfaceType required: - id - name: api_getDeviceInterfacesBySpecifiedRange method: GET uri: /dna/intent/api/v1/interface/network-device/{deviceId}/{startIndex}/{recordsToReturn} api_version: 2.3.7.9 description: Returns the list of interfaces for the device for the specified range parameters: - deviceId - recordsToReturn - startIndex required: - deviceId - startIndex - recordsToReturn - name: api_getDeviceSummary method: GET uri: /dna/intent/api/v1/network-device/{id}/brief api_version: 2.3.7.9 description: Returns brief summary of device info for the given device Id parameters: - id required: - id - name: api_getDeviceValuesThatMatchFullyOrPartiallyAnAttribute method: GET uri: /dna/intent/api/v1/network-device/autocomplete api_version: 2.3.7.9 description: 'Returns the list of values of the first given required parameter. You can use the .* in any value to conduct a wildcard search. For example, to get all the devices with the management IP address starting with 10.10. , is' parameters: - associatedWlcIp - collectionInterval - collectionStatus - errorCode - family - hostname - limit - macAddress - managementIpAddress - offset - platformId - reachabilityFailureReason - reachabilityStatus - role - roleSource - serialNumber - series - softwareType - softwareVersion - type - upTime - vrfName required: [] - name: api_getDevicesDiscoveredById method: GET uri: /dna/intent/api/v1/discovery/{id}/network-device/count api_version: 2.3.7.9 description: Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the "Get Discoveries by range" API. parameters: - id - taskId required: - id - name: api_getDevicesEnergy method: GET uri: /dna/data/api/v1/energy/networkDevices api_version: 2.3.7.9 description: Retrieves a list of network devices with energy data based on the specified query parameters. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/ parameters: - X-CALLER-ID - attribute - cursor - deviceCategory - deviceSubCategory - endTime - id - limit - order - siteHierarchy - siteHierarchyId - siteId - sortBy - startTime - view required: [] - name: api_getDevicesRegisteredForWSANotification method: GET uri: /dna/intent/api/v1/network-device/tenantinfo/macaddress api_version: 2.3.7.9 description: It fetches devices which are registered to receive WSA notifications. The device serial number and/or MAC address are required to be provided as query parameters. parameters: - macaddress - serialNumber required: [] - name: api_getDiscoveredDevicesByRange method: GET uri: /dna/intent/api/v1/discovery/{id}/network-device/{startIndex}/{recordsToReturn} api_version: 2.3.7.9 description: Returns the network devices discovered for the given discovery and for the given range. The maximum number of records that can be retrieved is 500. Discovery ID can be obtained using the "Get Discoveries by range" API. parameters: - id - recordsToReturn - startIndex - taskId required: - id - startIndex - recordsToReturn - name: api_getDiscoveredNetworkDevicesByDiscoveryId method: GET uri: /dna/intent/api/v1/discovery/{id}/network-device api_version: 2.3.7.9 description: Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the "Get Discoveries by range" API. parameters: - id - taskId required: - id - name: api_getDiscoveriesByRange method: GET uri: /dna/intent/api/v1/discovery/{startIndex}/{recordsToReturn} api_version: 2.3.7.9 description: Returns the discoveries by specified range parameters: - recordsToReturn - startIndex required: - startIndex - recordsToReturn - name: api_getDiscoveryById method: GET uri: /dna/intent/api/v1/discovery/{id} api_version: 2.3.7.9 description: Returns discovery by Discovery ID. Discovery ID can be obtained using the "Get Discoveries by range" API. parameters: - id required: - id - name: api_getDiscoveryJobsByIP method: GET uri: /dna/intent/api/v1/discovery/job api_version: 2.3.7.9 description: Returns the list of discovery jobs for the given IP parameters: - ipAddress - limit - name - offset required: - ipAddress - name: api_getDot11axConfigurationFeatureTemplate method: GET uri: /dna/intent/api/v1/featureTemplates/wireless/dot11axConfigurations/{id} api_version: 2.3.7.9 description: This API allows users to retrieve a specific Dot11ax configuration feature template by ID. parameters: - id required: - id - name: api_getDot11beStatusConfigurationFeatureTemplate method: GET uri: /dna/intent/api/v1/featureTemplates/wireless/dot11beStatusConfigurations/{id} api_version: 2.3.7.9 description: This API allows users to retrieve a specific Dot11be status configuration feature template by ID. parameters: - id required: - id - name: api_getEmailDestination method: GET uri: /dna/intent/api/v1/event/email-config api_version: 2.3.7.9 description: Get Email Destination parameters: [] required: [] - name: api_getEmailEventSubscriptions method: GET uri: /dna/intent/api/v1/event/subscription/email api_version: 2.3.7.9 description: Gets the list of email Subscriptions's based on provided query params parameters: - category - domain - eventIds - limit - name - offset - order - sortBy - subDomain - type required: [] - name: api_getEmailSubscriptionDetails method: GET uri: /dna/intent/api/v1/event/subscription-details/email api_version: 2.3.7.9 description: Gets the list of subscription details for specified connectorType parameters: - instanceId - limit - name - offset - order - sortBy required: [] - name: api_getEndpointDetails method: GET uri: /dna/intent/api/v1/endpoint-analytics/endpoints/{epId} api_version: 2.3.7.9 description: Fetches details of the endpoint for the given unique identifier 'epId'. parameters: - epId - include required: - epId - name: api_getEoXDetailsPerDevice method: GET uri: /dna/intent/api/v1/eox-status/device/{deviceId} api_version: 2.3.7.9 description: '**MANDATORY PREREQUISITE:** For site-scoped EOX queries, you MUST call `api_getSites` before `get_device_details`, and you MUST call `get_device_details` before `api_getEoXDetailsPerDevice`. **Steps:** 1. Call `api_getS' parameters: - deviceId required: - deviceId - name: api_getEoXStatusForAllDevices method: GET uri: /dna/intent/api/v1/eox-status/device api_version: 2.3.7.9 description: Use this API for network-wide, device-level retrieval of EOX information when the user wants to display, list, fetch, report, review, or enumerate EOX alerts or EOX status across all devices, every device, or all network parameters: - limit - offset required: [] - name: api_getEoXSummary method: GET uri: /dna/intent/api/v1/eox-status/summary api_version: 2.3.7.9 description: Retrieves EoX summary for all devices in the network parameters: [] required: [] - name: api_getEventArtifacts method: GET uri: /dna/system/api/v1/event/artifact api_version: 2.3.7.9 description: Gets the list of artifacts based on provided offset and limit parameters: - eventIds - limit - offset - order - search - sortBy - tags required: [] - name: api_getEventDrivenRRMConfigurationFeatureTemplate method: GET uri: /dna/intent/api/v1/featureTemplates/wireless/eventDrivenRRMConfigurations/{id} api_version: 2.3.7.9 description: This API allows users to retrieve a specific Event Driven RRM configuration feature template by ID. parameters: - id required: - id - name: api_getEventSubscriptions method: GET uri: /dna/intent/api/v1/event/subscription api_version: 2.3.7.9 description: Gets the list of all event subscriptions regardless of connector type (REST/Webhook, Email, Syslog, etc.). Use this tool when the user asks for all subscriptions, subscription details, or wants to see configured event su parameters: - eventIds - limit - offset - order - sortBy required: [] - name: api_getEvents method: GET uri: /dna/intent/api/v1/events api_version: 2.3.7.9 description: Gets the list of registered Events with provided eventIds or tags as mandatory parameters: - eventId - limit - offset - order - sortBy - tags required: - tags - name: api_getExecutionIdByReportId method: GET uri: /dna/data/api/v1/flexible-report/report/{reportId}/executions api_version: 2.3.7.9 description: Get Execution Id by Report Id parameters: - Content-Type - reportId required: - Content-Type - reportId - name: api_getExternalAuthenticationServersAPI method: GET uri: /dna/system/api/v1/users/external-servers api_version: 2.3.7.9 description: Get external users authentication servers. parameters: - invokeSource required: - invokeSource - name: api_getExternalAuthenticationSettingAPI method: GET uri: /dna/system/api/v1/users/external-authentication api_version: 2.3.7.9 description: Get the External Authentication setting. parameters: [] required: [] - name: api_getFailedITSMEvents method: GET uri: /dna/intent/api/v1/integration/events api_version: 2.3.7.9 description: Used to retrieve the list of integration events that failed to create tickets in ITSM parameters: - instanceId required: [] - name: api_getFeatureTemplateSummary method: GET uri: /dna/intent/api/v1/featureTemplates/wireless/summary api_version: 2.3.7.9 description: This API allows users to retrieve the feature template summary. parameters: - designName - limit - offset - systemTemplate - type required: [] - name: api_getFieldNoticeAffectingTheNetworkDeviceByDeviceIdAndNoticeId method: GET uri: /dna/intent/api/v1/fieldNotices/results/networkDevices/{networkDeviceId}/notices/{id} api_version: 2.3.7.9 description: Get field notice affecting the network device by device Id and notice id parameters: - id - networkDeviceId required: - networkDeviceId - id - name: api_getFieldNoticeById method: GET uri: /dna/intent/api/v1/fieldNotices/results/notices/{id} api_version: 2.3.7.9 description: 'Return details for one specific field notice by its exact id. Use this tool whenever the user asks about one specific field notice itself. This tool returns notice metadata such as id, name, publicationUrl, deviceCount, ' parameters: - id required: - id - name: api_getFieldNoticeNetworkDeviceByDeviceId method: GET uri: /dna/intent/api/v1/fieldNotices/results/networkDevices/{networkDeviceId} api_version: 2.3.7.9 description: Get field notice scan summary for one network device by device id. User-facing answers must not show raw networkDeviceId values unless the user explicitly asks for internal UUIDs. If presenting the device name or managem parameters: - networkDeviceId required: - networkDeviceId - name: api_getFieldNoticeNetworkDeviceForTheNoticeByNetworkDeviceId method: GET uri: /dna/intent/api/v1/fieldNotices/results/notices/{id}/networkDevices/{networkDeviceId} api_version: 2.3.7.9 description: Get one network device record for a specific field notice by notice id and network device id. User-facing answers must not show raw networkDeviceId values unless the user explicitly asks for internal UUIDs. If presenting parameters: - id - networkDeviceId required: - id - networkDeviceId - name: api_getFieldNoticeNetworkDevices method: GET uri: /dna/intent/api/v1/fieldNotices/results/networkDevices api_version: 2.3.7.9 description: Returns field notice network devices. Use this tool for questions such as 'What devices have field notices?', 'Show devices scanned for field notices.', 'Give devices with more than N notices.', 'List devices with notice parameters: - limit - networkDeviceId - noticeCount - offset - order - scanStatus - sortBy required: [] - name: api_getFieldNoticeNetworkDevicesForTheNotice method: GET uri: /dna/intent/api/v1/fieldNotices/results/notices/{id}/networkDevices api_version: 2.3.7.9 description: 'Get network devices for a specific field notice. Use this tool when the user asks which devices are affected by a specific field notice id. User-facing answers must not show raw networkDeviceId values. MANDATORY POST-PR' parameters: - id - limit - networkDeviceId - offset - order - scanStatus - sortBy required: - id - name: api_getFieldNotices method: GET uri: /dna/intent/api/v1/fieldNotices/results/notices api_version: 2.3.7.9 description: Get confirmed field notices. Use this tool for questions that ask which field notices exist or which notices have affected devices. For unqualified in-my-network or detected field notice list questions, call this tool wi parameters: - deviceCount - id - limit - offset - order - sortBy - type required: [] - name: api_getFieldNoticesAffectingTheNetworkDevice method: GET uri: /dna/intent/api/v1/fieldNotices/results/networkDevices/{networkDeviceId}/notices api_version: 2.3.7.9 description: Get confirmed field notices affecting a network device. Use this tool after resolving the device id when the user asks which field notices affect a specific device. In final answers, show only confirmed field notices and parameters: - id - limit - networkDeviceId - offset - order - sortBy - type required: - networkDeviceId - name: api_getFieldNoticesResultsTrendOverTime method: GET uri: /dna/intent/api/v1/fieldNotices/resultsTrend api_version: 2.3.7.9 description: Get field notices results trend over time. The default sort is by scan time descending. parameters: - limit - offset - scanTime required: [] - name: api_getFlexConnectConfigurationFeatureTemplate method: GET uri: /dna/intent/api/v1/featureTemplates/wireless/flexConnectConfigurations/{id} api_version: 2.3.7.9 description: This API allows users to retrieve a specific Flex Connect configuration feature template by ID. parameters: - id required: - id - name: api_getFlexibleReportScheduleByReportId method: GET uri: /dna/data/api/v1/flexible-report/schedule/{reportId} api_version: 2.3.7.9 description: Get flexible report schedule by report id parameters: - Content-Type - reportId required: - Content-Type - reportId - name: api_getFloorSettings method: GET uri: /dna/intent/api/v2/floors/settings api_version: 2.3.7.9 description: Gets UI user preference for floor unit system. parameters: [] required: [] - name: api_getFunctionalCapabilityById method: GET uri: /dna/intent/api/v1/network-device/functional-capability/{id} api_version: 2.3.7.9 description: Returns functional capability with given Id parameters: - id required: - id - name: api_getFunctionalCapabilityForDevices method: GET uri: /dna/intent/api/v1/network-device/functional-capability api_version: 2.3.7.9 description: Returns the functional-capability for given devices parameters: - deviceId - functionName required: - deviceId - name: api_getGlobalCredentials method: GET uri: /dna/intent/api/v1/global-credential api_version: 2.3.7.9 description: Get credentials by type. Returns CLI, SNMP read, SNMP write, SNMPv3, HTTP read, HTTP write, or NETCONF credentials. parameters: - credentialSubType - order - sortBy required: - credentialSubType - name: api_getHealthScoreDefinitionForTheGivenId method: GET uri: /dna/intent/api/v1/healthScoreDefinitions/{id} api_version: 2.3.7.9 description: Get health score defintion for the given id. Definition includes all properties from HealthScoreDefinition schema by default. For detailed information about the usage of the API, please refer to the Open API specificatio parameters: - X-CALLER-ID - id required: - id - name: api_getICAPConfigurationStatusPerNetworkDevice method: GET uri: /dna/intent/api/v1/icapSettings/configurationModels/{previewActivityId}/networkDeviceStatusDetails api_version: 2.3.7.9 description: Get ICAP configuration status per network device using the activity ID, which was returned in property "taskId" of the TaskResponse of the POST. For detailed information about the usage of the API, please refer to the Op parameters: - previewActivityId required: - previewActivityId - name: api_getISISInterfaces method: GET uri: /dna/intent/api/v1/interface/isis api_version: 2.3.7.9 description: Returns the interfaces that has ISIS enabled parameters: [] required: [] - name: api_getITSMIntegrationSettingById method: GET uri: /dna/intent/api/v1/integration-settings/instances/itsm/{instanceId} api_version: 2.3.7.9 description: Fetches ITSM Integration setting by ID parameters: - instanceId required: - instanceId - name: api_getITSMIntegrationStatus method: GET uri: /dna/intent/api/v1/integration-settings/status api_version: 2.3.7.9 description: Fetches ITSM Integration status and also lists the bundles as needed, along with their configurations. Used mainly to check the status of the bundles. It is capable answering questions like What is the status of X bundle parameters: [] required: [] - name: api_getInterfaceByIP method: GET uri: /dna/intent/api/v1/interface/ip-address/{ipAddress} api_version: 2.3.7.9 description: Returns list of interfaces for specified device management IP address parameters: - ipAddress required: - ipAddress - name: api_getInterfaceById method: GET uri: /dna/intent/api/v1/interface/{id} api_version: 2.3.7.9 description: Returns the interface for the given interface ID parameters: - id required: - id - name: api_getInterfaces method: GET uri: /dna/intent/api/v1/wirelessSettings/interfaces api_version: 2.3.7.9 description: '**TAG PHRASE EXCLUSION:** - If the user asks for ports or interfaces `tagged`, `with tag`, `under tag `, or `in tag `, do not treat `` as an interface name, port name, device name, site name,' parameters: - interfaceName - limit - offset - vlanId required: [] - name: api_getInterfacesCount method: GET uri: /dna/intent/api/v1/intent/api/v1/wirelessSettings/interfaces/count api_version: 2.3.7.9 description: This API allows the user to get count of all interfaces. parameters: [] required: [] - name: api_getIssueEnrichmentDetails method: GET uri: /dna/intent/api/v1/issue-enrichment-details api_version: 2.3.7.9 description: Enriches a given network issue context (an issue id or end user’s Mac Address) with details about the issue(s), impacted hosts and suggested actions for remediation parameters: - entity_type - entity_value required: - entity_type - entity_value - name: api_getIssueEnrichmentDetailsV2 method: GET uri: /dna/intent/api/v2/issue-enrichment-details api_version: 2.3.7.10 description: Retrieve Catalyst Center issue enrichment context for a known issue identifier or client MAC address. Use this release-specific OpenAPI enrichment endpoint when the request is about enriched issue context, impacted hosts parameters: - entity_type - entity_value required: - entity_type - entity_value - name: api_getIssueTriggerDefinitionForGivenId method: GET uri: /dna/intent/api/v1/systemIssueDefinitions/{id} api_version: 2.3.7.9 description: Get system issue defintion for the given id. Definition includes all properties from IssueTriggerDefinition schema by default. For detailed information about the usage of the API, please refer to the Open API specificati parameters: - X-CALLER-ID - id required: - id - name: api_getL3TopologyDetails method: GET uri: /dna/intent/api/v1/topology/l3/{topologyType} api_version: 2.3.7.9 description: Returns the Layer 3 network topology by routing protocol parameters: - topologyType required: - topologyType - name: api_getLinecardDetails method: GET uri: /dna/intent/api/v1/network-device/{deviceUuid}/line-card api_version: 2.3.7.9 description: Get line card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. parameters: - deviceUuid required: - deviceUuid - name: api_getListOfAvailableNamespaces method: GET uri: /dna/intent/api/v1/file/namespace api_version: 2.3.7.9 description: Returns list of available namespaces parameters: [] required: [] - name: api_getListOfChildEventsForTheGivenWirelessClientEvent method: GET uri: /dna/data/api/v1/assuranceEvents/{id}/childEvents api_version: 2.3.7.9 description: Wireless client event could have child events and this API can be used to fetch the same using parent event `id` as the input. For detailed information about the usage of the API, please refer to the Open API specificati parameters: - X-CALLER-ID - id required: - id - name: api_getListOfDiscoveriesByDiscoveryId method: GET uri: /dna/intent/api/v1/discovery/{id}/job api_version: 2.3.7.9 description: Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the "Get Discoveries by range" API. parameters: - id - ipAddress - limit - offset required: - id - name: api_getListOfProfilingRules method: GET uri: /dna/intent/api/v1/endpoint-analytics/profiling-rules api_version: 2.3.7.9 description: This API fetches the list of profiling rules. It can be used to show profiling rules in client applications, or export those from an environment. 'POST /profiling-rules/bulk' API can be used to import such exported rules parameters: - includeDeleted - limit - offset - order - ruleType - sortBy required: [] - name: api_getListOfScheduledReports method: GET uri: /dna/intent/api/v1/data/reports api_version: 2.3.7.9 description: Get list of scheduled report configurations. parameters: - viewGroupId - viewId required: [] - name: api_getManagedAPLocationsCountForSpecificWirelessController method: GET uri: /dna/intent/api/v1/wirelessControllers/{networkDeviceId}/managedApLocations/count api_version: 2.3.7.9 description: For Managed AP location count queries, always return the requested category counts and an explicit combined total. For "primary and secondary" queries, return Primary count, Secondary count, and Total (Primary+Secondary) parameters: - networkDeviceId required: - networkDeviceId - name: api_getMeshApNeighbours method: GET uri: /dna/intent/api/v1/wirelessControllers/meshApNeighbours api_version: 2.3.7.9 description: Retrieves all Mesh accesspoint Neighbours details whether child, parent, etc. parameters: - apName - ethernetMacAddress - wlcIpAddress required: [] - name: api_getMeshApNeighboursCount method: GET uri: /dna/intent/api/v1/wirelessControllers/meshApNeighbours/count api_version: 2.3.7.9 description: This API returns the total number of mesh Ap Neighbours available. parameters: [] required: [] - name: api_getMobilityGroups method: GET uri: /dna/intent/api/v1/wirelessControllers/wirelessMobilityGroups api_version: 2.3.7.9 description: Retrieve configured mobility groups if no Network Device Id is provided as a query parameter. If a Network Device Id is given and a mobility group is configured for it, return the configured details; otherwise, return th parameters: - networkDeviceId required: [] - name: api_getMobilityGroupsCount method: GET uri: /dna/intent/api/v1/wirelessControllers/wirelessMobilityGroups/count api_version: 2.3.7.9 description: Retrieves count of mobility groups configured parameters: [] required: [] - name: api_getModuleCount method: GET uri: /dna/intent/api/v1/network-device/module/count api_version: 2.3.7.9 description: Returns Module Count parameters: - deviceId - nameList - operationalStateCodeList - partNumberList - vendorEquipmentTypeList required: - deviceId - name: api_getModuleInfoById method: GET uri: /dna/intent/api/v1/network-device/module/{id} api_version: 2.3.7.9 description: Returns Module info by 'module id' parameters: - id required: - id - name: api_getModules method: GET uri: /dna/intent/api/v1/network-device/module api_version: 2.3.7.9 description: Returns modules by specified device id. The API returns a paginated response based on 'limit' and 'offset' parameters, allowing up to 500 records per page. 'limit' specifies the number of records, and 'offset' sets the s parameters: - deviceId - limit - nameList - offset - operationalStateCodeList - partNumberList - vendorEquipmentTypeList required: - deviceId - name: api_getMulticastConfigurationFeatureTemplate method: GET uri: /dna/intent/api/v1/featureTemplates/wireless/multicastConfigurations/{id} api_version: 2.3.7.9 description: This API allows users to retrieve a specific Multicast configuration feature template by ID. parameters: - id required: - id - name: api_getNativeVlanSettingsBySite method: GET uri: /dna/intent/api/v1/sites/{siteId}/wirelessSettings/flexConnectNativeVlan api_version: 2.3.7.9 description: This API allows the user to get all Native VLAN Settings at the given site. The default value of the native VLAN on the device is 1 when nothing is explicitly set. parameters: - siteId required: - siteId - name: api_getNetworkBugById method: GET uri: /dna/intent/api/v1/networkBugs/results/bugs/{id} api_version: 2.3.7.9 description: Get details for one network bug by bug ID. Use this tool for CSC-style network bug IDs such as CSCwd12345 or CSCwr77118 when the user asks for general bug details, affected versions, severity, workaround, integrated rele parameters: - id required: - id - name: api_getNetworkBugDeviceByDeviceId method: GET uri: /dna/intent/api/v1/networkBugs/results/networkDevices/{networkDeviceId} api_version: 2.3.7.9 description: Get network bug device by device id parameters: - networkDeviceId required: - networkDeviceId - name: api_getNetworkBugDeviceForTheBugByNetworkDeviceId method: GET uri: /dna/intent/api/v1/networkBugs/results/bugs/{id}/networkDevices/{networkDeviceId} api_version: 2.3.7.9 description: Get or check details for a specific network bug on a specific network device. Use this tool when the user asks whether a device is affected by a CSC network bug, or asks for details/status of a CSC network bug on a parti parameters: - id - networkDeviceId required: - id - networkDeviceId - name: api_getNetworkBugDevices method: GET uri: /dna/intent/api/v1/networkBugs/results/networkDevices api_version: 2.3.7.9 description: Get network devices that have network bugs detected by the network bug scan. Use this list tool for requests like 'what devices have bugs?', 'show all devices with network bugs', 'devices with failed bug scans', or 'devi parameters: - bugCount - limit - networkDeviceId - offset - order - scanMode - scanStatus - sortBy required: [] - name: api_getNetworkBugDevicesForTheBug method: GET uri: /dna/intent/api/v1/networkBugs/results/bugs/{id}/networkDevices api_version: 2.3.7.9 description: Get the network devices affected by a specific network bug ID. Use this tool for questions like 'which devices are affected by CSCwd12345?', 'what devices are impacted by bug CSCwr77118?', or 'show devices with failed sc parameters: - id - limit - networkDeviceId - offset - order - scanMode - scanStatus - sortBy required: - id - name: api_getNetworkBugs method: GET uri: /dna/intent/api/v1/networkBugs/results/bugs api_version: 2.3.7.9 description: Get detected network bugs affecting devices in the network. Use this list tool for questions that ask which network bugs exist, which bugs are detected, which severe/moderate/catastrophic bugs affect the network, or whic parameters: - deviceCount - id - limit - offset - order - severity - sortBy required: [] - name: api_getNetworkBugsResultsTrendOverTime method: GET uri: /dna/intent/api/v1/networkBugs/resultsTrend api_version: 2.3.7.9 description: Get network bugs results trend over time. The default sort is by scan time descending. parameters: - limit - offset - scanTime required: [] - name: api_getNetworkDeviceByIP method: GET uri: /dna/intent/api/v1/network-device/ip-address/{ipAddress} api_version: 2.3.7.9 description: Returns the network device by specified IP address. For PnP devices, use api_getPnPDeviceList/api_getPnPDeviceCount. parameters: - ipAddress required: - ipAddress - name: api_getNetworkDeviceConfigurationFileDetails method: GET uri: /dna/intent/api/v1/networkDeviceConfigFiles api_version: 2.3.7.9 description: Internal low-level record lookup. Returns one stored record identified by its UUID (the `id` parameter). Use only when an upstream step has already produced a specific record UUID and you need to fetch that exact row. No parameters: - fileType - id - limit - networkDeviceId - offset required: [] - name: api_getNetworkDevicesCredentialsSyncStatus method: GET uri: /dna/intent/api/v1/sites/{id}/deviceCredentials/status api_version: 2.3.7.9 description: Gets site network device credential sync/provisioning summary. Use for credential provision summary, credential provisioning status, device credential sync status, network devices credentials sync status, and CLI/SNMP cr parameters: - id required: - id - name: api_getNetworkDevicesFromDiscovery method: GET uri: /dna/intent/api/v1/discovery/{id}/summary api_version: 2.3.7.9 description: Returns the devices discovered in the given discovery based on given filters. Discovery ID can be obtained using the "Get Discoveries by range" API. parameters: - cliStatus - httpStatus - id - ipAddress - netconfStatus - pingStatus - snmpStatus - sortBy - sortOrder - taskId required: - id - name: api_getNfsConfigurations method: GET uri: /dna/system/api/v1/backupNfsConfigurations api_version: 1.0.0-oas3 description: '**Pick this tool for NFS BACKUP SERVER configuration and NFS HEALTH questions.** This tool retrieves all configured NFS backup definitions and their health state, including NFS server host, ports, export path, mounted d' parameters: [] required: [] - name: api_getNotifications method: GET uri: /dna/intent/api/v1/event/event-series api_version: 2.3.7.9 description: Gets the Published Notifications based on the various inputs from the user. It can answer questions like have there been any notifications for event X? or Give me a list of all notifications and many more combinations. A parameters: - category - domain - endTime - eventIds - limit - namespace - offset - order - severity - siteId - sortBy - source - startTime - subDomain - tags - type required: [] - name: api_getNumberOfConfigurationsForADeployedLayer2FeatureOnADevice method: GET uri: /dna/intent/api/v1/wired/networkDevices/{id}/configFeatures/deployed/layer2/{feature}/count api_version: 2.3.7.9 description: The API returns the number of configurations for a deployed layer 2 feature on a device. parameters: - feature - id required: - id - feature - name: api_getNumberOfConfigurationsForAnIntendedLayer2FeatureOnADevice method: GET uri: /dna/intent/api/v1/wired/networkDevices/{id}/configFeatures/intended/layer2/{feature}/count api_version: 2.3.7.9 description: This API returns the count of the instances of the configurations for an intended layer 2 feature on a wired device. parameters: - feature - id required: - id - feature - name: api_getOSPFInterfaces method: GET uri: /dna/intent/api/v1/interface/ospf api_version: 2.3.7.9 description: Returns the interfaces that has OSPF enabled parameters: [] required: [] - name: api_getOrganizationListForMeraki method: GET uri: /dna/intent/api/v1/network-device/{id}/meraki-organization api_version: 2.3.7.9 description: Returns list of organizations for meraki dashboard parameters: - id required: - id - name: api_getPendingFabricEvents method: GET uri: /dna/intent/api/v1/sda/pendingFabricEvents api_version: 2.3.7.9 description: Returns a list of pending fabric events that match the provided query parameters. parameters: - fabricId - limit - offset required: [] - name: api_getPermissionsAPI method: GET uri: /dna/system/api/v1/role/permissions api_version: 2.3.7.9 description: Get permissions for a role in the system. parameters: [] required: [] - name: api_getPlannedAccessPointsForBuilding method: GET uri: /dna/intent/api/v1/buildings/{buildingId}/planned-access-points api_version: 2.3.7.9 description: Provides a list of Planned Access Points for the Building it is requested for parameters: - buildingId - limit - offset - radios required: - buildingId - name: api_getPlannedAccessPointsForFloor method: GET uri: /dna/intent/api/v1/floors/{floorId}/planned-access-points api_version: 2.3.7.9 description: Provides a list of Planned Access Points for the Floor it is requested for parameters: - floorId - limit - offset - radios required: - floorId - name: api_getPlannedAccessPointsPositions method: GET uri: /dna/intent/api/v2/floors/{floorId}/plannedAccessPointPositions api_version: 2.3.7.9 description: Retrieve all Planned Access Points Positions designated for a specific floor parameters: - floorId - limit - macAddress - name - offset - type required: - floorId - name: api_getPlannedAccessPointsPositionsCount method: GET uri: /dna/intent/api/v2/floors/{floorId}/plannedAccessPointPositions/count api_version: 2.3.7.9 description: Retrieve all Planned Access Points Positions count designated for a specific floor parameters: - floorId - macAddress - name - type required: - floorId - name: api_getPnPDeviceCount_legacy method: GET uri: /dna/intent/api/v1/onboarding/pnp-device/count api_version: 2.3.7.11 description: 'Returns the count of PnP network devices using filters such as state, onboarding state, device type, PID, IP, site. For device types, use these exact values: SWITCH, ROUTER, ACCESS_POINT (for APs), WIRELESS_CONTROLLER (f' parameters: - name - onbState - pid - projectId - serialNumber - smartAccountId - source - state - virtualAccountId - workflowId required: [] - name: api_getPnPDeviceList_legacy method: GET uri: /dna/intent/api/v1/onboarding/pnp-device api_version: 2.3.7.11 description: 'Returns a list of PnP network devices using filters such as state, onboarding state, device type, PID, IP, site, smart account, and virtual account. For device types, use these exact values: SWITCH, ROUTER, ACCESS_POINT ' parameters: - limit - name - offset - onbState - pid - projectId - serialNumber - smartAccountId - sort - sortOrder - source - state - virtualAccountId - workflowId required: [] - name: api_getPnPGlobalSettings method: GET uri: /dna/intent/api/v1/onboarding/pnp-settings api_version: 2.3.7.9 description: Returns global PnP settings of the user parameters: [] required: [] - name: api_getPollingIntervalById method: GET uri: /dna/intent/api/v1/network-device/{id}/collection-schedule api_version: 2.3.7.9 description: Returns polling interval by device id parameters: - id required: - id - name: api_getPollingIntervalForAllDevices method: GET uri: /dna/intent/api/v1/network-device/collection-schedule/global api_version: 2.3.7.9 description: Returns polling interval of all devices parameters: [] required: [] - name: api_getPortChannelInformationById method: GET uri: /dna/intent/api/v1/lanAutomation/portChannels/{id} api_version: 2.3.7.9 description: This API retrieves Port Channel information using its ID. parameters: - id required: - id - name: api_getPortChannels method: GET uri: /dna/intent/api/v1/lanAutomation/portChannels api_version: 2.3.7.9 description: Returns a list of Port Channel between the LAN Automation associated devices. parameters: - device1ManagementIPAddress - device1Uuid - device2ManagementIPAddress - device2Uuid - limit - offset required: [] - name: api_getPowerProfileByID method: GET uri: /dna/intent/api/v1/wirelessSettings/powerProfiles/{id} api_version: 2.3.7.9 description: This API allows the user to get a Power Profile by Power Profile ID that captured in wireless settings design parameters: - id required: - id - name: api_getPowerProfiles method: GET uri: /dna/intent/api/v1/wirelessSettings/powerProfiles api_version: 2.3.7.9 description: This API allows the user to get Power Profiles that captured in wireless settings design. parameters: - limit - offset - profileName required: [] - name: api_getPowerProfilesCount method: GET uri: /dna/intent/api/v1/wirelessSettings/powerProfiles/count api_version: 2.3.7.9 description: This API returns the total number of Power Profiles available. parameters: [] required: [] - name: api_getPrimaryManagedAPLocationsForSpecificWirelessController method: GET uri: /dna/intent/api/v1/wirelessControllers/{networkDeviceId}/primaryManagedApLocations api_version: 2.3.7.9 description: For managed-site relation queries, return managed=true on first match across Primary/Secondary/Anchor, and return managed=false only after all three are checked with no match. For runtime managed-site detail controller/W parameters: - limit - networkDeviceId - offset required: - networkDeviceId - name: api_getProject_s_Details method: GET uri: /dna/intent/api/v2/template-programmer/project api_version: 2.3.7.9 description: Get project(s) details parameters: - id - limit - name - offset - sortOrder required: [] - name: api_getProvisionedDevices method: GET uri: /dna/intent/api/v1/sda/provisionDevices api_version: 2.3.7.9 description: Returns the count of provisioned devices based on query parameters. For PnP devices, use api_getPnPDeviceCount(state=Provisioned) instead. parameters: - id - limit - networkDeviceId - offset - siteId required: [] - name: api_getProvisionedDevicesCount method: GET uri: /dna/intent/api/v1/sda/provisionDevices/count api_version: 2.3.7.9 description: Returns the count of provisioned devices based on query parameters. For PnP devices, use api_getPnPDeviceCount(state=Provisioned) instead. parameters: - siteId required: [] - name: api_getProvisioningSettings method: GET uri: /dna/intent/api/v1/provisioningSettings api_version: 2.3.7.9 description: Returns provisioning settings parameters: [] required: [] - name: api_getQosDeviceInterfaceInfo method: GET uri: /dna/intent/api/v1/qos-device-interface-info api_version: 2.3.7.9 description: Get all or by network device id, existing qos device interface infos parameters: - networkDeviceId required: [] - name: api_getQosDeviceInterfaceInfoCount method: GET uri: /dna/intent/api/v1/qos-device-interface-info-count api_version: 2.3.7.9 description: Get the number of all existing qos device interface infos group by network device id parameters: [] required: [] - name: api_getRFProfileByID method: GET uri: /dna/intent/api/v1/wirelessSettings/rfProfiles/{id} api_version: 2.3.7.9 description: This API allows the user to get a RF Profile by RF Profile ID parameters: - id required: - id - name: api_getRFProfiles method: GET uri: /dna/intent/api/v1/wirelessSettings/rfProfiles api_version: 2.3.7.9 description: This API allows the user to get all RF Profiles parameters: - enableRadioType6GHz - enableRadioTypeA - enableRadioTypeB - limit - offset - rfProfileName required: [] - name: api_getRFProfilesCount method: GET uri: /dna/intent/api/v1/wirelessSettings/rfProfiles/count api_version: 2.3.7.9 description: This API allows the user to get count of all RF profiles parameters: [] required: [] - name: api_getRRMFRAConfigurationFeatureTemplate method: GET uri: /dna/intent/api/v1/featureTemplates/wireless/rrmFraConfigurations/{id} api_version: 2.3.7.9 description: This API allows users to retrieve a specific RRM FRA configuration feature template by ID. parameters: - id required: - id - name: api_getRRMGeneralConfigurationFeatureTemplate method: GET uri: /dna/intent/api/v1/featureTemplates/wireless/rrmGeneralConfigurations/{id} api_version: 2.3.7.9 description: This API allows users to retrieve a specific RRM General configuration feature template by ID. parameters: - id required: - id - name: api_getRest_WebhookEventSubscriptions method: GET uri: /dna/intent/api/v1/event/subscription/rest api_version: 2.3.7.9 description: Gets the list of Rest/Webhook Subscriptions's based on provided query params parameters: - category - domain - eventIds - limit - name - offset - order - sortBy - subDomain - type required: [] - name: api_getRest_WebhookSubscriptionDetails method: GET uri: /dna/intent/api/v1/event/subscription-details/rest api_version: 2.3.7.9 description: Gets the list of subscription details for specified connectorType parameters: - instanceId - limit - name - offset - order - sortBy required: [] - name: api_getResyncIntervalForTheNetworkDevice method: GET uri: /dna/intent/api/v1/networkDevices/{id}/resyncIntervalSettings api_version: 2.3.7.9 description: Fetch the reysnc interval for the given network device id. parameters: - id required: - id - name: api_getRolesAPI method: GET uri: /dna/system/api/v1/roles api_version: 2.3.7.9 description: Get all roles in the system parameters: - invokeSource required: - invokeSource - name: api_getSNMPDestination method: GET uri: /dna/intent/api/v1/dna-event/snmp-config api_version: 2.3.7.9 description: Get SNMP Destination parameters: - configId - limit - offset - order - sortBy required: [] - name: api_getSNMPProperties method: GET uri: /dna/intent/api/v1/snmp-property api_version: 2.3.7.9 description: Returns SNMP properties parameters: [] required: [] - name: api_getSSIDByID method: GET uri: /dna/intent/api/v1/sites/{siteId}/wirelessSettings/ssids/{id} api_version: 2.3.7.9 description: This API allows the user to get an SSID (Service Set Identifier) by ID at the given site parameters: - id - siteId required: - siteId - id - name: api_getSSIDBySite method: GET uri: /dna/intent/api/v1/sites/{siteId}/wirelessSettings/ssids api_version: 2.3.7.9 description: This API allows the user to get all SSIDs (Service Set Identifier) at the given site parameters: - authType - l3authType - limit - offset - siteId - ssid - wlanType required: - siteId - name: api_getSSIDCountBySite method: GET uri: /dna/intent/api/v1/sites/{siteId}/wirelessSettings/ssids/count api_version: 2.3.7.9 description: This API allows the user to get count of all SSIDs (Service Set Identifier) . parameters: - siteId required: - siteId - name: api_getSSIDCountForSpecificWirelessController method: GET uri: /dna/intent/api/v1/wirelessControllers/{networkDeviceId}/ssidDetails/count api_version: 2.3.7.9 description: For SSID/WLAN count runtime queries, if hostname/IP/serial is provided instead of networkDeviceId, resolve the controller first with get_device_details and pass the returned canonical networkDeviceId. For controller seri parameters: - adminStatus - managed - networkDeviceId required: - networkDeviceId - name: api_getSSIDDetailsForSpecificWirelessController method: GET uri: /dna/intent/api/v1/wirelessControllers/{networkDeviceId}/ssidDetails api_version: 2.3.7.9 description: For SSID/WLAN runtime queries, if hostname/IP/serial is provided instead of networkDeviceId, resolve the controller first with get_device_details and pass the returned canonical networkDeviceId. For controller serial-num parameters: - adminStatus - limit - managed - networkDeviceId - offset - ssidName required: - networkDeviceId - name: api_getSecondaryManagedAPLocationsForSpecificWirelessController method: GET uri: /dna/intent/api/v1/wirelessControllers/{networkDeviceId}/secondaryManagedApLocations api_version: 2.3.7.9 description: For managed-site relation queries, return managed=true on first match across Primary/Secondary/Anchor, and return managed=false only after all three are checked with no match. For runtime managed-site detail controller/W parameters: - limit - networkDeviceId - offset required: - networkDeviceId - name: api_getSecurityAdvisoriesAffectingTheNetworkDevice method: GET uri: /dna/intent/api/v1/securityAdvisories/results/networkDevices/{networkDeviceId}/advisories api_version: 2.3.7.9 description: '**Tool Dependency: CRITICAL** This tool retrieves DETAILED information about each security advisory affecting a specific network device, including advisory IDs, CVEs, severity, remediation versions, and more. The respon' parameters: - cvssBaseScore - id - limit - networkDeviceId - offset - order - securityImpactRating - sortBy required: - networkDeviceId - limit - sortBy - order - name: api_getSecurityAdvisoriesAffectingTheNetworkDevices method: GET uri: /dna/intent/api/v1/securityAdvisories/results/advisories api_version: 2.3.7.9 description: Return the list of security advisories, PSIRTs, and vulnerabilities affecting all devices in the network. Use this API to answer questions like 'Which security advisories are affecting the devices?' or 'List all vulnerab parameters: - cvssBaseScore - deviceCount - id - limit - offset - order - securityImpactRating - sortBy required: - limit - sortBy - order - name: api_getSecurityAdvisoriesResultsTrendOverTime method: GET uri: /dna/intent/api/v1/securityAdvisories/resultsTrend api_version: 2.3.7.9 description: Get security advisories results trend over time. The default sort is by scan time descending. parameters: - limit - offset - scanTime required: - limit - name: api_getSecurityAdvisoryAffectingTheNetworkDeviceByDevic_978ac4ec method: GET uri: /dna/intent/api/v1/securityAdvisories/results/networkDevices/{networkDeviceId}/advisories/{id} api_version: 2.3.7.9 description: Get detailed information about a specific security advisory affecting a specific network device, including advisory ID, CVEs, severity, vulnerable versions, and first fixed versions. Use this to retrieve details for a pa parameters: - id - networkDeviceId required: - networkDeviceId - id - name: api_getSecurityAdvisoryAffectingTheNetworkDevicesById method: GET uri: /dna/intent/api/v1/securityAdvisories/results/advisories/{id} api_version: 2.3.7.9 description: 'Return detailed information about a specific security advisory, PSIRT, or vulnerability affecting network devices by advisory ID. The response includes: advisory ID, number of affected devices (deviceCount), CVE IDs (cve' parameters: - id required: - id - name: api_getSecurityAdvisoryNetworkDeviceByNetworkDeviceId method: GET uri: /dna/intent/api/v1/securityAdvisories/results/networkDevices/{networkDeviceId} api_version: 2.3.7.9 description: Get security advisory network device by network device id parameters: - networkDeviceId required: - networkDeviceId - name: api_getSecurityAdvisoryNetworkDeviceForTheSecurityAdvis_a527030a method: GET uri: /dna/intent/api/v1/securityAdvisories/results/advisories/{id}/networkDevices/{networkDeviceId} api_version: 2.3.7.9 description: Get or check whether a specific network device is affected by a given security advisory and return its scan summary (scan mode, scan status, advisory count, last scan time). Use this when prompted with requests like "Get parameters: - id - networkDeviceId required: - id - networkDeviceId - name: api_getSecurityAdvisoryNetworkDevices method: GET uri: /dna/intent/api/v1/securityAdvisories/results/networkDevices api_version: 2.3.7.9 description: Return the list of network devices affected by security advisories, PSIRTs, or vulnerabilities. Use this API to answer questions like 'Which devices are affected by the security advisories?' or 'List all devices impacted parameters: - advisoryCount - limit - networkDeviceId - offset - order - scanMode - scanStatus - sortBy required: - limit - name: api_getSecurityAdvisoryNetworkDevicesForTheSecurityAdvisory method: GET uri: /dna/intent/api/v1/securityAdvisories/results/advisories/{id}/networkDevices api_version: 2.3.7.9 description: Return the list of network devices affected by a specific security advisory, PSIRT, or vulnerability. Use this API to answer questions like 'Which devices are affected by the security advisory cisco-sa-20160525-ipv6?' or parameters: - id - limit - networkDeviceId - offset - order - scanMode - scanStatus - sortBy required: - id - limit - name: api_getServiceDeploymentStatus method: GET uri: /dna/intent/api/v1/wired/networkDevices/{networkDeviceId}/configFeatures/intended/serviceDeployments api_version: 2.3.7.9 description: Returns service deployment status based on filter criteria. parameters: - networkDeviceId required: - networkDeviceId - name: api_getServiceProviderDetails method: GET uri: /dna/intent/api/v1/service-provider api_version: 2.3.7.9 description: API to get service provider details (QoS). parameters: [] required: [] - name: api_getServiceProviderDetailsV2 method: GET uri: /dna/intent/api/v2/service-provider api_version: 2.3.7.9 description: API to get Service Provider details (QoS). parameters: [] required: [] - name: api_getSiteAnalyticsForOneSite method: GET uri: /dna/data/api/v1/siteKpiSummaries/{id} api_version: 2.3.7.9 description: Returns site analytics for the given site. 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/ parameters: - X-CALLER-ID - attribute - band - endTime - failureCategory - failureReason - id - ssid - startTime - taskId - view required: - id - name: api_getSiteAnalyticsForTheChildSitesOfGivenParentSiteAn_104cea52 method: GET uri: /dna/data/api/v1/siteKpiSummaries api_version: 2.3.7.9 description: Returns site analytics for all child sites of given parent site. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/cata parameters: - X-CALLER-ID - attribute - band - endTime - failureCategory - failureReason - limit - offset - order - siteHierarchy - siteHierarchyId - siteId - siteType - sortBy - ssid - startTime - taskId - view required: [] - name: api_getSiteAnalyticsSummaryDataForTheGivenTaskId method: GET uri: /dna/data/api/v1/siteKpiSummaries/summaryAnalytics api_version: 2.3.7.9 description: Get site analytics summary data for the given task id. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-cente parameters: - X-CALLER-ID - taskId required: - taskId - name: api_getSiteAnalyticsTrendDataForTheGivenTaskId method: GET uri: /dna/data/api/v1/siteKpiSummaries/trendAnalytics api_version: 2.3.7.9 description: Gets site analytics trend data for the given task id. 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 parameters: - X-CALLER-ID - taskId required: - taskId - name: api_getSiteAssignedNetworkDevice method: GET uri: /dna/intent/api/v1/networkDevices/{id}/assignedToSite api_version: 2.3.7.9 description: Site assigned network device. For PnP devices, use api_getPnPDeviceList/api_getPnPDeviceCount. parameters: - id required: - id - name: api_getSiteEnergyByID method: GET uri: /dna/data/api/v1/energy/sites/{id} api_version: 2.3.7.9 description: Retrieve the energy summary data for a specific site based on the site ID. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmab parameters: - X-CALLER-ID - attribute - deviceCategory - endTime - id - startTime - taskId - views required: - id - name: api_getSiteTopology method: GET uri: /dna/intent/api/v1/topology/site-topology api_version: 2.3.7.9 description: Returns site topology parameters: [] required: [] - name: api_getSites method: GET uri: /dna/intent/api/v1/sites api_version: 2.3.7.9 description: Converts site names or site hierarchies (nameHierarchy) into site identifiers (siteId/UUID), and retrieves site inventory attributes for areas, buildings, and floors. Use this tool when you have a site name (e.g., 'AreaN parameters: - limit - name - nameHierarchy - offset - type required: - limit - name: api_getSitesCount method: GET uri: /dna/intent/api/v1/sites/count api_version: 2.3.7.9 description: Returns the number of sites in Catalyst Center having a given name, or the total number of sites when no site name is provided. Use this tool if you want the total number of sites in Catalyst Center or the number of site parameters: - name required: [] - name: api_getSitesEnergy method: GET uri: /dna/data/api/v1/energy/sites api_version: 2.3.7.9 description: Retrieves a list of sites with energy data based on the specified query parameters. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-p parameters: - X-CALLER-ID - attribute - deviceCategory - endTime - limit - offset - order - siteHierarchy - siteHierarchyId - siteId - siteName - siteType - sortBy - startTime - taskId - views required: [] - name: api_getStackDetailsForDevice method: GET uri: /dna/intent/api/v1/network-device/{deviceId}/stack api_version: 2.3.7.9 description: Retrieves complete stack details for given device ID parameters: - deviceId required: - deviceId - name: api_getStatusAPIForEvents method: GET uri: /dna/intent/api/v1/event/api-status/{executionId} api_version: 2.3.7.9 description: Get the Status of events API calls with provided executionId as mandatory path parameter parameters: - executionId required: - executionId - name: api_getSupervisorCardDetail method: GET uri: /dna/intent/api/v1/network-device/{deviceUuid}/supervisor-card api_version: 2.3.7.9 description: Get supervisor card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no. parameters: - deviceUuid required: - deviceUuid - name: api_getSyslogDestination method: GET uri: /dna/intent/api/v1/event/syslog-config api_version: 2.3.7.9 description: Get Syslog Destination parameters: - configId - limit - name - offset - order - protocol - sortBy required: [] - name: api_getSyslogEventSubscriptions method: GET uri: /dna/intent/api/v1/event/subscription/syslog api_version: 2.3.7.9 description: Gets the list of Syslog Subscriptions's based on provided offset and limit parameters: - category - domain - eventIds - limit - name - offset - order - sortBy - subDomain - type required: [] - name: api_getSyslogSubscriptionDetails method: GET uri: /dna/intent/api/v1/event/subscription-details/syslog api_version: 2.3.7.9 description: Gets the list of subscription details for specified connectorType parameters: - instanceId - limit - name - offset - order - sortBy required: [] - name: api_getTag method: GET uri: /dna/intent/api/v1/tag api_version: 2.3.7.9 description: '**TAG DEFINITION LISTING RULE:** - Use this API to enumerate existing tag definitions when the user asks for available, existing, default/system, or custom/user-created tags. - For an unfiltered tag-definition inventory,' parameters: - additionalInfo.attributes - additionalInfo.nameSpace - field - level - limit - name - offset - order - size - sortBy - systemTag required: [] - name: api_getTagById method: GET uri: /dna/intent/api/v1/tag/{id} api_version: 2.3.7.9 description: Returns tag specified by Id parameters: - id required: - id - name: api_getTagCount method: GET uri: /dna/intent/api/v1/tag/count api_version: 2.3.7.9 description: '**TAG PHRASE EXCLUSION:** - If the user asks how many/count/total/number of devices, network devices, ports, or interfaces are `tagged`, `with tag`, `under tag `, or `in tag `, do not use this tool.' parameters: - attributeName - name - nameSpace - size - systemTag required: [] - name: api_getTagMemberCount method: GET uri: /dna/intent/api/v1/tag/{id}/member/count api_version: 2.3.7.9 description: '**TAG MEMBER COUNT TOOL:** - Select this tool together with `api_getTag` when the user provides a human-readable tag name and asks how many, count, total, or number of members are inside that tag. - Execute this tool aft' parameters: - id - memberAssociationType - memberType required: - id - memberType - name: api_getTagMembersById method: GET uri: /dna/intent/api/v1/tag/{id}/member api_version: 2.3.7.9 description: '**TAG MEMBER LISTING TOOL:** - Select this tool together with `api_getTag` when the user provides a human-readable tag name and asks to list, show, get, find, identify, or ask what/which members are inside that tag. - Ex' parameters: - id - level - limit - memberAssociationType - memberType - offset required: - id - memberType - name: api_getTagResourceTypes method: GET uri: /dna/intent/api/v1/tag/member/type api_version: 2.3.7.9 description: '**TAG PHRASE EXCLUSION:** - If the user names one tag with `tag`, `tagged`, `with tag`, `under tag`, or `in tag` and asks for devices, ports, interfaces, or counts, do not use this tool. The request is about memb' parameters: [] required: [] - name: api_getTaskDetails method: GET uri: /dna/intent/api/v1/endpoint-analytics/tasks/{taskId} api_version: 2.3.7.9 description: Fetches the details of backend task. Task is typically created by making call to some other API that takes longer time to execute. parameters: - taskId required: - taskId - name: api_getTaskDetailsByID method: GET uri: /dna/intent/api/v1/tasks/{id}/detail api_version: 2.3.7.9 description: Returns the task details for the given task ID parameters: - id required: - id - name: api_getTasks method: GET uri: /dna/intent/api/v1/tasks api_version: 2.3.7.9 description: Returns task(s) based on filter criteria parameters: - endTime - limit - offset - order - parentId - rootId - sortBy - startTime - status required: [] - name: api_getTasksByID method: GET uri: /dna/intent/api/v1/tasks/{id} api_version: 2.3.7.9 description: Returns the task with the given ID parameters: - id required: - id - name: api_getTasksCount method: GET uri: /dna/intent/api/v1/tasks/count api_version: 2.3.7.9 description: Returns the number of tasks that meet the filter criteria parameters: - endTime - parentId - rootId - startTime - status required: [] - name: api_getTemplateProject method: GET uri: /dna/intent/api/v1/projects/{projectId} api_version: 2.3.7.9 description: Get a template project by the project's ID. parameters: - projectId required: - projectId - name: api_getTemplateProjectCount method: GET uri: /dna/intent/api/v1/projects/count api_version: 2.3.7.9 description: Get the count of all template projects. parameters: - name required: [] - name: api_getTemplateProjects method: GET uri: /dna/intent/api/v1/projects api_version: 2.3.7.9 description: Get all matching template projects based on the filters selected. parameters: - limit - name - offset required: [] - name: api_getTemplateVersion method: GET uri: /dna/intent/api/v1/templates/{templateId}/versions/{versionId} api_version: 2.3.7.9 description: Get a template's version by the version ID. parameters: - templateId - versionId required: - templateId - versionId - name: api_getTemplateVersions method: GET uri: /dna/intent/api/v1/templates/{templateId}/versions api_version: 2.3.7.9 description: Get a template's version information. parameters: - latestVersion - limit - offset - order - templateId - versionNumber required: - templateId - name: api_getTemplateVersionsCount method: GET uri: /dna/intent/api/v1/templates/{templateId}/versions/count api_version: 2.3.7.9 description: Get the count of a template's version information. parameters: - latestVersion - templateId - versionNumber required: - templateId - name: api_getTemplate_s_Details method: GET uri: /dna/intent/api/v2/template-programmer/template api_version: 2.3.7.9 description: Get template(s) details parameters: - allTemplateAttributes - filterConflictingTemplates - id - includeVersionDetails - limit - name - offset - productFamily - productSeries - productType - projectId - projectName - softwareType - softwareVersion - sortOrder - tags - unCommitted required: [] - name: api_getTheCountOfHealthScoreDefinitionsBasedOnProvidedFilters method: GET uri: /dna/intent/api/v1/healthScoreDefinitions/count api_version: 2.3.7.9 description: Get the count of health score definitions based on provided filters. Supported filters are id, name and overall health include status. For detailed information about the usage of the API, please refer to the Open API spe parameters: - X-CALLER-ID - deviceType - id - includeForOverallHealth required: [] - name: api_getTheCountOfSystemDefinedIssueDefinitionsBasedOnPr_45aa6c33 method: GET uri: /dna/intent/api/v1/systemIssueDefinitions/count api_version: 2.3.7.9 description: Get the count of system defined issue definitions based on provided filters. Supported filters are id, name, profileId and definition enable status. For detailed information about the usage of the API, please refer to th parameters: - X-CALLER-ID - deviceType - id - issueEnabled - name - priority - profileId required: [] - name: api_getTheCustomIssueDefinitionForTheGivenCustomIssueDe_9bd4ac38 method: GET uri: /dna/intent/api/v1/customIssueDefinitions/{id} api_version: 2.3.7.9 description: Get the custom issue definition for the given custom issue definition Id. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmabi parameters: - X-CALLER-ID - id required: - id - name: api_getTheDetailsOfIssuesForGivenSetOfFilters_2 method: GET uri: /dna/data/api/v1/assuranceIssues api_version: 2.3.7.9 description: 'Returns all details of each issue along with suggested actions for given set of filters specified in query parameters. If there is no start and/or end time, then end time will be defaulted to current time and start time ' parameters: - Accept-Language - X-CALLER-ID - aiDriven - attribute - category - deviceType - endTime - entityId - entityType - fabricDriven - fabricSiteDriven - fabricSiteId - fabricTransitDriven - fabricTransitSiteId - fabricVnDriven - fabricVnName - isGlobal - issueId - limit - macAddress - name - networkDeviceId - networkDeviceIpAddress - offset - order - priority - severity - siteHierarchy - siteHierarchyId - siteId - siteName - sortBy - startTime - status - updatedBy - view required: [] - name: api_getTheDetailsOfPhysicalComponentsOfTheGivenDevice method: GET uri: /dna/intent/api/v1/network-device/{deviceUuid}/equipment api_version: 2.3.7.9 description: Return all types of equipment details like PowerSupply, Fan, Chassis, Backplane, Module, PROCESSOR, Other and SFP for the Given device. parameters: - deviceUuid - type required: - deviceUuid - name: api_getTheInterfaceDataForTheGivenInterfaceId_instanceU_0b78da7f method: GET uri: /dna/data/api/v1/interfaces/{id} api_version: 2.3.7.9 description: Returns the interface data for the given interface instance Uuid along with the statistics data. The latest interface data in the specified start and end time range will be returned. When there is no start and end time s parameters: - attribute - endTime - id - startTime - view required: - id - name: api_getTheSupportedLayer2FeaturesOnAWiredDevice method: GET uri: /dna/intent/api/v1/wired/networkDevices/{id}/configFeatures/supported/layer2 api_version: 2.3.7.9 description: The API returns the supported layer 2 features on a wired device. parameters: - id required: - id - name: api_getTheTotalCustomIssueDefinitionsCountBasedOnThePro_240c53aa method: GET uri: /dna/intent/api/v1/customIssueDefinitions/count api_version: 2.3.7.9 description: 'Get the total number of Custom issue definitions count based on the provided filters. The supported filters are id, name, profileId and definition enable status, severity, facility and mnemonic. For detailed information ' parameters: - X-CALLER-ID - facility - id - isEnabled - mnemonic - name - priority - profileId - severity required: [] - name: api_getTheTotalNumberOfIssuesForGivenSetOfFilters method: GET uri: /dna/data/api/v1/assuranceIssues/count api_version: 2.3.7.9 description: Returns the total number issues for given set of filters. If there is no start and/or end time, then end time will be defaulted to current time and start time will be defaulted to 24-hours ago from end time. https://gith parameters: - X-CALLER-ID - aiDriven - category - deviceType - endTime - entityId - entityType - fabricDriven - fabricSiteDriven - fabricSiteId - fabricTransitDriven - fabricTransitSiteId - fabricVnDriven - fabricVnName - isGlobal - issueId - macAddress - name - networkDeviceId - networkDeviceIpAddress - priority - severity - siteHierarchy - siteHierarchyId - siteId - siteName - startTime - status - updatedBy required: [] - name: api_getTheTotalNumberOfSiteAnalyticsRecordsAvailableFor_25bb5c48 method: GET uri: /dna/data/api/v1/siteKpiSummaries/count api_version: 2.3.7.9 description: Returns the total number of site analytics records available for for given set of query parameters. For detailed information about the usage of the API, please refer to the Open API specification document - https://githu parameters: - X-CALLER-ID - endTime - siteHierarchy - siteHierarchyId - siteId - siteType - startTime required: [] - name: api_getThreatLevels method: GET uri: /dna/intent/api/v1/security/threats/level api_version: 2.3.7.9 description: Intent API to fetch all threat levels defined. parameters: - Content-Type required: - Content-Type - name: api_getThreatTypes method: GET uri: /dna/intent/api/v1/security/threats/type api_version: 2.3.7.9 description: Intent API to fetch all threat types defined. parameters: - Content-Type required: - Content-Type - name: api_getTopNEntitiesRelatedToSiteAnalyticsForTheGivenTaskId method: GET uri: /dna/data/api/v1/siteKpiSummaries/topNAnalytics api_version: 2.3.7.9 description: Gets the topN analytics data for a given taskId. 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- parameters: - X-CALLER-ID - taskId required: - taskId - name: api_getTopologyDetails method: GET uri: /dna/intent/api/v1/topology/l2/{vlanID} api_version: 2.3.7.9 description: 'Returns Layer 2 network topology for a specified VLAN ID. Use this for network-wide questions about which switches or devices participate in, have configured, or have enabled a given VLAN. If multiple switches match the ' parameters: - vlanID required: - vlanID - name: api_getTrialDetailsForBugsDetectionOnNetworkDevices method: GET uri: /dna/intent/api/v1/networkBugs/trials api_version: 2.3.7.9 description: Get trial details for bugs detection on network devices parameters: [] required: [] - name: api_getTrialDetailsForFieldNoticesDetectionOnNetworkDevices method: GET uri: /dna/intent/api/v1/fieldNotices/trials api_version: 2.3.7.9 description: Get trial details for field notices detection on network devices parameters: [] required: [] - name: api_getTrialDetailsForSecurityAdvisoriesDetectionOnNetw_ff9164da method: GET uri: /dna/intent/api/v1/securityAdvisories/trials api_version: 2.3.7.9 description: Get trial details for security advisories detection on network devices parameters: [] required: [] - name: api_getTriggeredJobsByActivityId method: GET uri: /dna/intent/api/v1/activities/{activityId}/triggeredJobs api_version: 2.3.7.9 description: Returns the triggered jobs by the activity with the given activity id parameters: - activityId - limit - offset - order - sortBy required: - activityId - name: api_getUserEnrichmentDetails method: GET uri: /dna/intent/api/v1/user-enrichment-details api_version: 2.3.7.9 description: Enriches a given network End User context (a network user-id or end user’s device Mac Address) with details about the user and devices that the user is connected to parameters: - entity_type - entity_value required: - entity_type - entity_value - name: api_getUserEnrichmentDetailsV2 method: GET uri: /dna/intent/api/v2/user-enrichment-details api_version: 2.3.7.10 description: 'Retrieve Catalyst Center end-user enrichment context for a known network user identifier or client MAC address, including user and connected-device context. Use this release-specific OpenAPI enrichment endpoint when the ' parameters: - entity_type - entity_value required: - entity_type - entity_value - name: api_getUsersAPI method: GET uri: /dna/system/api/v1/user api_version: 2.3.7.9 description: Get all users in the system parameters: - authSource - invokeSource required: - invokeSource - name: api_getVLANDetails method: GET uri: /dna/intent/api/v1/topology/vlan/vlan-names api_version: 2.3.7.9 description: Returns the list of VLAN names that are involved in a loop as identified by the Spanning Tree Protocol parameters: [] required: [] - name: api_getViewDetailsForAGivenViewGroup_View method: GET uri: /dna/intent/api/v1/data/view-groups/{viewGroupId}/views/{viewId} api_version: 2.3.7.9 description: Gives complete information of the view that is required to configure a report. Use "Get views for a given view group" API to get the viewIds (required as a query param for this API) for available views. parameters: - viewGroupId - viewId required: - viewGroupId - viewId - name: api_getViewsForAGivenViewGroup method: GET uri: /dna/intent/api/v1/data/view-groups/{viewGroupId} api_version: 2.3.7.9 description: Gives a list of summary of all views in a viewgroup. Use "Get all view groups" API to get the viewGroupIds (required as a query param for this API) for available viewgroups. parameters: - viewGroupId required: - viewGroupId - name: api_getWebhookDestination method: GET uri: /dna/intent/api/v1/event/webhook api_version: 2.3.7.9 description: Get Webhook Destination parameters: - limit - offset - order - sortBy - webhookIds required: [] - name: api_getWirelessLanControllerDetailsById method: GET uri: /dna/intent/api/v1/network-device/{id}/wireless-info api_version: 2.3.7.9 description: Returns the wireless lan controller info with given device ID parameters: - id required: - id - name: api_getWirelessProfileByID method: GET uri: /dna/intent/api/v1/wirelessProfiles/{id} api_version: 2.3.7.9 description: This API allows the user to get a Wireless Network Profile by ID parameters: - id required: - id - name: api_getWirelessProfiles method: GET uri: /dna/intent/api/v1/wirelessProfiles api_version: 2.3.7.9 description: This API allows the user to get all Wireless Network Profiles parameters: - limit - offset - wirelessProfileName required: [] - name: api_getWirelessProfilesCount method: GET uri: /dna/intent/api/v1/wirelessProfiles/count api_version: 2.3.7.9 description: This API allows the user to get count of all wireless profiles parameters: [] required: [] - name: api_getWorkflowById method: GET uri: /dna/intent/api/v1/onboarding/pnp-workflow/{id} api_version: 2.3.7.9 description: Returns a workflow specified by id parameters: - id required: - id - name: api_getWorkflowCount method: GET uri: /dna/intent/api/v1/onboarding/pnp-workflow/count api_version: 2.3.7.9 description: Returns the workflow count parameters: - name required: [] - name: api_getWorkflows method: GET uri: /dna/intent/api/v1/onboarding/pnp-workflow api_version: 2.3.7.9 description: Returns the list of workflows based on filter criteria. If a limit is not specified, it will default to return 50 workflows. Pagination and sorting are also supported by this endpoint parameters: - limit - name - offset - sort - sortOrder - type required: [] - name: api_get_dna_intent_api_v1_global_credential_id method: GET uri: /dna/intent/api/v1/global-credential/{id} api_version: 2.3.7.10 description: Returns the credential sub type for the given Id. parameters: - id required: - id - name: api_getsAllTheVersionsOfAGivenTemplate method: GET uri: /dna/intent/api/v1/template-programmer/template/version/{templateId} api_version: 2.3.7.9 description: Get all the versions of template by its id parameters: - templateId required: - templateId - name: api_getsDetailsOfAGivenTemplate method: GET uri: /dna/intent/api/v1/template-programmer/template/{templateId} api_version: 2.3.7.9 description: Details of the template by its id parameters: - latestVersion - templateId required: - templateId - name: api_getsInterfacesAlongWithStatisticsAndPoeDataFromAllN_d99ee240 method: GET uri: /dna/data/api/v1/interfaces api_version: 2.3.7.9 description: "Retrieves the list of the interfaces from all network devices based on\n the provided query parameters.\ \ The latest interfaces data in the\n specified start and end time range will be returned. When there is n" parameters: - attribute - endTime - interfaceId - interfaceName - limit - networkDeviceId - networkDeviceIpAddress - networkDeviceMacAddress - offset - order - siteHierarchy - siteHierarchyId - siteId - sortBy - startTime - view required: [] - name: api_getsTheDetailsOfAGivenProject method: GET uri: /dna/intent/api/v1/template-programmer/project/{projectId} api_version: 2.3.7.9 description: Get the details of the given project by its id. parameters: - projectId required: - projectId - name: api_getsTheDeviceConfigForTheConfigurationModel method: GET uri: /dna/intent/api/v1/wired/networkDevices/{networkDeviceId}/configFeatures/intended/configurationModels/{previewActivityId}/config api_version: 2.3.7.9 description: 'Gets the device config for the configuration model. This API is ''Step 3'' in the following workflow. Step 1- Use ''POST /intent/api/v1/wired/networkDevices/{networkDeviceId}/configFeatures/intended/configurationModels'' to ' parameters: - networkDeviceId - previewActivityId required: - networkDeviceId - previewActivityId - name: api_getsTheNetworkDeviceDetailsBasedOnTheProvidedQueryParameters method: GET uri: /dna/data/api/v1/networkDevices api_version: 2.3.7.9 description: 'Gets the Network Device details based on the provided query parameters. When there is no start and end time specified returns the latest device details. For detailed information about the usage of the API, please refer ' parameters: - attribute - endTime - fabricRole - fabricSiteId - family - healthScore - id - l2Vn - l3Vn - limit - macAddress - maintenanceMode - managementIpAddress - offset - order - role - serialNumber - siteHierarchy - siteHierarchyId - siteId - softwareVersion - sortBy - startTime - transitNetworkId - type - view required: [] - name: api_getsTheTemplatesAvailable method: GET uri: /dna/intent/api/v1/template-programmer/template api_version: 2.3.7.9 description: List the templates available parameters: - filterConflictingTemplates - productFamily - productSeries - productType - projectId - projectNames - softwareType - softwareVersion - sortOrder - tags - unCommitted required: [] - name: api_getsTheTotalNetworkDeviceInterfaceCountsInTheSpecif_a404d76e method: GET uri: /dna/data/api/v1/interfaces/count api_version: 2.3.7.9 description: Gets the total Network device interface counts. 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-s parameters: - endTime - interfaceId - interfaceName - networkDeviceId - networkDeviceIpAddress - networkDeviceMacAddress - siteHierarchy - siteHierarchyId - siteId - startTime required: [] - name: api_importMapArchive_ImportStatus method: GET uri: /dna/intent/api/v1/maps/import/{importContextUuid}/status api_version: 2.3.7.9 description: Gets the status of a map archive import operation. For a map archive import that has just been initiated, will provide the result of validation of the archive and a pre-import preview of what will be performed if the imp parameters: - importContextUuid required: - importContextUuid - name: api_inventoryInsightDeviceLinkMismatchAPI method: GET uri: /dna/intent/api/v1/network-device/insight/{siteId}/device-link api_version: 2.3.7.9 description: Find all devices with link mismatch (speed / vlan) parameters: - category - limit - offset - order - siteId - sortBy required: - siteId - category - name: api_issues method: GET uri: /dna/intent/api/v1/issues api_version: 2.3.7.9 description: Intent API to get a list of global issues, issues for a specific device, or issue for a specific client device's MAC address. parameters: - aiDriven - deviceId - endTime - issueStatus - macAddress - priority - siteId - startTime required: [] - name: api_lANAutomationActiveSessions method: GET uri: /dna/intent/api/v1/lan-automation/sessions api_version: 2.3.7.9 description: Invoke this API to get the LAN Automation active session information parameters: [] required: [] - name: api_lANAutomationLog method: GET uri: /dna/intent/api/v1/lan-automation/log api_version: 2.3.7.9 description: Invoke this API to get the LAN Automation session logs. parameters: - limit - offset required: [] - name: api_lANAutomationLogById method: GET uri: /dna/intent/api/v1/lan-automation/log/{id} api_version: 2.3.7.9 description: Invoke this API to get the LAN Automation session logs based on the given LAN Automation session id. parameters: - id required: - id - name: api_lANAutomationLogsForIndividualDevices method: GET uri: /dna/intent/api/v1/lan-automation/log/{id}/{serialNumber} api_version: 2.3.7.9 description: Invoke this API to get the LAN Automation session logs for individual devices based on the given LAN Automation session id and device serial number. parameters: - id - logLevel - serialNumber required: - id - serialNumber - name: api_lANAutomationSessionCount method: GET uri: /dna/intent/api/v1/lan-automation/count api_version: 2.3.7.9 description: Invoke this API to get the total count of LAN Automation sessions. parameters: [] required: [] - name: api_lANAutomationStatus method: GET uri: /dna/intent/api/v1/lan-automation/status api_version: 2.3.7.9 description: Invoke this API to get the LAN Automation session status. Returns all LAN Automation sessions including their discovered devices list, seed device details, IP pools, multicast settings, discovery level, and session creat parameters: - limit - offset required: [] - name: api_lANAutomationStatusById method: GET uri: /dna/intent/api/v1/lan-automation/status/{id} api_version: 2.3.7.9 description: Invoke this API to get the LAN Automation session status for a specific session by its ID. Returns the session details including discovered devices list, seed device details, IP pools, multicast settings, and session sta parameters: - id required: - id - name: api_legitOperationsForInterface method: GET uri: /dna/intent/api/v1/interface/{interfaceUuid}/legit-operation api_version: 2.3.7.9 description: '**Tool Dependency: CRITICAL** This tool retrieves the list of all valid properties and operations for a network interface. The response includes interface properties (name, applicable status, failure reasons) and operat' parameters: - interfaceUuid required: - interfaceUuid - name: api_licenseTermDetails method: GET uri: /dna/intent/api/v1/licenses/term/smartAccount/{smart_account_id}/virtualAccount/{virtual_account_name} api_version: 2.3.7.9 description: 'Retrieve **license term details** only (expiry/term metadata). **DO NOT USE** for license usage/consumption/availability counts. - Device-type license usage questions like "How many available licenses are there for ISE?' parameters: - device_type - smart_account_id - virtual_account_name required: - smart_account_id - virtual_account_name - device_type - name: api_listsICAPPacketCaptureFilesMatchingSpecifiedCriteria method: GET uri: /dna/data/api/v1/icap/captureFiles api_version: 2.3.7.9 description: Lists the ICAP packet capture (pcap) files matching the specified criteria. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programma parameters: - X-CALLER-ID - apMac - clientMac - endTime - limit - offset - order - sortBy - startTime - type required: - type - name: api_mapsSupportedAccessPoints method: GET uri: /dna/intent/api/v1/maps/supported-access-points api_version: 2.3.7.9 description: Gets the list of supported access point types as well as valid antenna pattern names that can be used for each. parameters: [] required: [] - name: api_pOEDetails method: GET uri: /dna/intent/api/v1/network-device/{deviceUuid}/poe api_version: 2.3.7.9 description: Returns POE details for device. parameters: - deviceUuid required: - deviceUuid - name: api_querySitesEnergyForTheGivenTaskID method: GET uri: /dna/data/api/v1/energy/sites/query api_version: 2.3.7.9 description: Gets query sites energy task result for the given task ID. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-c parameters: - X-CALLER-ID - taskId required: [] - name: api_queryTheEndpoints method: GET uri: /dna/intent/api/v1/endpoint-analytics/endpoints api_version: 2.3.7.9 description: Query the endpoints, optionally using various filter and pagination criteria. 'GET /endpoints/count' API can be used to find out the total number of endpoints matching the filter criteria. parameters: - aiSpoofingTrustLevel - ancPolicy - authMethod - changedProfileTrustLevel - concurrentMacTrustLevel - deviceType - hardwareManufacturer - hardwareModel - include - ip - ipBlocklistDetected - limit - macAddress - macAddresses - natTrustLevel - offset - operatingSystem - order - postureStatus - profilingStatus - randomMac - registered - sortBy - trustScore - unauthPortDetected - weakCredDetected required: [] - name: api_readFabricSitesWithHealthSummaryFromId method: GET uri: /dna/data/api/v1/fabricSiteHealthSummaries/{id} api_version: 2.3.7.9 description: 'Get Fabric site health summary for a specific fabric site by providing the unique fabric site id in the url path. This API provides the latest health data until the given `endTime`. If data is not ready for the provided' parameters: - X-CALLER-ID - attribute - endTime - id - startTime - view required: - id - name: api_readTransitNetworkWithItsHealthSummaryFromId method: GET uri: /dna/data/api/v1/transitNetworkHealthSummaries/{id} api_version: 2.3.7.9 description: 'Get health summary for a specific transit Network by providing the unique transit networks id in the url path. This API provides the latest health data until the given `endTime`. If data is not ready for the provided en' parameters: - X-CALLER-ID - attribute - endTime - id - startTime - view required: - id - name: api_readVirtualNetworkWithItsHealthSummaryFromId method: GET uri: /dna/data/api/v1/virtualNetworkHealthSummaries/{id} api_version: 2.3.7.9 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 ' parameters: - X-CALLER-ID - attribute - endTime - id - startTime - view required: - id - name: api_readinessStatusForAFabricSite method: GET uri: /dna/intent/api/v1/securityServiceInsertion/fabricSitesReadiness/{id} api_version: 2.3.7.9 description: Gets a list of SDA virtual networks for the specified fabric site, including their individual readiness status for Security Service Insertion (SSI) deployment. The result is sorted by virtualNetworkName. parameters: - id - order required: - id - name: api_readinessStatusOfSwitchesInASpecifiedVirtualNetwork_d64c1de3 method: GET uri: /dna/intent/api/v1/securityServiceInsertion/fabricSitesReadiness/{siteId}/virtualNetworks/{id} api_version: 2.3.7.9 description: Gets a list of switches for the specified virtual network within a fabric site, including their individual readiness status for Security Service Insertion (SSI) deployment. The result is sorted by hostName. parameters: - id - siteId required: - siteId - id - name: api_retrieveAAASettingsForASite method: GET uri: /dna/intent/api/v1/sites/{id}/aaaSettings api_version: 2.3.7.9 description: Retrieve configured AAA settings for a specific site or site hierarchy, including Global. Use this API whenever the user asks for AAA, RADIUS, TACACS, TACACS+, ISE, authentication server, authorization server, or account parameters: - _inherited - id required: - id - name: api_retrieveACountOfTheNumberOfAssuranceTasksThatCurrentlyExist method: GET uri: /dna/data/api/v1/assuranceTasks/count api_version: 2.3.7.9 description: 'returns a count of the number of assurance tasks that are not expired For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability' parameters: - X-CALLER-ID - status required: [] - name: api_retrieveAListOfAssuranceTasks method: GET uri: /dna/data/api/v1/assuranceTasks api_version: 2.3.7.9 description: 'returns all existing tasks in a paginated list default sorting of list is `startTime`, `asc` valid field to sort by are [`startTime`,`endTime`,`updateTime`,`status`] For detailed information about the usage of the API,' parameters: - X-CALLER-ID - limit - offset - order - sortBy - status required: [] - name: api_retrieveANetworkProfileForSitesById method: GET uri: /dna/intent/api/v1/networkProfilesForSites/{id} api_version: 3.3.1 description: Retrieves a network profile for sites by id. parameters: - id required: - id - name: api_retrieveASpecificAssuranceTaskById method: GET uri: /dna/data/api/v1/assuranceTasks/{id} api_version: 2.3.7.9 description: 'returns a task given a specific task id 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/blo' parameters: - X-CALLER-ID - id required: - id - name: api_retrieveASpecificPolicyTagForAWirelessProfile method: GET uri: /dna/intent/api/v1/wirelessProfiles/{id}/policyTags/{policyTagId} api_version: 2.3.7.9 description: This endpoint retrieves the details of a specific `Policy Tag` associated with a given `Wireless Profile`. This API requires the `id` of the `Wireless Profile` and the `policyTagId` of the `Policy Tag`. parameters: - id - policyTagId required: - id - policyTagId - name: api_retrieveASpecificSiteTagForAWirelessProfile method: GET uri: /dna/intent/api/v1/wirelessProfiles/{id}/siteTags/{siteTagId} api_version: 2.3.7.9 description: This endpoint retrieves the details of a specific `Site Tag` associated with a given `Wireless Profile`. This API requires the `id` of the `Wireless Profile` and the `siteTagId` of the `Site Tag`. parameters: - id - siteTagId required: - id - siteTagId - name: api_retrieveAllPolicyTagsForAWirelessProfile method: GET uri: /dna/intent/api/v1/wirelessProfiles/{id}/policyTags api_version: 2.3.7.9 description: This endpoint retrieves a list of all `Policy Tags` associated with a specific `Wireless Profile`. This API requires the `id` of the `Wireless Profile` to be provided as a path parameter. parameters: - id - limit - offset - policyTagName required: - id - name: api_retrieveAllSiteTagsForAWirelessProfile method: GET uri: /dna/intent/api/v1/wirelessProfiles/{id}/siteTags api_version: 2.3.7.9 description: This endpoint retrieves a list of all `Site Tags` associated with a specific `Wireless Profile`. This API requires the `id` of the `Wireless Profile` to be provided as a path parameter. parameters: - id - limit - offset - siteTagName required: - id - name: api_retrieveApplicableAdd_onImagesForTheGivenSoftwareImage method: GET uri: /dna/intent/api/v1/images/{id}/addonImages api_version: 2.3.7.9 description: Retrieves the list of applicable add-on images if available for the given software image. `id` can be obtained from the response of API [ /dna/intent/api/v1/images?hasAddonImages=true ]. parameters: - id required: - id - name: api_retrieveBannerSettingsForASite method: GET uri: /dna/intent/api/v1/sites/{id}/bannerSettings api_version: 2.3.7.9 description: '**NETWORK SERVER SETTINGS** : Retrieve site-level device access banner settings for a site. For broad queries such as what network server settings are configured at a site, invoke this tool together with the AAA, DHCP, D' parameters: - _inherited - id required: - id - _inherited - name: api_retrieveCLITemplatesAttachedToANetworkProfile method: GET uri: /dna/intent/api/v1/networkProfilesForSites/{profileId}/templates api_version: 2.3.7.9 description: Retrieves a list of CLI templates attached to a network profile based on the network profile ID. parameters: - profileId required: - profileId - name: api_retrieveCountOfCLITemplatesAttachedToANetworkProfile method: GET uri: /dna/intent/api/v1/networkProfilesForSites/{profileId}/templates/count api_version: 2.3.7.9 description: Retrieves the count of all CLI templates attached to a network profile by the profile ID. parameters: - profileId required: - profileId - name: api_retrieveCountOfNetworkProfilesAttachedToACLITemplate method: GET uri: /dna/intent/api/v1/templates/{templateId}/networkProfilesForSites/count api_version: 2.3.7.9 description: Retrieves the count of network profiles that a CLI template has been attached to by the template ID. parameters: - templateId required: - templateId - name: api_retrieveDHCPSettingsForASite method: GET uri: /dna/intent/api/v1/sites/{id}/dhcpSettings api_version: 2.3.7.9 description: '**NETWORK SERVER SETTINGS** : Retrieve DHCP settings for a site. For broad queries such as what network server settings are configured at a site, invoke this tool together with the AAA, DNS, image distribution, NTP, time' parameters: - _inherited - id required: - id - _inherited - name: api_retrieveDNSSettingsForASite method: GET uri: /dna/intent/api/v1/sites/{id}/dnsSettings api_version: 2.3.7.9 description: '**NETWORK SERVER SETTINGS** : Retrieve DNS settings for a site. For broad queries such as what network server settings are configured at a site, invoke this tool together with the AAA, DHCP, image distribution, NTP, time' parameters: - _inherited - id required: - id - _inherited - name: api_retrieveImageDistributionServers method: GET uri: /dna/intent/api/v1/images/distributionServerSettings api_version: 2.3.7.9 description: Retrieve the list of remote image distribution servers. There can be up to two remote servers.Product always acts as local distribution server, and it is not part of this API response. parameters: [] required: [] - name: api_retrieveImageDistributionSettingsForASite method: GET uri: /dna/intent/api/v1/sites/{id}/imageDistributionSettings api_version: 2.3.7.9 description: '**NETWORK SERVER SETTINGS** : Retrieve image distribution settings for a site. For broad queries such as what network server settings are configured at a site, invoke this tool together with the AAA, DHCP, DNS, NTP, time' parameters: - _inherited - id required: - id - _inherited - name: api_retrieveLicenseSetting method: GET uri: /dna/intent/api/v1/licenseSetting api_version: 2.3.7.9 description: 'Retrieves licensing settings, including Default/Active Licensing Smart Account ID.\n\n**Execution Policy (MANDATORY):**\n- Use this tool directly for licensing requests about active/default smart account settings.\n- Do ' parameters: [] required: [] - name: api_retrieveNTPSettingsForASite method: GET uri: /dna/intent/api/v1/sites/{id}/ntpSettings api_version: 2.3.7.9 description: '**NETWORK SERVER SETTINGS** : Retrieve NTP settings for a site. For broad queries such as what network server settings are configured at a site, invoke this tool together with the AAA, DHCP, DNS, image distribution, time' parameters: - _inherited - id required: - id - _inherited - name: api_retrieveNetworkDeviceProductName method: GET uri: /dna/intent/api/v1/productNames/{productNameOrdinal} api_version: 2.3.7.9 description: Get the network device product name, its ordinal, and supported PIDs. parameters: - productNameOrdinal required: - productNameOrdinal - name: api_retrieveNetworkDevices method: GET uri: /dna/intent/api/v1/networkDevices api_version: 2.3.7.9 description: API to fetch the list of network devices using basic filters. Use the `/dna/intent/api/v1/networkDevices/query` API for advanced filtering. Refer features for more details. The API returns a paginated response based on ' parameters: - family - id - limit - managementAddress - managementState - offset - order - reachabilityStatus - role - serialNumber - sortBy - stackDevice - status - views required: [] - name: api_retrieveScheduledMaintenanceWindowsForNetworkDevices method: GET uri: /dna/intent/api/v1/networkDeviceMaintenanceSchedules api_version: 2.3.7.9 description: This API retrieves a list of scheduled maintenance windows for network devices based on filter parameters. Each maintenance window is composed of a start schedule and end schedule, both of which have unique identifiers(` parameters: - limit - networkDeviceIds - offset - order - sortBy - status required: [] - name: api_retrieveSitesWithOverriddenSSIDs method: GET uri: /dna/intent/api/v1/wirelessSettings/ssids/overrideAtSites api_version: 2.3.7.9 description: Retrieve list of siteId(s) with information of SSID(s) which are overridden parameters: - limit - offset - siteId required: [] - name: api_retrieveSpecificImageDistributionServer method: GET uri: /dna/intent/api/v1/images/distributionServerSettings/{id} api_version: 2.3.7.9 description: Retrieve image distribution server for the given server identifier parameters: - id required: - id - name: api_retrieveTagsAssociatedWithNetworkDevices method: GET uri: /dna/intent/api/v1/tags/networkDevices/membersAssociations api_version: 2.3.7.9 description: '**TAG PHRASE EXCLUSION:** - If the user starts from a named tag using `tag`, `tagged`, `with tag`, `under tag`, or `in tag` and asks which/list/show/get devices or how many devices belong to that value, do not us' parameters: - limit - offset required: [] - name: api_retrieveTagsAssociatedWithTheInterfaces method: GET uri: /dna/intent/api/v1/tags/interfaces/membersAssociations api_version: 2.3.7.9 description: '**TAG PHRASE EXCLUSION:** - If the user starts from a named tag using `tag`, `tagged`, `with tag`, `under tag`, or `in tag` and asks which/list/show/get ports or interfaces, or how many ports/interfaces belong to' parameters: - limit - offset required: [] - name: api_retrieveTelemetrySettingsForASite method: GET uri: /dna/intent/api/v1/sites/{id}/telemetrySettings api_version: 2.3.7.9 description: 'Retrieves effective site telemetry settings for a site: application visibility, application telemetry, wired endpoint data collection, wireless telemetry, SNMP traps, syslog servers, and collectors. Use this tool for sit' parameters: - _inherited - id required: - id - name: api_retrieveTheCountOfInterfacesThatAreAssociatedWithAt_6c330a1b method: GET uri: /dna/intent/api/v1/tags/interfaces/membersAssociations/count api_version: 2.3.7.9 description: Fetches the count of interfaces that are associated with at least one tag. A tag is a user-defined or system-defined construct to group resources. When an interface is tagged, it is called a member of the tag. parameters: [] required: [] - name: api_retrieveTheCountOfNetworkDevicesForTheGivenApplicat_cdbaad0f method: GET uri: /dna/intent/api/v1/applicationVisibility/networkDevices/count api_version: 2.3.7.9 description: This API retrieves the count of network devices for the given application visibility status filters. parameters: - appTelemetryDeploymentStatus - appTelemetryReadinessStatus - applicationRegistrySyncStatus - cbarDeploymentStatus - cbarReadinessStatus - hostname - ids - managementAddress - protocolPackStatus - protocolPackUpdateStatus - siteId required: [] - name: api_retrieveTheCountOfNetworkDevicesThatAreAssociatedWi_b9832de8 method: GET uri: /dna/intent/api/v1/tags/networkDevices/membersAssociations/count api_version: 2.3.7.9 description: Fetches the count of network devices that are associated with at least one tag. A tag is a user-defined or system-defined construct to group resources. When a device is tagged, it is called a member of the tag. parameters: [] required: [] - name: api_retrieveTheCountOfPolicyTagsForAWirelessProfile method: GET uri: /dna/intent/api/v1/wirelessProfiles/{id}/policyTags/count api_version: 2.3.7.9 description: This endpoint retrieves the total count of `Policy Tags` associated with a specific `Wireless Profile`.This API requires the `id` of the `Wireless Profile` to be provided as a path parameter. parameters: - id required: - id - name: api_retrieveTheCountOfSiteTagsForAWirelessProfile method: GET uri: /dna/intent/api/v1/wirelessProfiles/{id}/siteTags/count api_version: 2.3.7.9 description: This endpoint retrieves the total count of `Site Tags` associated with a specific `Wireless Profile`.This API requires the `id` of the `Wireless Profile` to be provided as a path parameter. parameters: - id required: - id - name: api_retrieveTheListOfNetworkDevicesWithTheirApplication_479dd261 method: GET uri: /dna/intent/api/v1/applicationVisibility/networkDevices api_version: 2.3.7.9 description: This API retrieves the list of network devices with their application visibility status. The list can be filtered using the query parameters. Multiple filters can be applied. parameters: - appTelemetryDeploymentStatus - appTelemetryReadinessStatus - applicationRegistrySyncStatus - cbarDeploymentStatus - cbarReadinessStatus - hostname - ids - limit - managementAddress - offset - order - protocolPackStatus - protocolPackUpdateStatus - siteId - sortBy required: [] - name: api_retrieveTheNetworkProfilesAttachedToACLITemplate method: GET uri: /dna/intent/api/v1/templates/{templateId}/networkProfilesForSites api_version: 2.3.7.9 description: Retrieves the list of network profiles that a CLI template is currently attached to by the template ID. parameters: - templateId required: - templateId - name: api_retrieveTheStatusOfAllTheDeviceReplacementWorkflows method: GET uri: /dna/intent/api/v1/networkDeviceReplacements api_version: 2.3.7.9 description: Retrieve the workflow execution status of device replacements. Use this tool when the query is specifically about workflow process state. For general queries about device replacement status, device details, or listing de parameters: - family - faultyDeviceName - faultyDevicePlatform - faultyDeviceSerialNumber - limit - offset - replacementDevicePlatform - replacementDeviceSerialNumber - replacementStatus - sortBy - sortOrder required: [] - name: api_retrieveTheStatusOfDeviceReplacementWorkflowThatRep_a2407523 method: GET uri: /dna/intent/api/v1/networkDeviceReplacements/{id} api_version: 2.3.7.9 description: Fetches the status of the device replacement workflow for a given device replacement `id`. Invoke the API `/dna/intent/api/v1/networkDeviceReplacements` to `GET` the list of all device replacements and use the `id` field parameters: - id required: - id - name: api_retrieveTheTotalNumberOfScheduledMaintenanceWindows method: GET uri: /dna/intent/api/v1/networkDeviceMaintenanceSchedules/count api_version: 2.3.7.9 description: Retrieve the total count of all scheduled maintenance windows for network devices. parameters: - networkDeviceIds - status required: [] - name: api_retrieveTimeZoneSettingsForASite method: GET uri: /dna/intent/api/v1/sites/{id}/timeZoneSettings api_version: 2.3.7.9 description: '**NETWORK SERVER SETTINGS** : Retrieve time zone settings for a site. For broad queries such as what network server settings are configured at a site, invoke this tool together with the AAA, DHCP, DNS, image distribution' parameters: - _inherited - id required: - id - _inherited - name: api_retrievesAGlobalIPAddressPool method: GET uri: /dna/intent/api/v1/ipam/globalIpAddressPools/{id} api_version: 2.3.7.9 description: 'Retrieves a single global IP address pool by UUID (globalIpAddressPoolId). PRECEDENCE Apply sections in order. Higher sections override lower sections when they conflict. S0 Scope and hard boundaries S0.1 ID-only globa' parameters: - id required: - id - name: api_retrievesAllPreviousPathtracesSummary method: GET uri: /dna/intent/api/v1/flow-analysis api_version: 2.3.7.9 description: Returns a summary of all flow analyses stored. Results can be filtered by specified parameters. parameters: - destIP - destPort - gtCreateTime - lastUpdateTime - limit - ltCreateTime - offset - order - periodicRefresh - protocol - sortBy - sourceIP - sourcePort - status - taskId required: [] - name: api_retrievesAllTheValidationSets method: GET uri: /dna/intent/api/v1/diagnosticValidationSets api_version: 2.3.7.9 description: Retrieves all the validation sets and optionally the contained validations parameters: - view required: [] - name: api_retrievesAnIPAddressSubpool method: GET uri: /dna/intent/api/v1/ipam/siteIpAddressPools/{id} api_version: 2.3.7.9 description: 'Retrieves a single IP address subpool by UUID (id). PRECEDENCE Apply sections in order. Higher sections override lower sections when they conflict. S0 Scope and hard boundaries S0.1 ID-only subpool detail tool. S0.2 Us' parameters: - id required: - id - name: api_retrievesCSSMConnectionMode method: GET uri: /dna/intent/api/v1/connectionModeSetting api_version: 2.3.7.9 description: Retrieves Cisco Smart Software Manager (CSSM) connection mode setting. parameters: [] required: [] - name: api_retrievesCiscoIMCConfigurationsForCatalystCenterNodes method: GET uri: /dna/system/api/v1/ciscoImcs api_version: 2.3.7.9 description: 'This API retrieves the configurations of the Cisco Integrated Management Controller (IMC) that have been added to the Catalyst Center nodes. The Cisco IMC configuration APIs enable the management of connections between ' parameters: [] required: [] - name: api_retrievesConfigurationDetailsOfTheExternalIPAMServer method: GET uri: /dna/intent/api/v1/ipam/serverSetting api_version: 2.3.7.9 description: Retrieves configuration details of the external IPAM server. Use for integration/status and configuration questions such as "Is Infoblox/BlueCat integrated?", "What external IPAM is configured?", or "Show external IPAM c parameters: [] required: [] - name: api_retrievesDeployedICAPConfigurationsWhileSupportingB_0c45cdf6 method: GET uri: /dna/intent/api/v1/icapSettings api_version: 2.3.7.9 description: Retrieves deployed ICAP configurations while supporting basic filtering. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmabil parameters: - apId - captureStatus - captureType - clientMac - limit - offset - wlcId required: - captureStatus - name: api_retrievesDetailsOfASpecificICAPPacketCaptureFile method: GET uri: /dna/data/api/v1/icap/captureFiles/{id} api_version: 2.3.7.9 description: Retrieves details of a specific ICAP packet capture file. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst-ce parameters: - X-CALLER-ID - id required: - id - name: api_retrievesDiagnosticTaskByID method: GET uri: /dna/intent/api/v1/diagnosticTasks/{id} api_version: 2.3.7.9 description: This API retrieves the diagnostic task identified by the specified `id`. parameters: - id required: - id - name: api_retrievesDiagnosticTaskDetailsByID method: GET uri: /dna/intent/api/v1/diagnosticTasks/{id}/detail api_version: 2.3.7.9 description: This API retrieves the details of the diagnostic task identified by the specified `id`. parameters: - id required: - id - name: api_retrievesGlobalIPAddressPools method: GET uri: /dna/intent/api/v1/ipam/globalIpAddressPools api_version: 2.3.7.9 description: "Retrieves global IP address pools. Do not use this or include global pool results in SLAAC, 'Dualstack',\ \ 'IPv4 only' and 'IPv6 only' questions. \n\nPRECEDENCE\nApply sections in order. Higher sections override lower section" parameters: - limit - offset - order - sortBy required: [] - name: api_retrievesIPAddressSubpools method: GET uri: /dna/intent/api/v1/ipam/siteIpAddressPools api_version: 2.3.7.9 description: 'Retrieves IP address subpools. PRECEDENCE Apply sections in order. Higher sections override lower sections when they conflict. S0 Scope and hard boundaries (highest priority) S0.1 This tool is for subpool intents. S0.2' parameters: - limit - offset - order - siteId - sortBy required: [] - name: api_retrievesPreviousPathtrace method: GET uri: /dna/intent/api/v1/flow-analysis/{flowAnalysisId} api_version: 2.3.7.9 description: Returns result of a previously requested flow analysis by its Flow Analysis id parameters: - flowAnalysisId required: - flowAnalysisId - name: api_retrievesSpecificClientInformationMatchingTheMACAddress method: GET uri: /dna/data/api/v1/clients/{id} api_version: 2.3.7.9 description: Retrieves specific client information matching the MAC address. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catal parameters: - X-CALLER-ID - attribute - endTime - id - startTime - view required: - id - name: api_retrievesSubpoolsIDsOfAGlobalIPAddressPool method: GET uri: /dna/intent/api/v1/ipam/globalIpAddressPools/{globalIpAddressPoolId}/subpools api_version: 2.3.7.9 description: 'Retrieves the IDs of all IP address subpools under a specific global IP address pool (globalIpAddressPoolId). Use when the user asks for subpools within a given global pool and you need child subpool IDs (often followed ' parameters: - globalIpAddressPoolId - limit - offset required: - globalIpAddressPoolId - name: api_retrievesSummaryOfNetworkDeviceLicenses method: GET uri: /dna/intent/api/v1/networkDeviceLicenses/summary api_version: 2.3.7.9 description: '**Retrieves** the summary of consumed network device licenses.\n\nUse this tool to obtain **aggregate statistics** and license usage counts by type (e.g. ''DNA Advantage'' counts).\n\n**CRITICAL INSTRUCTION: SUMMARY ONLY**' parameters: [] required: [] - name: api_retrievesTheApplicationQoSPolicySetting method: GET uri: /dna/intent/api/v1/qosPolicySetting api_version: 2.3.7.9 description: API to retrieve the application QoS policy setting. parameters: [] required: [] - name: api_retrievesTheCiscoIMCConfigurationForACatalystCenterNode method: GET uri: /dna/system/api/v1/ciscoImcs/{id} api_version: 2.3.7.9 description: 'This API retrieves the Cisco Integrated Management Controller (IMC) configuration for a Catalyst Center node, identified by the specified ID. The Cisco IMC configuration APIs enable the management of connections between' parameters: - id required: - id - name: api_retrievesTheCountOfActivities method: GET uri: /dna/intent/api/v1/activities/count api_version: 2.3.7.9 description: Retrieves the count of activities parameters: - description - endTime - recurring - startTime - status - type required: [] - name: api_retrievesTheCountOfDeployedICAPConfigurationsWhileS_4d6c040d method: GET uri: /dna/intent/api/v1/icapSettings/count api_version: 2.3.7.9 description: Retrieves the count of deployed ICAP configurations while supporting basic filtering. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en parameters: - apId - captureStatus - captureType - clientMac - wlcId required: - captureStatus - name: api_retrievesTheCountOfNetworkProfilesForSites method: GET uri: /dna/intent/api/v1/networkProfilesForSites/count api_version: 3.3.1 description: Retrieves the count of network profiles for sites parameters: - type required: [] - name: api_retrievesTheCountOfProfilesThatTheGivenSiteHasBeenAssigned method: GET uri: /dna/intent/api/v1/sites/{siteId}/profileAssignments/count api_version: 2.3.7.9 description: Retrieves the count of profiles that the given site has been assigned. These profiles may either be directly assigned to this site, or were assigned to a parent site and have been inherited. parameters: - siteId required: - siteId - name: api_retrievesTheCountOfSitesThatTheGivenNetworkProfileF_40cb52b6 method: GET uri: /dna/intent/api/v1/networkProfilesForSites/{profileId}/siteAssignments/count api_version: 3.3.1 description: Retrieves the count of sites that the given network profile for sites is assigned to. parameters: - profileId required: - profileId - name: api_retrievesTheCountOfTriggeredJobsByActivityId method: GET uri: /dna/intent/api/v1/activities/{activityId}/triggeredJobs/count api_version: 2.3.7.9 description: Retrieves the count of triggered jobs by activity id. parameters: - activityId required: - activityId - name: api_retrievesTheCountOfValidationWorkflows method: GET uri: /dna/intent/api/v1/diagnosticValidationWorkflows/count api_version: 2.3.7.9 description: Retrieves the count of workflows that have been successfully submitted and are currently available. parameters: - endTime - runStatus - startTime required: [] - name: api_retrievesTheDetailsOfASpecificAAAServiceMatchingThe_dacfed38 method: GET uri: /dna/data/api/v1/aaaServices/{id} api_version: 2.3.7.9 description: Retrieves the details of the AAA Service matching the given id. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catal parameters: - X-CALLER-ID - endTime - id - startTime required: - id - name: api_retrievesTheDetailsOfASpecificDHCPServiceMatchingTh_323b9f73 method: GET uri: /dna/data/api/v1/dhcpServices/{id} api_version: 2.3.7.9 description: Retrieves the details of the DHCP Service matching the given id. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/cata parameters: - X-CALLER-ID - endTime - id - startTime required: - id - name: api_retrievesTheDetailsOfASpecificDNSServiceMatchingThe_9f12711c method: GET uri: /dna/data/api/v1/dnsServices/{id} api_version: 2.3.7.9 description: Retrieves the details of the DNS Service matching the given id. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catal parameters: - X-CALLER-ID - endTime - id - startTime required: - id - name: api_retrievesTheDevice_sCLIsOfTheICAPIntent method: GET uri: /dna/intent/api/v1/icapSettings/configurationModels/{previewActivityId}/networkDevices/{networkDeviceId}/config api_version: 2.3.7.9 description: Returns the device's CLIs of the ICAP intent. 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-spe parameters: - networkDeviceId - previewActivityId required: - previewActivityId - networkDeviceId - name: api_retrievesTheListOfAAAServicesForGivenParameters method: GET uri: /dna/data/api/v1/aaaServices api_version: 2.3.7.9 description: Retrieves the list of AAA Services and offers basic filtering and sorting capabilities. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco- parameters: - X-CALLER-ID - deviceId - deviceName - deviceSiteHierarchyId - endTime - limit - offset - order - serverIp - siteHierarchy - siteId - sortBy - startTime required: [] - name: api_retrievesTheListOfClients_WhileAlsoOfferingBasicFil_820210a0 method: GET uri: /dna/data/api/v1/clients api_version: 2.3.7.9 description: Retrieves the list of clients, while also offering basic filtering and sorting capabilities. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/c parameters: - X-CALLER-ID - attribute - band - connectedNetworkDeviceName - endTime - ipv4Address - ipv6Address - limit - macAddress - offset - order - osType - osVersion - siteHierarchy - siteHierarchyId - siteId - sortBy - ssid - startTime - type - view - wlcName required: [] - name: api_retrievesTheListOfDHCPServicesForGivenParameters method: GET uri: /dna/data/api/v1/dhcpServices api_version: 2.3.7.9 description: Retrieves the list of DHCP Services and offers basic filtering and sorting capabilities. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco parameters: - X-CALLER-ID - deviceId - deviceName - deviceSiteHierarchy - deviceSiteHierarchyId - deviceSiteId - endTime - limit - offset - order - serverIp - sortBy - startTime required: [] - name: api_retrievesTheListOfDNSServicesForGivenParameters method: GET uri: /dna/data/api/v1/dnsServices api_version: 2.3.7.9 description: Retrieves the list of DNS Services and offers basic filtering and sorting capabilities. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco- parameters: - X-CALLER-ID - deviceId - deviceSiteHierarchyId - deviceSiteId - endTime - limit - offset - order - serverIp - sortBy - ssid - startTime required: [] - name: api_retrievesTheListOfNetworkApplicationsAlongWithExper_23fa3c77 method: GET uri: /dna/data/api/v1/networkApplications api_version: 2.3.7.9 description: Retrieves the list of network applications along with experience and health metrics. If startTime and endTime are not provided, the API defaults to the last 24 hours. `siteId` is mandatory. `siteId` must be a site UUID o parameters: - X-CALLER-ID - applicationName - attribute - businessRelevance - endTime - limit - offset - order - siteId - sortBy - ssid - startTime required: - siteId - name: api_retrievesTheListOfNetworkProfilesForSites method: GET uri: /dna/intent/api/v1/networkProfilesForSites api_version: 3.3.1 description: Retrieves the list of network profiles for sites. parameters: - limit - offset - order - sortBy - type required: [] - name: api_retrievesTheListOfNetworkProfilesThatTheGivenSiteHa_0bebd066 method: GET uri: /dna/intent/api/v1/sites/{siteId}/profileAssignments api_version: 3.3.1 description: 'Retrieves the list of profiles that the given site has been assigned. These profiles may either be directly assigned to this site, or were assigned to a parent site and have been inherited. These assigments can be modi' parameters: - limit - offset - siteId required: - siteId - name: api_retrievesTheListOfSitesThatTheGivenNetworkProfileFo_cb2b520e method: GET uri: /dna/intent/api/v1/networkProfilesForSites/{profileId}/siteAssignments api_version: 3.3.1 description: 'Retrieves the list of sites that the given network profile for sites is assigned to. The list includes the sites the profile has been directly assigned to, as well as child sites that have inherited the profile.' parameters: - limit - offset - profileId required: - profileId - name: api_retrievesTheListOfThousandEyesTestResultsAlongWithR_c8c74987 method: GET uri: /dna/data/api/v1/thousandEyesTestResults api_version: 2.3.7.9 description: 'Retrieves the list of ThousandEyes test results along with related metrics. If `startTime` and `endTime` are not provided, the API defaults to the last 24 hours. Please note that `siteId` filter (if used) should be usin' parameters: - X-CALLER-ID - agentId - attribute - endTime - limit - networkDeviceName - offset - order - siteId - sortBy - startTime - testId - testName - testType required: [] - name: api_retrievesTheListOfValidationWorkflows method: GET uri: /dna/intent/api/v1/diagnosticValidationWorkflows api_version: 2.3.7.9 description: Retrieves the workflows that have been successfully submitted and are currently available. This is sorted by `submitTime` parameters: - endTime - limit - offset - runStatus - startTime required: [] - name: api_retrievesTheMaintenanceScheduleInformation method: GET uri: /dna/intent/api/v1/networkDeviceMaintenanceSchedules/{id} api_version: 2.3.7.9 description: API to retrieve the maintenance schedule information for the given id. parameters: - id required: - id - name: api_retrievesTheSpectrumInterferenceDevicesReportsSentB_e4e5f9fd method: GET uri: /dna/data/api/v1/icap/spectrumInterferenceDeviceReports api_version: 2.3.7.9 description: Retrieves the spectrum interference devices reports sent by WLC for provided AP Mac. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en- parameters: - X-CALLER-ID - apMac - endTime - limit - offset - startTime - timeSortOrder required: - apMac - name: api_retrievesTheSpectrumSensorReportsSentByWLCForProvidedAPMac method: GET uri: /dna/data/api/v1/icap/spectrumSensorReports api_version: 2.3.7.9 description: Retrieves the spectrum sensor reports sent by WLC for provided AP Mac. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmabilit parameters: - X-CALLER-ID - apMac - dataType - endTime - limit - offset - startTime - timeSortOrder required: - apMac - name: api_retrievesTheTotalCountOfClientsByApplyingBasicFiltering method: GET uri: /dna/data/api/v1/clients/count api_version: 2.3.7.9 description: Retrieves the number of clients by applying basic filtering. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/catalyst parameters: - X-CALLER-ID - band - connectedNetworkDeviceName - endTime - ipv4Address - ipv6Address - macAddress - osType - osVersion - siteHierarchy - siteHierarchyId - siteId - ssid - startTime - type - wlcName required: [] - name: api_retrievesTheTotalCountOfNetworkApplicationsByApplyi_72ae1f9d method: GET uri: /dna/data/api/v1/networkApplications/count api_version: 2.3.7.9 description: Retrieves the number of network applications by applying basic filtering. If startTime and endTime are not provided, the API defaults to the last 24 hours. `siteId` is mandatory. `siteId` must be a site UUID of a buildin parameters: - X-CALLER-ID - applicationName - businessRelevance - endTime - siteId - ssid - startTime required: - siteId - name: api_retrievesTheTotalCountOfThousandEyesTestResults method: GET uri: /dna/data/api/v1/thousandEyesTestResults/count api_version: 2.3.7.9 description: Retrieves the total count of ThousandEyes test results for the given filters. If `startTime` and `endTime` are not provided, the API defaults to the last 24 hours. For detailed information about the usage of the API, pl parameters: - X-CALLER-ID - agentId - endTime - networkDeviceName - siteId - startTime - testId - testName - testType required: [] - name: api_retrievesTheTotalNumberOfAAAServicesForGivenParameters method: GET uri: /dna/data/api/v1/aaaServices/count api_version: 2.3.7.9 description: Retrieves the total number of AAA Services for given parameters. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/cata parameters: - X-CALLER-ID - deviceId - deviceName - deviceSiteHierarchy - deviceSiteHierarchyId - deviceSiteId - endTime - serverIp - startTime required: [] - name: api_retrievesTheTotalNumberOfDHCPServicesForGivenParameters method: GET uri: /dna/data/api/v1/dhcpServices/count api_version: 2.3.7.9 description: Retrieves the total number of DHCP Services for given parameters. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/cat parameters: - X-CALLER-ID - deviceId - deviceName - deviceSiteHierarchy - deviceSiteHierarchyId - deviceSiteId - endTime - serverIp - startTime required: [] - name: api_retrievesTheTotalNumberOfDNSServicesForGivenParameters method: GET uri: /dna/data/api/v1/dnsServices/count api_version: 2.3.7.9 description: Retrieves the total number of DNS Services for given parameters. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-programmability/cata parameters: - X-CALLER-ID - deviceId - deviceSiteHierarchyId - deviceSiteId - endTime - serverIp - ssid - startTime required: [] - name: api_retrievesTheTotalNumberOfPacketCaptureFilesMatching_e4bb30c7 method: GET uri: /dna/data/api/v1/icap/captureFiles/count api_version: 2.3.7.9 description: Retrieves the total number of packet capture files matching the specified criteria. For detailed information about the usage of the API, please refer to the Open API specification document - https://github.com/cisco-en-p parameters: - X-CALLER-ID - apMac - clientMac - endTime - startTime - type required: - type - name: api_retrievesValidationDetailsForAValidationSet method: GET uri: /dna/intent/api/v1/diagnosticValidationSets/{id} api_version: 2.3.7.9 description: Retrieves validation details for the given validation set id parameters: - id required: - id - name: api_retrievesValidationWorkflowDetails method: GET uri: /dna/intent/api/v1/diagnosticValidationWorkflows/{id} api_version: 2.3.7.9 description: Retrieves workflow details for a workflow id parameters: - id required: - id - name: api_returnListOfReplacementDevicesWithReplacementDetails method: GET uri: /dna/intent/api/v1/device-replacement api_version: 2.3.7.9 description: Preferred tool for listing replacement devices and their details. Use this tool for any query about device replacement status, device family, or serial numbers. Filters by Faulty Device Name, Faulty Device Platform, Repl parameters: - family - faultyDeviceName - faultyDevicePlatform - faultyDeviceSerialNumber - hasNeighborDevice - limit - offset - replacementDevicePlatform - replacementDeviceSerialNumber - replacementStatus - siteId - sortBy - sortOrder required: [] - name: api_returnReplacementDevicesCount method: GET uri: /dna/intent/api/v1/device-replacement/count api_version: 2.3.7.9 description: Get replacement devices count parameters: - family - faultyDeviceName - faultyDevicePlatform - faultyDeviceSerialNumber - replacementDevicePlatform - replacementDeviceSerialNumber - replacementStatus required: [] - name: api_returnsAllIssueTriggerDefinitionsForGivenFilters method: GET uri: /dna/intent/api/v1/systemIssueDefinitions api_version: 2.3.7.9 description: Get all system issue defintions. The supported filters are id, name, profileId and definition enable status. An issue trigger definition can be different across the profile and device type. So, `profileId` and `deviceTyp parameters: - X-CALLER-ID - attribute - deviceType - id - issueEnabled - limit - name - offset - order - priority - profileId - sortBy required: [] - name: api_returnsCountOfAdd_onImages method: GET uri: /dna/intent/api/v1/images/{id}/addonImages/count api_version: 2.3.7.9 description: Count of add-on images available for the given software image identifier, `id` can be obtained from the response of API [ /dna/intent/api/v1/images?hasAddonImages=true ]. parameters: - id required: - id - name: api_returnsCountOfSoftwareImages method: GET uri: /dna/intent/api/v1/images/count api_version: 2.3.7.9 description: 'Returns the software-image count for a site. Requirements: - Resolve `siteId` via `api_getSites` unless the user already gave a valid UUID. Use `name="Global"` for the global site. - State what the count covers: importe' parameters: - golden - hasAddonImages - imported - integrity - isAddonImages - name - productNameOrdinal - siteId - supervisorProductNameOrdinal - version required: [] - name: api_returnsListOfSoftwareImages method: GET uri: /dna/intent/api/v1/images api_version: 2.3.7.9 description: 'Retrieves software images for a site. Requirements: - Resolve `siteId` via `api_getSites` unless the user already gave a valid UUID. Use `name="Global"` for the global site. - State what the response includes: imported ' parameters: - golden - hasAddonImages - imported - integrity - isAddonImages - limit - name - offset - productNameOrdinal - siteId - supervisorProductNameOrdinal - version required: - limit - name: api_returnsNetworkDeviceProductNamesForASite method: GET uri: /dna/intent/api/v1/siteWiseProductNames api_version: 2.3.7.9 description: '**Tool Dependency: CRITICAL**\n\nReturns the list of network device product names (for example, Wireless Controller, Switches and Hubs) for a specific site, along with counts and image metadata.\n\n**REQUIRED PRE-REQUISI' parameters: - limit - offset - productName - siteId required: - limit - name: api_returnsPOEInterfaceDetailsForTheDevice method: GET uri: /dna/intent/api/v1/network-device/{deviceUuid}/interface/poe-detail api_version: 2.3.7.9 description: Returns POE interface details for the device, where deviceuuid is mandatory & accepts comma seperated interface names which is optional and returns information for that particular interfaces where(operStatus = operationa parameters: - deviceUuid - interfaceNameList required: - deviceUuid - name: api_returnsTheCountOfNetworkDeviceProductNamesForASite method: GET uri: /dna/intent/api/v1/siteWiseProductNames/count api_version: 2.3.7.9 description: Returns the count of network device product names for a given site based on optional filters. ALWAYS call the `api_getSites` tool first to resolve the relevant site UUID—even when falling back to the global site (call it parameters: - productName - siteId required: [] - name: api_returnsTheImageSummaryForTheGivenSite method: GET uri: /dna/intent/api/v1/siteWiseImagesSummary api_version: 2.3.7.9 description: '**Tool Dependency: CRITICAL**\n\nReturns aggregate image statistics (counts of product names, golden/non-golden, imported images, advisor recommendations) for a specific site.\n\n**REQUIRED PRE-REQUISITE:**\nYou MUST cal' parameters: - siteId required: [] - name: api_sdaFabricSitesReadiness method: GET uri: /dna/intent/api/v1/securityServiceInsertion/fabricSitesReadiness api_version: 2.3.7.9 description: Gets a list of all SDA fabric sites along with their readiness status for Security Service Insertion (SSI) deployment. parameters: - order - sortBy required: [] - name: api_securityServiceInsertionById method: GET uri: /dna/intent/api/v1/securityServiceInsertions/{id} api_version: 2.3.7.9 description: Retrieves the details of a specific Security Service Insertion (SSI) by its ID. parameters: - id required: - id - name: api_securityServiceInsertionReadiness method: GET uri: /dna/intent/api/v1/securityServiceInsertion/systemReadiness api_version: 2.3.7.9 description: Gets readiness information for Security Service Insertion, including integration status, security group details, and access control information. parameters: [] required: [] - name: api_securityServiceInsertionSummary method: GET uri: /dna/intent/api/v1/securityServiceInsertionSummaries api_version: 2.3.7.9 description: Retrieves a summary of all Security Service Insertions (SSIs) sorted by fabricSiteName. parameters: - fabricSiteName - limit - offset - order required: [] - name: api_securityServiceInsertions method: GET uri: /dna/intent/api/v1/securityServiceInsertions api_version: 2.3.7.9 description: Retrieves a list of all Security Service Insertions (SSIs) configured across fabric sites, sorted by name. parameters: - limit - name - offset - order required: [] - name: api_sensorTestResults method: GET uri: /dna/intent/api/v1/AssuranceGetSensorTestResults api_version: 2.3.7.9 description: Intent API to get SENSOR test result summary parameters: - endTime - siteId - startTime - testFailureBy required: [] - name: api_sensors method: GET uri: /dna/intent/api/v1/sensor api_version: 2.3.7.9 description: Intent API to get a list of SENSOR devices parameters: - siteId required: [] - name: api_smartAccountDetails method: GET uri: /dna/intent/api/v1/licenses/smartAccounts api_version: 2.3.7.9 description: '**Licensing Smart Account Details**. Retrieve Licensing Smart Account information (name, id, domain, status).\n\n**Execution Policy (MANDATORY):**\n- For Catalyst licensing queries, use this tool directly.\n- Do NOT ask ' parameters: [] required: [] - name: api_statusOfTemplateDeployment method: GET uri: /dna/intent/api/v1/template-programmer/template/deploy/status/{deploymentId} api_version: 2.3.7.9 description: API to retrieve the status of template deployment. parameters: - deploymentId required: - deploymentId - name: api_systemHealthAPI method: GET uri: /dna/intent/api/v1/diagnostics/system/health api_version: 2.3.7.9 description: This API retrieves the latest system events parameters: - domain - limit - offset - subdomain - summary required: [] - name: api_systemHealthCountAPI method: GET uri: /dna/intent/api/v1/diagnostics/system/health/count api_version: 2.3.7.9 description: This API gives the count of the latest system events parameters: - domain - subdomain required: [] - name: api_systemLicensingLastOperationStatus method: GET uri: /dna/system/api/v1/license/lastOperationStatus api_version: 2.3.7.9 description: '**Tool Dependency: NONE** Retrieves the task completion status of the last/most recent licensing operation or task executed for Cisco Catalyst Center system. This is a standalone API with no prerequisites. **Use Cases:' parameters: [] required: [] - name: api_systemPerformanceAPI method: GET uri: /dna/intent/api/v1/diagnostics/system/performance api_version: 2.3.7.9 description: Retrieves the aggregated metrics (total, average or maximum) of cluster key performance indicators (KPIs), such as CPU utilization, memory utilization or network rates recorded within a specified time period. The data wi parameters: - endTime - function - kpi - startTime required: [] - name: api_systemPerformanceHistoricalAPI method: GET uri: /dna/intent/api/v1/diagnostics/system/performance/history api_version: 2.3.7.9 description: Retrieves the average values of cluster key performance indicators (KPIs), like CPU utilization, memory utilization or network rates grouped by time intervals within a specified time range. The data will be available fro parameters: - endTime - kpi - startTime required: [] - name: api_theTrendAnalyticsDataForAFabricSiteInTheSpecifiedTimeRange method: GET uri: /dna/data/api/v1/fabricSiteHealthSummaries/{id}/trendAnalytics api_version: 2.3.7.9 description: 'Get health time series for a specific Fabric Site by providing the unique Fabric site id in the url path. The data will be grouped based on the specified trend time interval. If startTime and endTime are not provided, th' parameters: - X-CALLER-ID - attribute - endTime - id - limit - offset - order - startTime - trendInterval required: - id - trendInterval - name: api_theTrendAnalyticsDataForATransitNetworkInTheSpecifi_5c01728a method: GET uri: /dna/data/api/v1/transitNetworkHealthSummaries/{id}/trendAnalytics api_version: 2.3.7.9 description: 'Get health time series for a specific Transit Network by providing the unique Transit Network id in the url path. The data will be grouped based on the specified trend time interval. If startTime and endTime are not prov' parameters: - X-CALLER-ID - attribute - endTime - id - limit - offset - order - startTime - trendInterval required: - id - trendInterval - name: api_theTrendAnalyticsDataForAVirtualNetworkInTheSpecifi_66fff53f method: GET uri: /dna/data/api/v1/virtualNetworkHealthSummaries/{id}/trendAnalytics api_version: 2.3.7.9 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 ' parameters: - X-CALLER-ID - attribute - endTime - id - limit - offset - order - startTime - trendInterval required: - id - trendInterval - name: api_theTrendAnalyticsDataForThousandEyesTestResultsInTh_312f30ed method: GET uri: /dna/data/api/v1/thousandEyesTestResults/trendAnalytics api_version: 2.3.7.9 description: 'Get trend time series for ThousandEyes test results. The 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. By default' parameters: - X-CALLER-ID - agentId - endTime - limit - networkDeviceName - offset - order - siteId - startTime - testId - testName - testType - trendInterval required: [] - name: api_virtualAccountDetails method: GET uri: /dna/intent/api/v1/licenses/smartAccount/{smart_account_id}/virtualAccounts api_version: 2.3.7.9 description: '**Licensing Virtual Account Details** (Tool Dependency: CRITICAL). Retrieve Virtual Account details for a specific Licensing Smart Account.\n\n**Execution Policy (MANDATORY):**\n- Use this tool directly for licensing vir' parameters: - smart_account_id required: - smart_account_id - name: api_wirelessRogueAPContainmentStatus method: GET uri: /dna/intent/api/v1/security/rogue/wireless-containment/status/{macAddress} api_version: 2.3.7.9 description: Intent API to check the wireless rogue access point containment status. The response includes all the details like containment status, contained by WLC, containment status of each BSSID etc. This API also includes the in parameters: - Content-Type - macAddress required: - Content-Type - macAddress other_cisco_mcp_repos: - repo: https://github.com/cisco-en-programmability/catalyst_center_iac_mcpserver note: Catalyst Center infrastructure-as-code MCP server, same Cisco org - repo: https://github.com/CiscoDevNet/catalyst-sdwan-mcp-community note: Catalyst SD-WAN Manager (vManage) MCP server — a different product, listed here only to prevent confusion