catalyst-center

Documentation

Documentation link · transport

Tools

• api_applications — 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.
• api_ciscoCatalystCenterNodesConfigurationSummary — 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
• api_ciscoCatalystCenterPackagesSummary — Provides information such as name, version of packages installed on the Cisco Catalyst Center.
• api_ciscoCatalystCenterReleaseSummary — 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.
• api_ciscoISEServerIntegrationStatus — 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
• api_clientProximity — 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
• api_complianceDetailsOfDevice — **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
• api_complianceRemediation — 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
• api_countClientsEnergy — 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
• api_countDevicesEnergy — 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
• api_countOfEventSubscriptions — 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
• api_countOfEvents — Get the count of registered events with provided eventIds or tags as mandatory
• api_countOfNetworkDeviceConfigurationFiles — 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
• api_countOfNetworkDeviceImageUpdates — Returns the count of network device image updates based on the given filter criteria
• api_countOfNetworkProductNames — Count of product names based on filter criteria
• api_countOfNotifications — 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
• api_countOfSecurityServiceInsertionSummaries — Retrieves the total count of Security Service Insertion (SSI) summaries.
• api_countOfSecurityServiceInsertions — Retrieves the count of Security Service Insertions.
• api_countSitesEnergy — 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
• api_countSitesEnergyForTheGivenTaskID — 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
• api_countTheNumberOfEvents — 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
• api_countTheNumberOfNetworkDevices — 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.
• api_countsGlobalIPAddressPools — 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
• api_countsIPAddressSubpools — 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
• api_countsSubpoolsOfAGlobalIPAddressPool — 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
• api_custom_promptSupportGETAPI — Returns supported custom prompts by Catalyst Center
• api_deviceComplianceStatus — Get detailed compliance breakdown by type (PSIRT, EOX, CONFIG, IMAGE) with source-level violations for a device.
• api_devices — Intent API for accessing DNA Assurance Device object for generating reports, creating dashboards or creating additional value added services.
• api_disasterRecoveryOperationalStatus — Returns the status of Disaster Recovery operation performed on the system.
• api_disasterRecoveryStatus — Detailed and Summarized status of DR components (Active, Standby and Witness system's health).
• api_downloadAFileByFileId — Downloads a file specified by fileId
• api_downloadFlexibleReport — 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
• api_downloadReportContent — 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.
• api_downloadsASpecificICAPPacketCaptureFile — 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
• api_eventArtifactCount — 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
• api_fetchTheCountOfEndpoints — Fetch the total count of endpoints that match the given filter criteria.
• api_get802_11beProfileByID — This API allows the user to get 802.11be Profile by ID
• api_get802_11beProfiles — This API allows the user to get 802.11be Profile(s) configured under Wireless Settings
• api_get802_11beProfilesCount — This API allows the user to get count of all 802.11be Profile(s)
• api_getAAAAttributeAPI — Get the current value of the custom AAA attribute.
• api_getAAAOverrideVlanSettingsBySite — This API allows the user to get all Flex Connect AAA Override VLAN settings at the given site
• api_getAAARadiusAttributesConfigurationFeatureTemplate — This API allows users to retrieve a specific AAA Radius Attributes configuration feature template by ID.
• api_getAIEndpointAnalyticsAttributeDictionaries — Fetches the list of attribute dictionaries.
• api_getANCPolicies — Fetches the list of ANC policies available in ISE.
• api_getAPAuthorizationListByID — This API allows the user to get an AP Authorization List by AP Authorization List ID that captured in wireless settings design.
• api_getAPAuthorizationListByNetworkDeviceId — 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-
• api_getAPAuthorizationListCount — This API allows the user to get count of all AP Authorization lists.
• api_getAPAuthorizationLists — 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
• api_getAPPnPLocationSetting — 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
• api_getAPProfileByID — This API allows the user to get a AP Profile by AP Profile ID that captured in wireless settings design
• api_getAPProfiles — This API allows the user to get AP profiles that are captured in wireless settings design.
• api_getAPProfilesCount — This API returns the total number of AP Profiles available.
• api_getAScheduledReport — Get scheduled report configuration by reportId
• api_getAccessPointConfigurationTaskResult — Users can query the access point configuration result using this intent API
• api_getAccessPointRebootTaskResult — Users can query the access point reboot status using this intent API
• api_getAccessPoint_s_FactoryResetStatus — This API returns each AP Factory Reset initiation status.
• api_getAccessPointsPositions — Retrieve all Access Points positions assigned for a specific floor
• api_getAccessPointsPositionsCount — Retrieve Access Points positions count assigned for a specific floor
• api_getActivities — Returns activity(s) based on filter criteria
• api_getActivityByID — Returns the activity with the given ID
• api_getAdvancedSSIDConfigurationFeatureTemplate — This API allows users to retrieve a specific Advanced SSID configuration feature template by ID.
• api_getAllBackup — **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
• api_getAllExecutionDetailsForAGivenReport — Get details of all executions for a given report
• api_getAllFlexibleReportSchedules — Get all flexible report schedules
• api_getAllGlobalCredentialsV2 — API to get device credentials' details. It fetches all global credentials of all types at once, without the need to pass any input parameters.
• api_getAllHealthScoreDefinitionsForGivenFilters — 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
• api_getAllITSMIntegrationSettings — 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
• api_getAllInterfaces — 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
• api_getAllKeywordsOfCLIsAcceptedByCommandRunner — Get valid keywords
• api_getAllTheCustomIssueDefinitionsBasedOnTheGivenFilters — 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
• api_getAllTheDetailsAndSuggestedActionsOfAnIssueForTheG_34a1791b — 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
• api_getAllowedMacAddress — Intent API to fetch all the allowed mac addresses in the system.
• api_getAllowedMacAddressCount — Intent API to fetch the count of allowed mac addresses in the system.
• api_getAnchorCapableDevices — This API allows the user to get Anchor capable devices
• api_getAnchorGroupByID — This API allows the user to get an AnchorGroup by AnchorGroup ID
• api_getAnchorGroups_v2_3_7_10 — This API allows the user to get AnchorGroups that captured in wireless settings design.
• api_getAnchorManagedAPLocationsForSpecificWirelessController — 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
• api_getApplicationCount — Get the number of all existing applications
• api_getApplicationPolicy — Get all existing application policies
• api_getApplicationPolicyDefault — Get default application policy
• api_getApplicationPolicyQueuingProfile — Get all or by name, existing application policy queuing profiles
• api_getApplicationPolicyQueuingProfileCount — Get the number of all existing application policy queuing profile
• api_getApplicationSetCount — Get the number of all existing application sets
• api_getApplicationSet_s — Get application set/s by offset/limit or by name
• api_getApplicationSets — Get appllication-sets by offset/limit or by name
• api_getApplicationSetsCount — Get the number of existing application-sets
• api_getApplication_s — Get application/s by offset/limit or by name
• api_getApplications — Get applications by offset/limit or by name
• api_getApplicationsCount — Get the number of all existing applications
• api_getAuditLogParentRecords — Get Parent Audit Log Event instances from the Event-Hub
• api_getAuditLogRecords — Get Audit Log Event instances from the Event-Hub
• api_getAuditLogSummary — Get Audit Log Summary from the Event-Hub
• api_getAuthenticationAndPolicyServers — 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
• api_getBackupById — **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
• api_getBackupConfiguration — **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
• api_getBackupRestoreExecution — **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
• api_getBackupRestoreExecutions — **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
• api_getBackupStorages — **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
• api_getBugAffectingTheNetworkDeviceByDeviceIdAndBugId — Get bug affecting the network device by device Id and bug id
• api_getBugsAffectingTheNetworkDevice — Get bugs affecting the network device
• api_getBusinessAPIExecutionDetails — Retrieves the execution details of a Business API
• api_getCMDBSyncStatus — 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
• api_getChassisDetailsForDevice — Returns chassis details for given device ID
• api_getCleanAirConfigurationFeatureTemplate — This API allows users to retrieve a specific Clean Air configuration feature template by ID.
• api_getClientDetail — Returns detailed Client information retrieved by Mac Address for any given point of time.
• api_getClientEnergyByID — 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
• api_getClientEnrichmentDetails — 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
• api_getClientEnrichmentDetailsV2 — 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
• api_getClientsEnergy — 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
• api_getComplianceDetail — 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
• api_getComplianceDetailCount — "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
• api_getComplianceStatus — 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
• api_getComplianceStatusCount — "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
• api_getConfigTaskDetails — Returns a config task result details by specified id
• api_getConfigurationArchiveDetails — **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
• api_getConfigurationFileDetailsByID — Retrieves the details of a specific network device configuration file using the `id`.
• api_getConfigurationsForADeployedLayer2FeatureOnAWiredDevice — The API returns configurations for a deployed layer 2 feature on a wired device.
• api_getConfigurationsForAnIntendedLayer2FeatureOnAWiredDevice — 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
• api_getConfigurationsForIntendedLayer2FeaturesOnAWiredDevice — 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
• api_getConnectedDeviceDetail — **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
• api_getConnectorTypes — Get the list of connector types
• api_getCountOfAllDiscoveryJobs — Returns the count of all available discovery jobs
• api_getCountOfAnchorGroups — This API allows the user to get count of all AnchorGroups
• api_getCountOfBugsAffectingTheNetworkDevice — Get count of bugs affecting the network device
• api_getCountOfFieldNoticeNetworkDevices — 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
• api_getCountOfFieldNoticeNetworkDevicesForTheNotice — Get count of field notice network devices for the notice
• api_getCountOfFieldNotices — 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
• api_getCountOfFieldNoticesAffectingTheNetworkDevice — 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
• api_getCountOfFieldNoticesResultsTrendOverTime — Get count of field notices results trend over time
• api_getCountOfNetworkBugDevices — 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
• api_getCountOfNetworkBugDevicesForTheBug — 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
• api_getCountOfNetworkBugs — 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
• api_getCountOfNetworkBugsResultsTrendOverTime — Get count of network bugs results trend over time
• api_getCountOfProfilingRules — 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
• api_getCountOfSecurityAdvisoriesAffectingTheNetworkDevice — **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
• api_getCountOfSecurityAdvisoriesAffectingTheNetworkDevices — 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
• api_getCountOfSecurityAdvisoriesResultsTrendOverTime — Get count of security advisories results trend over time.
• api_getCountOfSecurityAdvisoryNetworkDevices — Get count of security advisory network devices
• api_getCountOfSecurityAdvisoryNetworkDevicesForTheSecur_ffbe1ab0 — 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-
• api_getDetailsOfASingleAssuranceEvent — 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
• api_getDetailsOfASingleNetworkDevice — 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
• api_getDetailsOfASingleProfilingRule — Fetches details of the profiling rule for the given 'ruleId'.
• api_getDeviceByID — Returns the network device details for the given device ID
• api_getDeviceBySerialNumber — Returns the network device with given serial number
• api_getDeviceConfigById — Returns the device config by specified device ID
• api_getDeviceConfigCount — Returns the count of device configs
• api_getDeviceControllabilitySettings — 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
• api_getDeviceCredentialSettingsForASite — **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
• api_getDeviceDeploymentStatus — Returns device deployment status based on filter criteria.
• api_getDeviceDeploymentStatusCount — 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
• api_getDeviceEnergyByID — 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-
• api_getDeviceEnrichmentDetailsV2 — 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
• api_getDeviceHistory — Returns history for a specific device. Serial number is a required parameter
• api_getDeviceInterfaceCount — Returns the interface count for the given device
• api_getDeviceInterfaceVLANs — Returns Device Interface VLANs. If parameter value is null or empty, it won't return any value in response.
• api_getDeviceInterfacesBySpecifiedRange — Returns the list of interfaces for the device for the specified range
• api_getDeviceSummary — Returns brief summary of device info for the given device Id
• api_getDeviceValuesThatMatchFullyOrPartiallyAnAttribute — 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
• api_getDevicesDiscoveredById — Returns the count of network devices discovered in the given discovery. Discovery ID can be obtained using the "Get Discoveries by range" API.
• api_getDevicesEnergy — 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/
• api_getDevicesRegisteredForWSANotification — 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.
• api_getDiscoveredDevicesByRange — 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.
• api_getDiscoveredNetworkDevicesByDiscoveryId — Returns the network devices discovered for the given Discovery ID. Discovery ID can be obtained using the "Get Discoveries by range" API.
• api_getDiscoveriesByRange — Returns the discoveries by specified range
• api_getDiscoveryById — Returns discovery by Discovery ID. Discovery ID can be obtained using the "Get Discoveries by range" API.
• api_getDiscoveryJobsByIP — Returns the list of discovery jobs for the given IP
• api_getDot11axConfigurationFeatureTemplate — This API allows users to retrieve a specific Dot11ax configuration feature template by ID.
• api_getDot11beStatusConfigurationFeatureTemplate — This API allows users to retrieve a specific Dot11be status configuration feature template by ID.
• api_getEmailDestination — Get Email Destination
• api_getEmailEventSubscriptions — Gets the list of email Subscriptions's based on provided query params
• api_getEmailSubscriptionDetails — Gets the list of subscription details for specified connectorType
• api_getEndpointDetails — Fetches details of the endpoint for the given unique identifier 'epId'.
• api_getEoXDetailsPerDevice — **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
• api_getEoXStatusForAllDevices — 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
• api_getEoXSummary — Retrieves EoX summary for all devices in the network
• api_getEventArtifacts — Gets the list of artifacts based on provided offset and limit
• api_getEventDrivenRRMConfigurationFeatureTemplate — This API allows users to retrieve a specific Event Driven RRM configuration feature template by ID.
• api_getEventSubscriptions — 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
• api_getEvents — Gets the list of registered Events with provided eventIds or tags as mandatory
• api_getExecutionIdByReportId — Get Execution Id by Report Id
• api_getExternalAuthenticationServersAPI — Get external users authentication servers.
• api_getExternalAuthenticationSettingAPI — Get the External Authentication setting.
• api_getFailedITSMEvents — Used to retrieve the list of integration events that failed to create tickets in ITSM
• api_getFeatureTemplateSummary — This API allows users to retrieve the feature template summary.
• api_getFieldNoticeAffectingTheNetworkDeviceByDeviceIdAndNoticeId — Get field notice affecting the network device by device Id and notice id
• api_getFieldNoticeById — 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,
• api_getFieldNoticeNetworkDeviceByDeviceId — 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
• api_getFieldNoticeNetworkDeviceForTheNoticeByNetworkDeviceId — 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
• api_getFieldNoticeNetworkDevices — 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
• api_getFieldNoticeNetworkDevicesForTheNotice — 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
• api_getFieldNotices — 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
• api_getFieldNoticesAffectingTheNetworkDevice — 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
• api_getFieldNoticesResultsTrendOverTime — Get field notices results trend over time. The default sort is by scan time descending.
• api_getFlexConnectConfigurationFeatureTemplate — This API allows users to retrieve a specific Flex Connect configuration feature template by ID.
• api_getFlexibleReportScheduleByReportId — Get flexible report schedule by report id
• api_getFloorSettings — Gets UI user preference for floor unit system.
• api_getFunctionalCapabilityById — Returns functional capability with given Id
• api_getFunctionalCapabilityForDevices — Returns the functional-capability for given devices
• api_getGlobalCredentials — Get credentials by type. Returns CLI, SNMP read, SNMP write, SNMPv3, HTTP read, HTTP write, or NETCONF credentials.
• api_getHealthScoreDefinitionForTheGivenId — 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
• api_getICAPConfigurationStatusPerNetworkDevice — 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
• api_getISISInterfaces — Returns the interfaces that has ISIS enabled
• api_getITSMIntegrationSettingById — Fetches ITSM Integration setting by ID
• api_getITSMIntegrationStatus — 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
• api_getInterfaceByIP — Returns list of interfaces for specified device management IP address
• api_getInterfaceById — Returns the interface for the given interface ID
• api_getInterfaces — **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,
• api_getInterfacesCount — This API allows the user to get count of all interfaces.
• api_getIssueEnrichmentDetails — 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
• api_getIssueEnrichmentDetailsV2 — 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
• api_getIssueTriggerDefinitionForGivenId — 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
• api_getL3TopologyDetails — Returns the Layer 3 network topology by routing protocol
• api_getLinecardDetails — Get line card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no.
• api_getListOfAvailableNamespaces — Returns list of available namespaces
• api_getListOfChildEventsForTheGivenWirelessClientEvent — 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
• api_getListOfDiscoveriesByDiscoveryId — 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.
• api_getListOfProfilingRules — 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
• api_getListOfScheduledReports — Get list of scheduled report configurations.
• api_getManagedAPLocationsCountForSpecificWirelessController — 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)
• api_getMeshApNeighbours — Retrieves all Mesh accesspoint Neighbours details whether child, parent, etc.
• api_getMeshApNeighboursCount — This API returns the total number of mesh Ap Neighbours available.
• api_getMobilityGroups — 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
• api_getMobilityGroupsCount — Retrieves count of mobility groups configured
• api_getModuleCount — Returns Module Count
• api_getModuleInfoById — Returns Module info by 'module id'
• api_getModules — 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
• api_getMulticastConfigurationFeatureTemplate — This API allows users to retrieve a specific Multicast configuration feature template by ID.
• api_getNativeVlanSettingsBySite — 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.
• api_getNetworkBugById — 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
• api_getNetworkBugDeviceByDeviceId — Get network bug device by device id
• api_getNetworkBugDeviceForTheBugByNetworkDeviceId — 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
• api_getNetworkBugDevices — 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
• api_getNetworkBugDevicesForTheBug — 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
• api_getNetworkBugs — 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
• api_getNetworkBugsResultsTrendOverTime — Get network bugs results trend over time. The default sort is by scan time descending.
• api_getNetworkDeviceByIP — Returns the network device by specified IP address. For PnP devices, use api_getPnPDeviceList/api_getPnPDeviceCount.
• api_getNetworkDeviceConfigurationFileDetails — 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
• api_getNetworkDevicesCredentialsSyncStatus — 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
• api_getNetworkDevicesFromDiscovery — Returns the devices discovered in the given discovery based on given filters. Discovery ID can be obtained using the "Get Discoveries by range" API.
• api_getNfsConfigurations — **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
• api_getNotifications — 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
• api_getNumberOfConfigurationsForADeployedLayer2FeatureOnADevice — The API returns the number of configurations for a deployed layer 2 feature on a device.
• api_getNumberOfConfigurationsForAnIntendedLayer2FeatureOnADevice — This API returns the count of the instances of the configurations for an intended layer 2 feature on a wired device.
• api_getOSPFInterfaces — Returns the interfaces that has OSPF enabled
• api_getOrganizationListForMeraki — Returns list of organizations for meraki dashboard
• api_getPendingFabricEvents — Returns a list of pending fabric events that match the provided query parameters.
• api_getPermissionsAPI — Get permissions for a role in the system.
• api_getPlannedAccessPointsForBuilding — Provides a list of Planned Access Points for the Building it is requested for
• api_getPlannedAccessPointsForFloor — Provides a list of Planned Access Points for the Floor it is requested for
• api_getPlannedAccessPointsPositions — Retrieve all Planned Access Points Positions designated for a specific floor
• api_getPlannedAccessPointsPositionsCount — Retrieve all Planned Access Points Positions count designated for a specific floor
• api_getPnPDeviceCount_legacy — 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
• api_getPnPDeviceList_legacy — 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
• api_getPnPGlobalSettings — Returns global PnP settings of the user
• api_getPollingIntervalById — Returns polling interval by device id
• api_getPollingIntervalForAllDevices — Returns polling interval of all devices
• api_getPortChannelInformationById — This API retrieves Port Channel information using its ID.
• api_getPortChannels — Returns a list of Port Channel between the LAN Automation associated devices.
• api_getPowerProfileByID — This API allows the user to get a Power Profile by Power Profile ID that captured in wireless settings design
• api_getPowerProfiles — This API allows the user to get Power Profiles that captured in wireless settings design.
• api_getPowerProfilesCount — This API returns the total number of Power Profiles available.
• api_getPrimaryManagedAPLocationsForSpecificWirelessController — 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
• api_getProject_s_Details — Get project(s) details
• api_getProvisionedDevices — Returns the count of provisioned devices based on query parameters. For PnP devices, use api_getPnPDeviceCount(state=Provisioned) instead.
• api_getProvisionedDevicesCount — Returns the count of provisioned devices based on query parameters. For PnP devices, use api_getPnPDeviceCount(state=Provisioned) instead.
• api_getProvisioningSettings — Returns provisioning settings
• api_getQosDeviceInterfaceInfo — Get all or by network device id, existing qos device interface infos
• api_getQosDeviceInterfaceInfoCount — Get the number of all existing qos device interface infos group by network device id
• api_getRFProfileByID — This API allows the user to get a RF Profile by RF Profile ID
• api_getRFProfiles — This API allows the user to get all RF Profiles
• api_getRFProfilesCount — This API allows the user to get count of all RF profiles
• api_getRRMFRAConfigurationFeatureTemplate — This API allows users to retrieve a specific RRM FRA configuration feature template by ID.
• api_getRRMGeneralConfigurationFeatureTemplate — This API allows users to retrieve a specific RRM General configuration feature template by ID.
• api_getRest_WebhookEventSubscriptions — Gets the list of Rest/Webhook Subscriptions's based on provided query params
• api_getRest_WebhookSubscriptionDetails — Gets the list of subscription details for specified connectorType
• api_getResyncIntervalForTheNetworkDevice — Fetch the reysnc interval for the given network device id.
• api_getRolesAPI — Get all roles in the system
• api_getSNMPDestination — Get SNMP Destination
• api_getSNMPProperties — Returns SNMP properties
• api_getSSIDByID — This API allows the user to get an SSID (Service Set Identifier) by ID at the given site
• api_getSSIDBySite — This API allows the user to get all SSIDs (Service Set Identifier) at the given site
• api_getSSIDCountBySite — This API allows the user to get count of all SSIDs (Service Set Identifier) .
• api_getSSIDCountForSpecificWirelessController — 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
• api_getSSIDDetailsForSpecificWirelessController — 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
• api_getSecondaryManagedAPLocationsForSpecificWirelessController — 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
• api_getSecurityAdvisoriesAffectingTheNetworkDevice — **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
• api_getSecurityAdvisoriesAffectingTheNetworkDevices — 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
• api_getSecurityAdvisoriesResultsTrendOverTime — Get security advisories results trend over time. The default sort is by scan time descending.
• api_getSecurityAdvisoryAffectingTheNetworkDeviceByDevic_978ac4ec — 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
• api_getSecurityAdvisoryAffectingTheNetworkDevicesById — 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
• api_getSecurityAdvisoryNetworkDeviceByNetworkDeviceId — Get security advisory network device by network device id
• api_getSecurityAdvisoryNetworkDeviceForTheSecurityAdvis_a527030a — 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
• api_getSecurityAdvisoryNetworkDevices — 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
• api_getSecurityAdvisoryNetworkDevicesForTheSecurityAdvisory — 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
• api_getServiceDeploymentStatus — Returns service deployment status based on filter criteria.
• api_getServiceProviderDetails — API to get service provider details (QoS).
• api_getServiceProviderDetailsV2 — API to get Service Provider details (QoS).
• api_getSiteAnalyticsForOneSite — 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/
• api_getSiteAnalyticsForTheChildSitesOfGivenParentSiteAn_104cea52 — 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
• api_getSiteAnalyticsSummaryDataForTheGivenTaskId — 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
• api_getSiteAnalyticsTrendDataForTheGivenTaskId — 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
• api_getSiteAssignedNetworkDevice — Site assigned network device. For PnP devices, use api_getPnPDeviceList/api_getPnPDeviceCount.
• api_getSiteEnergyByID — 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
• api_getSiteTopology — Returns site topology
• api_getSites — 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
• api_getSitesCount — 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
• api_getSitesEnergy — 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
• api_getStackDetailsForDevice — Retrieves complete stack details for given device ID
• api_getStatusAPIForEvents — Get the Status of events API calls with provided executionId as mandatory path parameter
• api_getSupervisorCardDetail — Get supervisor card detail for a given deviceuuid. Response will contain serial no, part no, switch no and slot no.
• api_getSyslogDestination — Get Syslog Destination
• api_getSyslogEventSubscriptions — Gets the list of Syslog Subscriptions's based on provided offset and limit
• api_getSyslogSubscriptionDetails — Gets the list of subscription details for specified connectorType
• api_getTag — **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,
• api_getTagById — Returns tag specified by Id
• api_getTagCount — **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.
• api_getTagMemberCount — **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
• api_getTagMembersById — **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
• api_getTagResourceTypes — **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
• api_getTaskDetails — Fetches the details of backend task. Task is typically created by making call to some other API that takes longer time to execute.
• api_getTaskDetailsByID — Returns the task details for the given task ID
• api_getTasks — Returns task(s) based on filter criteria
• api_getTasksByID — Returns the task with the given ID
• api_getTasksCount — Returns the number of tasks that meet the filter criteria
• api_getTemplateProject — Get a template project by the project's ID.
• api_getTemplateProjectCount — Get the count of all template projects.
• api_getTemplateProjects — Get all matching template projects based on the filters selected.
• api_getTemplateVersion — Get a template's version by the version ID.
• api_getTemplateVersions — Get a template's version information.
• api_getTemplateVersionsCount — Get the count of a template's version information.
• api_getTemplate_s_Details — Get template(s) details
• api_getTheCountOfHealthScoreDefinitionsBasedOnProvidedFilters — 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
• api_getTheCountOfSystemDefinedIssueDefinitionsBasedOnPr_45aa6c33 — 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
• api_getTheCustomIssueDefinitionForTheGivenCustomIssueDe_9bd4ac38 — 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
• api_getTheDetailsOfIssuesForGivenSetOfFilters_2 — 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
• api_getTheDetailsOfPhysicalComponentsOfTheGivenDevice — Return all types of equipment details like PowerSupply, Fan, Chassis, Backplane, Module, PROCESSOR, Other and SFP for the Given device.
• api_getTheInterfaceDataForTheGivenInterfaceId_instanceU_0b78da7f — 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
• api_getTheSupportedLayer2FeaturesOnAWiredDevice — The API returns the supported layer 2 features on a wired device.
• api_getTheTotalCustomIssueDefinitionsCountBasedOnThePro_240c53aa — 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
• api_getTheTotalNumberOfIssuesForGivenSetOfFilters — 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
• api_getTheTotalNumberOfSiteAnalyticsRecordsAvailableFor_25bb5c48 — 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
• api_getThreatLevels — Intent API to fetch all threat levels defined.
• api_getThreatTypes — Intent API to fetch all threat types defined.
• api_getTopNEntitiesRelatedToSiteAnalyticsForTheGivenTaskId — 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-
• api_getTopologyDetails — 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
• api_getTrialDetailsForBugsDetectionOnNetworkDevices — Get trial details for bugs detection on network devices
• api_getTrialDetailsForFieldNoticesDetectionOnNetworkDevices — Get trial details for field notices detection on network devices
• api_getTrialDetailsForSecurityAdvisoriesDetectionOnNetw_ff9164da — Get trial details for security advisories detection on network devices
• api_getTriggeredJobsByActivityId — Returns the triggered jobs by the activity with the given activity id
• api_getUserEnrichmentDetails — 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
• api_getUserEnrichmentDetailsV2 — 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
• api_getUsersAPI — Get all users in the system
• api_getVLANDetails — Returns the list of VLAN names that are involved in a loop as identified by the Spanning Tree Protocol
• api_getViewDetailsForAGivenViewGroup_View — 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.
• api_getViewsForAGivenViewGroup — 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.
• api_getWebhookDestination — Get Webhook Destination
• api_getWirelessLanControllerDetailsById — Returns the wireless lan controller info with given device ID
• api_getWirelessProfileByID — This API allows the user to get a Wireless Network Profile by ID
• api_getWirelessProfiles — This API allows the user to get all Wireless Network Profiles
• api_getWirelessProfilesCount — This API allows the user to get count of all wireless profiles
• api_getWorkflowById — Returns a workflow specified by id
• api_getWorkflowCount — Returns the workflow count
• api_getWorkflows — 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
• api_get_dna_intent_api_v1_global_credential_id — Returns the credential sub type for the given Id.
• api_getsAllTheVersionsOfAGivenTemplate — Get all the versions of template by its id
• api_getsDetailsOfAGivenTemplate — Details of the template by its id
• api_getsInterfacesAlongWithStatisticsAndPoeDataFromAllN_d99ee240 — Retrieves the list of the interfaces from all network devices based on the provided query parameters. The latest interfaces data in the specified start and end time range will be returned. When there is n
• api_getsTheDetailsOfAGivenProject — Get the details of the given project by its id.
• api_getsTheDeviceConfigForTheConfigurationModel — 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
• api_getsTheNetworkDeviceDetailsBasedOnTheProvidedQueryParameters — 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
• api_getsTheTemplatesAvailable — List the templates available
• api_getsTheTotalNetworkDeviceInterfaceCountsInTheSpecif_a404d76e — 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
• api_importMapArchive_ImportStatus — 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
• api_inventoryInsightDeviceLinkMismatchAPI — Find all devices with link mismatch (speed / vlan)
• api_issues — Intent API to get a list of global issues, issues for a specific device, or issue for a specific client device's MAC address.
• api_lANAutomationActiveSessions — Invoke this API to get the LAN Automation active session information
• api_lANAutomationLog — Invoke this API to get the LAN Automation session logs.
• api_lANAutomationLogById — Invoke this API to get the LAN Automation session logs based on the given LAN Automation session id.
• api_lANAutomationLogsForIndividualDevices — 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.
• api_lANAutomationSessionCount — Invoke this API to get the total count of LAN Automation sessions.
• api_lANAutomationStatus — 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
• api_lANAutomationStatusById — 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
• api_legitOperationsForInterface — **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
• api_licenseTermDetails — 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?
• api_listsICAPPacketCaptureFilesMatchingSpecifiedCriteria — 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
• api_mapsSupportedAccessPoints — Gets the list of supported access point types as well as valid antenna pattern names that can be used for each.
• api_pOEDetails — Returns POE details for device.
• api_querySitesEnergyForTheGivenTaskID — 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
• api_queryTheEndpoints — 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.
• api_readFabricSitesWithHealthSummaryFromId — 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
• api_readTransitNetworkWithItsHealthSummaryFromId — 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
• api_readVirtualNetworkWithItsHealthSummaryFromId — 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
• api_readinessStatusForAFabricSite — 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.
• api_readinessStatusOfSwitchesInASpecifiedVirtualNetwork_d64c1de3 — 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.
• api_retrieveAAASettingsForASite — 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
• api_retrieveACountOfTheNumberOfAssuranceTasksThatCurrentlyExist — 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
• api_retrieveAListOfAssuranceTasks — 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,
• api_retrieveANetworkProfileForSitesById — Retrieves a network profile for sites by id.
• api_retrieveASpecificAssuranceTaskById — 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
• api_retrieveASpecificPolicyTagForAWirelessProfile — 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`.
• api_retrieveASpecificSiteTagForAWirelessProfile — 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`.
• api_retrieveAllPolicyTagsForAWirelessProfile — 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.
• api_retrieveAllSiteTagsForAWirelessProfile — 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.
• api_retrieveApplicableAdd_onImagesForTheGivenSoftwareImage — 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 ].
• api_retrieveBannerSettingsForASite — **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
• api_retrieveCLITemplatesAttachedToANetworkProfile — Retrieves a list of CLI templates attached to a network profile based on the network profile ID.
• api_retrieveCountOfCLITemplatesAttachedToANetworkProfile — Retrieves the count of all CLI templates attached to a network profile by the profile ID.
• api_retrieveCountOfNetworkProfilesAttachedToACLITemplate — Retrieves the count of network profiles that a CLI template has been attached to by the template ID.
• api_retrieveDHCPSettingsForASite — **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
• api_retrieveDNSSettingsForASite — **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
• api_retrieveImageDistributionServers — 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.
• api_retrieveImageDistributionSettingsForASite — **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
• api_retrieveLicenseSetting — 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
• api_retrieveNTPSettingsForASite — **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
• api_retrieveNetworkDeviceProductName — Get the network device product name, its ordinal, and supported PIDs.
• api_retrieveNetworkDevices — 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 '
• api_retrieveScheduledMaintenanceWindowsForNetworkDevices — 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(`
• api_retrieveSitesWithOverriddenSSIDs — Retrieve list of siteId(s) with information of SSID(s) which are overridden
• api_retrieveSpecificImageDistributionServer — Retrieve image distribution server for the given server identifier
• api_retrieveTagsAssociatedWithNetworkDevices — **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
• api_retrieveTagsAssociatedWithTheInterfaces — **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
• api_retrieveTelemetrySettingsForASite — 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
• api_retrieveTheCountOfInterfacesThatAreAssociatedWithAt_6c330a1b — 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.
• api_retrieveTheCountOfNetworkDevicesForTheGivenApplicat_cdbaad0f — This API retrieves the count of network devices for the given application visibility status filters.
• api_retrieveTheCountOfNetworkDevicesThatAreAssociatedWi_b9832de8 — 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.
• api_retrieveTheCountOfPolicyTagsForAWirelessProfile — 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.
• api_retrieveTheCountOfSiteTagsForAWirelessProfile — 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.
• api_retrieveTheListOfNetworkDevicesWithTheirApplication_479dd261 — 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.
• api_retrieveTheNetworkProfilesAttachedToACLITemplate — Retrieves the list of network profiles that a CLI template is currently attached to by the template ID.
• api_retrieveTheStatusOfAllTheDeviceReplacementWorkflows — 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
• api_retrieveTheStatusOfDeviceReplacementWorkflowThatRep_a2407523 — 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
• api_retrieveTheTotalNumberOfScheduledMaintenanceWindows — Retrieve the total count of all scheduled maintenance windows for network devices.
• api_retrieveTimeZoneSettingsForASite — **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
• api_retrievesAGlobalIPAddressPool — 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
• api_retrievesAllPreviousPathtracesSummary — Returns a summary of all flow analyses stored. Results can be filtered by specified parameters.
• api_retrievesAllTheValidationSets — Retrieves all the validation sets and optionally the contained validations
• api_retrievesAnIPAddressSubpool — 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
• api_retrievesCSSMConnectionMode — Retrieves Cisco Smart Software Manager (CSSM) connection mode setting.
• api_retrievesCiscoIMCConfigurationsForCatalystCenterNodes — 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
• api_retrievesConfigurationDetailsOfTheExternalIPAMServer — 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
• api_retrievesDeployedICAPConfigurationsWhileSupportingB_0c45cdf6 — 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
• api_retrievesDetailsOfASpecificICAPPacketCaptureFile — 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
• api_retrievesDiagnosticTaskByID — This API retrieves the diagnostic task identified by the specified `id`.
• api_retrievesDiagnosticTaskDetailsByID — This API retrieves the details of the diagnostic task identified by the specified `id`.
• api_retrievesGlobalIPAddressPools — Retrieves global IP address pools. Do not use this or include global pool results in SLAAC, 'Dualstack', 'IPv4 only' and 'IPv6 only' questions. PRECEDENCE Apply sections in order. Higher sections override lower section
• api_retrievesIPAddressSubpools — 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
• api_retrievesPreviousPathtrace — Returns result of a previously requested flow analysis by its Flow Analysis id
• api_retrievesSpecificClientInformationMatchingTheMACAddress — 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
• api_retrievesSubpoolsIDsOfAGlobalIPAddressPool — 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
• api_retrievesSummaryOfNetworkDeviceLicenses — **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**
• api_retrievesTheApplicationQoSPolicySetting — API to retrieve the application QoS policy setting.
• api_retrievesTheCiscoIMCConfigurationForACatalystCenterNode — 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
• api_retrievesTheCountOfActivities — Retrieves the count of activities
• api_retrievesTheCountOfDeployedICAPConfigurationsWhileS_4d6c040d — 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
• api_retrievesTheCountOfNetworkProfilesForSites — Retrieves the count of network profiles for sites
• api_retrievesTheCountOfProfilesThatTheGivenSiteHasBeenAssigned — 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.
• api_retrievesTheCountOfSitesThatTheGivenNetworkProfileF_40cb52b6 — Retrieves the count of sites that the given network profile for sites is assigned to.
• api_retrievesTheCountOfTriggeredJobsByActivityId — Retrieves the count of triggered jobs by activity id.
• api_retrievesTheCountOfValidationWorkflows — Retrieves the count of workflows that have been successfully submitted and are currently available.
• api_retrievesTheDetailsOfASpecificAAAServiceMatchingThe_dacfed38 — 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
• api_retrievesTheDetailsOfASpecificDHCPServiceMatchingTh_323b9f73 — 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
• api_retrievesTheDetailsOfASpecificDNSServiceMatchingThe_9f12711c — 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
• api_retrievesTheDevice_sCLIsOfTheICAPIntent — 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
• api_retrievesTheListOfAAAServicesForGivenParameters — 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-
• api_retrievesTheListOfClients_WhileAlsoOfferingBasicFil_820210a0 — 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
• api_retrievesTheListOfDHCPServicesForGivenParameters — 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
• api_retrievesTheListOfDNSServicesForGivenParameters — 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-
• api_retrievesTheListOfNetworkApplicationsAlongWithExper_23fa3c77 — 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
• api_retrievesTheListOfNetworkProfilesForSites — Retrieves the list of network profiles for sites.
• api_retrievesTheListOfNetworkProfilesThatTheGivenSiteHa_0bebd066 — 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
• api_retrievesTheListOfSitesThatTheGivenNetworkProfileFo_cb2b520e — 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.
• api_retrievesTheListOfThousandEyesTestResultsAlongWithR_c8c74987 — 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
• api_retrievesTheListOfValidationWorkflows — Retrieves the workflows that have been successfully submitted and are currently available. This is sorted by `submitTime`
• api_retrievesTheMaintenanceScheduleInformation — API to retrieve the maintenance schedule information for the given id.
• api_retrievesTheSpectrumInterferenceDevicesReportsSentB_e4e5f9fd — 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-
• api_retrievesTheSpectrumSensorReportsSentByWLCForProvidedAPMac — 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
• api_retrievesTheTotalCountOfClientsByApplyingBasicFiltering — 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
• api_retrievesTheTotalCountOfNetworkApplicationsByApplyi_72ae1f9d — 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
• api_retrievesTheTotalCountOfThousandEyesTestResults — 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
• api_retrievesTheTotalNumberOfAAAServicesForGivenParameters — 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
• api_retrievesTheTotalNumberOfDHCPServicesForGivenParameters — 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
• api_retrievesTheTotalNumberOfDNSServicesForGivenParameters — 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
• api_retrievesTheTotalNumberOfPacketCaptureFilesMatching_e4bb30c7 — 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
• api_retrievesValidationDetailsForAValidationSet — Retrieves validation details for the given validation set id
• api_retrievesValidationWorkflowDetails — Retrieves workflow details for a workflow id
• api_returnListOfReplacementDevicesWithReplacementDetails — 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
• api_returnReplacementDevicesCount — Get replacement devices count
• api_returnsAllIssueTriggerDefinitionsForGivenFilters — 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
• api_returnsCountOfAdd_onImages — 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 ].
• api_returnsCountOfSoftwareImages — 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
• api_returnsListOfSoftwareImages — 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
• api_returnsNetworkDeviceProductNamesForASite — **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
• api_returnsPOEInterfaceDetailsForTheDevice — 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
• api_returnsTheCountOfNetworkDeviceProductNamesForASite — 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
• api_returnsTheImageSummaryForTheGivenSite — **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
• api_sdaFabricSitesReadiness — Gets a list of all SDA fabric sites along with their readiness status for Security Service Insertion (SSI) deployment.
• api_securityServiceInsertionById — Retrieves the details of a specific Security Service Insertion (SSI) by its ID.
• api_securityServiceInsertionReadiness — Gets readiness information for Security Service Insertion, including integration status, security group details, and access control information.
• api_securityServiceInsertionSummary — Retrieves a summary of all Security Service Insertions (SSIs) sorted by fabricSiteName.
• api_securityServiceInsertions — Retrieves a list of all Security Service Insertions (SSIs) configured across fabric sites, sorted by name.
• api_sensorTestResults — Intent API to get SENSOR test result summary
• api_sensors — Intent API to get a list of SENSOR devices
• api_smartAccountDetails — **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
• api_statusOfTemplateDeployment — API to retrieve the status of template deployment.
• api_systemHealthAPI — This API retrieves the latest system events
• api_systemHealthCountAPI — This API gives the count of the latest system events
• api_systemLicensingLastOperationStatus — **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:
• api_systemPerformanceAPI — 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
• api_systemPerformanceHistoricalAPI — 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
• api_theTrendAnalyticsDataForAFabricSiteInTheSpecifiedTimeRange — 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
• api_theTrendAnalyticsDataForATransitNetworkInTheSpecifi_5c01728a — 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
• api_theTrendAnalyticsDataForAVirtualNetworkInTheSpecifi_66fff53f — 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
• api_theTrendAnalyticsDataForThousandEyesTestResultsInTh_312f30ed — 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
• api_virtualAccountDetails — **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
• api_wirelessRogueAPContainmentStatus — 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

About MCP

The Model Context Protocol (MCP) is an open protocol Anthropic introduced for connecting LLM-based agents to external tools and data sources. Providers publish MCP servers that expose their API surface as structured, discoverable tools — an MCP-compatible client (Claude Desktop, Cursor, Cline, Continue, etc.) can connect to the server and call its tools without any per-provider integration code.

Browse every MCP server on the APIs.io network or compare with the broader Agent Skill surfaces of the same providers.