Cisco Catalyst Center Platform User Guide, Release 2.3.7.x

New and changed information

Table 1. New and changed features in Catalyst Center platform 2.3.7.10
Feature	Description
New APIs
None	—
API Enhancements
Devices APIs	With this release, the reachabilityHealthStatus parameter is included as an optional attribute in the response of the given devices APIs: Get the device data for the given device id (Uuid). Gets the list of network devices based on the provided complex filters and aggregation functions. Gets the network device details based on the provided query parameters.
Network Settings API	With this release, the configureDevice attribute is added as a query parameter in the Sync network devices credential API.
Deprecated APIs
None	—
API Changes That Break Backward Compatibility
None	—

Feature

Description

Where documented

Inventory Report

This Catalyst Center platform release supports a new Inventory report template called All Data Version 2.0.

This new all data view provides detailed information about network devices, distribution of devices over time, device count by site, device count by device type, device count by software version and device count by fabric role, more efficiently.

For more information, see:

Run an inventory report.
New Report Template in the Cisco Catalyst Center Release Notes.

New APIs

Applications APIs

Catalyst Center platform supports the following Applications APIs:

GET <cluster-ip>/dna/data/api/v1/networkApplications

Retrieves the list of network applications along with experience and health metrics.
GET <cluster-ip>/dna/data/api/v1/networkApplications/count

Retrieves the total count of network applications by applying basic filtering.
POST <cluster-ip>/dna/data/api/v1/networkApplications/trendAnalytics

Retrieves the Trend analytics data related to network applications.

To access the new Applications APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Know Your Network drop-down list and choose Applications.

Application Policy APIs

Catalyst Center platform supports the following Application Policy APIs:

GET <cluster-ip>/dna/intent/api/v1/applicationVisibility/networkDevices

Retrieve the list of network devices with their application visibility status.
GET <cluster-ip>/dna/intent/api/v1/applicationVisibility/networkDevices/count

Retrieve the count of network devices for the given application visibility status filters.
POST <cluster-ip>/dna/intent/api/v1/applicationVisibility/networkDevices/enableAppTelemetry

Enable application telemetry feature on multiple network devices.
POST <cluster-ip>/dna/intent/api/v1/applicationVisibility/networkDevices/disableAppTelemetry

Disable application telemetry feature on multiple network devices.
POST <cluster-ip>/dna/intent/api/v1/applicationVisibility/networkDevices/enableCbar

Enable CBAR feature on multiple network devices.
POST <cluster-ip>/dna/intent/api/v1/applicationVisibility/networkDevices/disableCbar

Disable CBAR feature on multiple network devices.
GET <cluster-ip>/dna/intent/api/v1/qosPolicySetting

Retrieves the application QoS policy setting.
PUT <cluster-ip>/dna/intent/api/v1/qosPolicySetting

Updates the application QoS policy setting.

To access the new Application Policy APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Policy drop-down list and choose Application Policy.

Cisco Integrated Management Controller (IMC) APIs

Catalyst Center platform supports the following Cisco IMC APIs:

GET <cluster-ip>/dna/system/api/v1/ciscoImcs

Retrieves Cisco IMC configurations for Catalyst Center nodes.
POST <cluster-ip>/dna/system/api/v1/ciscoImcs

Adds Cisco IMC configuration to a Catalyst Center node.
GET <cluster-ip>/dna/system/api/v1/ciscoImcs/${id}

Retrieves the Cisco IMC configuration for a Catalyst Center node.
PUT <cluster-ip>/dna/system/api/v1/ciscoImcs/${id}

Updates the Cisco IMC configuration for a Catalyst Center node.
DELETE <cluster-ip>/dna/system/api/v1/ciscoImcs/${id}

Deletes the Cisco IMC configurations for a Catalyst Center node.

To access the new Cisco IMC APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Appliance drop-down list and choose Cisco IMC.

Compliance APIs

Catalyst Center platform supports the following Compliance APIs:

POST <cluster-ip>/dna/intent/api/v1/networkBugs/trials

Creates a trial for bugs detection on network devices.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/trials

Get trial details for bugs detection on network devices.
POST <cluster-ip>/dna/intent/api/v1/networkBugs/triggerScan

Triggers a bugs scan for the supported network devices.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/networkDevices/${networkDeviceId}/bugs/count

Get count of bugs affecting the network device.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/networkDevices/${networkDeviceId}/bugs

Get bugs affecting the network device.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/bugs/${id}

Get network bug by ID.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/bugs/${id}/networkDevices/count

Get count of network bug devices for the bug.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/bugs/${id}/networkDevices

Get network bug devices for the bug.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/bugs/${id}/networkDevices/${networkDeviceId}

Get network bug device for the bug by network device ID.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/networkDevices/count

Get count of network bug devices.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/networkDevices

Get network bug devices.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/networkDevices/${networkDeviceId}

Get network bug device by device ID.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/networkDevices/${networkDeviceId}/bugs/count

Get count of bugs affecting the network device.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/networkDevices/${networkDeviceId}/bugs

Get bugs affecting the network device.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/results/networkDevices/${networkDeviceId}/bugs/${id}

Get bug affecting the network device by device ID and bug ID.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/resultsTrend/count

Get count of network bugs results trend over time.
GET <cluster-ip>/dna/intent/api/v1/networkBugs/resultsTrend

Get network bugs results trend over time.
POST <cluster-ip>/dna/intent/api/v1/fieldNotices/trials

Creates a trial for field notices detection on network devices.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/trials

Get trial details for field notices detection on network devices.
POST <cluster-ip>/dna/intent/api/v1/fieldNotices/triggerScan

Triggers a field notices scan for the supported network devices.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/networkDevices/${networkDeviceId}/notices/count

Get count of field notices affecting the network device.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/networkDevices/${networkDeviceId}/notices

Get field notices affecting the network device.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/notices/${id}

Get field notice affecting the network devices by ID.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/notices/${id}/networkDevices/count

Get count of field notice network devices for the notice.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/notices/${id}/networkDevices

Get field notice network devices for the notice.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/notices/${id}/networkDevices/${networkDeviceId}

Get field notice network device for the notice by network device ID.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/networkDevices/count

Get count of field notice network devices.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/networkDevices

Get field notice network devices.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/networkDevices/${networkDeviceId}

Get field notice network device by device ID.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/networkDevices/${networkDeviceId}/notices/count

Get count of field notices affecting the network device.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/networkDevices/${networkDeviceId}/notices

Get field notices affecting the network device.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/results/networkDevices/${networkDeviceId}/notices/${id}

Get field notice affecting the network device by device ID and notice ID.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/resultsTrend/count

Get count of field notices results trend over time.
GET <cluster-ip>/dna/intent/api/v1/fieldNotices/resultsTrend

Get field notices results trend over time.
POST <cluster-ip>/dna/intent/api/v1/securityAdvisories/trials

Creates a trial for security advisories detection on network devices.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/trials

Get trial details for security advisories detection on network devices.
POST <cluster-ip>/dna/intent/api/v1/securityAdvisories/triggerScan

Triggers a security advisories scan for the supported network devices.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/advisories/count

Get count of security advisories affecting the network devices.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/advisories

Get security advisories affecting the network devices.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/advisories/${id}

Get security advisory affecting the network devices by ID.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/advisories/${id}/networkDevices/count

Get count of security advisory network devices for the security advisory.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/advisories/${id}/networkDevices

Get security advisory network devices for the security advisory.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/advisories/${id}/networkDevices/${networkDeviceId}

Get security advisory network device for the security advisory by network device ID.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/networkDevices/count

Get count of security advisory network devices.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/networkDevices

Get security advisory network devices.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/networkDevices/${networkDeviceId}

Get security advisory network device by network device ID.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/networkDevices/${networkDeviceId}/advisories/count

Get count of security advisories affecting the network device.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/networkDevices/${networkDeviceId}/advisories

Get security advisories affecting the network device.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/results/networkDevices/${networkDeviceId}/advisories/${id}

Get security advisory affecting the network device by device ID and advisory ID.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/resultsTrend/count

Get count of security advisories results trend over time.
GET <cluster-ip>/dna/intent/api/v1/securityAdvisories/resultsTrend

Get security advisories results trend over time.

To access the new Compliance APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Know Your Network drop-down list and choose Compliance.

Configuration Archive APIs

Catalyst Center platform supports the following Configuration Archive APIs:

GET <cluster-ip>/dna/intent/api/v1/networkDeviceConfigFiles

Get Network Device Configuration File Details.
GET <cluster-ip>/dna/intent/api/v1/networkDeviceConfigFiles/count

Count of Network Device Configuration Files.
GET <cluster-ip>/dna/intent/api/v1/networkDeviceConfigFiles/${id}

Get Configuration File Details by ID.
POST <cluster-ip>/dna/intent/api/v1/networkDeviceConfigFiles/${id}/downloadMasked

Download masked device configuration.
POST <cluster-ip>/dna/intent/api/v1/networkDeviceConfigFiles/${id}/downloadUnmasked

Download Unmasked (raw) Device Configuration as ZIP.

To access the new Configuration Templates APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Site Management drop-down list and choose Configuration Archive APIs.

Configuration Templates APIs

Catalyst Center platform supports the following Configuration Templates APIs:

GET <cluster-ip>/dna/intent/api/v1/templates/${templateId}/networkProfilesForSites

Retrieve the network profiles attached to a CLI template.
GET <cluster-ip>/dna/intent/api/v1/templates/${templateId}/networkProfilesForSites/count

Retrieve count of network profiles attached to a CLI template.
POST <cluster-ip>/dna/intent/api/v1/templates/${templateId}/networkProfilesForSites

Attach network profile to a Day-N CLI template.
POST <cluster-ip>/dna/intent/api/v1/templates/${templateId}/networkProfilesForSites/bulk

Attach a list of network profiles to a Day-N CLI template.
DELETE <cluster-ip>/dna/intent/api/v1/templates/${templateId}/networkProfilesForSites/bulk

Detach a list of network profiles from a Day-N CLI template.
DELETE <cluster-ip>/dna/intent/api/v1/templates/${templateId}/networkProfilesForSites/${profileId}

Detach a network profiles from a Day-N CLI template.
GET <cluster-ip>/templates/${templateId}/versions

Get Template Versions.
GET <cluster-ip>/dna/intent/api/v1/templates/${templateId}/versions/${versionId}

Get Template Version.
GET <cluster-ip>/dna/intent/api/v1/templates/${templateId}/versions/count

Get Template Versions Count.
POST <cluster-ip>/dna/intent/api/v1/templates/${templateId}/versions/commit

Commit Template For a New Version.
GET <cluster-ip>/dna/intent/api/v1/projects

Get Template Projects.
POST <cluster-ip>/dna/intent/api/v1/projects

Create Template Project.
PUT <cluster-ip>/dna/intent/api/v1/projects/${projectId}

Update Template Project.
GET <cluster-ip>/dna/intent/api/v1/projects/${projectId}

Get Template Project.
DELETE <cluster-ip>/dna/intent/api/v1/projects/${projectId}

Delete Template Project.
GET <cluster-ip>/dna/intent/api/v1/projects/count

Get Template Project Count.

To access the new Configuration Templates APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Site Management drop-down list and choose Configuration Templates APIs.

Devices APIs

Catalyst Center platform supports the following Devices APIs:

POST <cluster-ip>/dna/intent/api/v1/networkDevices/deleteWithoutCleanup

Delete a network device without configuration cleanup.
POST <cluster-ip>/dna/intent/api/v1/networkDevices/deleteWithCleanup

Delete network device with configuration cleanup.

GET <cluster-ip>/dna/data/api/v1/aaaServices

Retrieves the list of AAA Services for given parameters.
GET <cluster-ip>/dna/data/api/v1/aaaServices/count

Retrieves the total number of AAA Services for given parameters.
GET <cluster-ip>/dna/data/api/v1/aaaServices/${id}

Retrieves the details of a specific AAA Service matching the id of the Service.
POST <cluster-ip>/dna/data/api/v1/aaaServices/query

Retrieves the list of AAA Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/aaaServices/query/count

Retrieves the total number of AAA Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/aaaServices/summaryAnalytics

Get summary analytics data of AAA Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/aaaServices/topNAnalytics

Get Top N analytics data of AAA Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/aaaServices/trendAnalytics

Get trend analytics data of AAA Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/aaaServices/${id}/trendAnalytics

Get trend analytics data for a given AAA Service matching the ID of the Service.
GET <cluster-ip>/dna/data/api/v1/dhcpServices

Retrieves the list of DHCP Services for given parameters.
GET <cluster-ip>/dna/data/api/v1/dhcpServices/count

Retrieves the total number of DHCP Services for given parameters.
GET <cluster-ip>/dna/data/api/v1/dhcpServices/${id}

Retrieves the details of a specific DHCP Service matching the ID of the Service.
POST <cluster-ip>/dna/data/api/v1/dhcpServices/query

Retrieves the list of DHCP Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/dhcpServices/query/count

Retrieves the total number of DHCP Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/dhcpServices/summaryAnalytics

Get summary analytics data of DHCP Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/dhcpServices/topNAnalytics

Get Top N analytics data of DHCP Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/dhcpServices/trendAnalytics

Get trend analytics data of DHCP Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/dhcpServices/${id}/trendAnalytics

Get trend analytics data for a given DHCP Service matching the ID of the Service.
GET <cluster-ip>/dna/data/api/v1/dnsServices

Retrieves the list of DNS Services for given parameters.
GET <cluster-ip>/dna/data/api/v1/dnsServices/count

Retrieves the total number of DNS Services for given parameters.
GET <cluster-ip>/dna/data/api/v1/dnsServices/${id}

Retrieves the details of a specific DNS Service matching the ID of the Service.
POST <cluster-ip>/dna/data/api/v1/dnsServices/query

Retrieves the list of DNS Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/dnsServices/query/count

Retrieves the total number of DNS Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/dnsServices/summaryAnalytics

Get summary analytics data of DNS Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/dnsServices/topNAnalytics

Get Top N analytics data of DHCP Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/dnsServices/trendAnalytics

Get trend analytics data of DNS Services for given set of complex filters.
POST <cluster-ip>/dna/data/api/v1/dnsServices/${id}/trendAnalytics

Get trend analytics data for a given DNS Service matching the ID of the Service.
GET <cluster-ip>/dna/intent/api/v1/networkDeviceMaintenanceSchedules

Retrieve scheduled maintenance windows for network devices.
POST <cluster-ip>/dna/intent/api/v1/networkDeviceMaintenanceSchedules

Create maintenance schedule for network devices.
GET <cluster-ip>/dna/intent/api/v1/networkDeviceMaintenanceSchedules/count

Retrieve the total number of scheduled maintenance windows.
GET <cluster-ip>/dna/intent/api/v1/networkDeviceMaintenanceSchedules/${id}

Retrieves the maintenance schedule information.
PUT <cluster-ip>/dna/intent/api/v1/networkDeviceMaintenanceSchedules/${id}

Updates the maintenance schedule information.
DELETE <cluster-ip>/dna/intent/api/v1/networkDeviceMaintenanceSchedules/${id}

Delete maintenance schedule.
GET <cluster-ip>/dna/intent/api/v1/networkDevices

Retrieve network devices.
GET <cluster-ip>/dna/intent/api/v1/networkDevices/${id}

Get details of a single network device.
GET <cluster-ip>/dna/intent/api/v1/networkDevices/count

Count the number of network devices.
POST <cluster-ip>/dna/intent/api/v1/networkDevices/query

Query network devices with filters.
POST <cluster-ip>/dna/intent/api/v1/networkDevices/query/count

Count the number of network devices with filters.
POST <cluster-ip>/dna/data/api/v1/networkDevices/topNAnalytics

Gets the Top-N analytics data related to network devices.
POST <cluster-ip>/dna/data/api/v1/interfaces/${id}/trendAnalytics

The trend analytics data for the interfaces in the specified time range.

To access the new Devices APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Know Your Network drop-down list and choose Devices.

Device Replacement APIs

Catalyst Center platform supports the following Device Replacement APIs:

GET <cluster-ip>/dna/intent/api/v1/networkDeviceReplacements/${id}

Retrieve the status of device replacement workflow that replaces a faulty device with a replacement device.
GET <cluster-ip>/dna/intent/api/v1/networkDeviceReplacements

Retrieve the status of all the device replacement workflows.

To access the new Device Replacement APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Site Management drop-down list and choose Device Replacement.

Fabric Wireless APIs

Catalyst Center platform supports the following Fabric Wireless APIs:

GET <cluster-ip>/dna/intent/api/v1/sda/fabrics/${fabricId}/switchWirelessSetting

Get SDA Wireless details from switches.
PUT <cluster-ip>//dna/intent/api/v1/sda/fabrics/${fabricId}/wirelessMulticast

Update SDA Wireless Multicast.
GET <cluster-ip>/dna/intent/api/v1/sda/fabrics/${fabricId}/wirelessMulticast

Get SDA Wireless Multicast.
PUT <cluster-ip>/dna/intent/api/v1/sda/fabrics/${fabricId}/switchWirelessSetting

Switch Wireless Setting and Rolling AP Upgrade Management.
POST <cluster-ip>//dna/intent/api/v1/sda/fabrics/${fabricId}/switchWirelessSetting/reload

Reload Switch for Wireless Controller Cleanup.

To access the new Fabric Wireless APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Connectivity drop-down list and choose Fabric Wireless.

Health and Performance APIs

Catalyst Center platform supports the following Health and Performance APIs:

GET <cluster-ip>/dna/intent/api/v1/diagnosticTasks/${id}

Retrieves diagnostic task by ID.
GET <cluster-ip>/dna/intent/api/v1/diagnosticTasks/${id}/detail

Retrieves diagnostic task details by ID.

To access the new Health and Performance APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the System drop-down list and choose Health and Performance.

Licenses APIs

Catalyst Center platform supports the following Licenses APIs:

GET <cluster-ip>/dna/intent/api/v1/connectionModeSetting

Retrieves CSSM connection mode.
PUT <cluster-ip>/dna/intent/api/v1/connectionModeSetting

Update CSSM connection mode.
GET <cluster-ip>/dna/system/api/v1/license/status

System licensing status.
POST <cluster-ip>/dna/system/api/v1/license/register

Smart licensing registration.
POST <cluster-ip>/dna/system/api/v1/license/renew

Smart licensing renew operation.
POST <cluster-ip>/dna/system/api/v1/license/deregister

Smart licensing Deregistration.
GET <cluster-ip>/dna/system/api/v1/license/lastOperationStatus

System licensing last operation status.

To access the new Licenses APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Cisco DNA Center System drop-down list and choose Licenses.

Network Settings APIs

Catalyst Center platform supports the following Network Settings APIs:

GET <cluster-ip>/dna/intent/api/v1/networkProfilesForSites/${profileId}/templates

Retrieve CLI templates attached to a network profile.
GET <cluster-ip>/dna/intent/api/v1/networkProfilesForSites/${profileId}/templates/count

Retrieve count of CLI templates attached to a network profile.
GET <cluster-ip>/dna/intent/api/v1/ipam/globalIpAddressPools

Retrieves global IP address pools.
POST <cluster-ip>/dna/intent/api/v1/ipam/globalIpAddressPools

Create a global IP address pool.
GET <cluster-ip>/dna/intent/api/v1/ipam/globalIpAddressPools/${id}

Retrieves a global IP address pool.
PUT <cluster-ip>/dna/intent/api/v1/ipam/globalIpAddressPools/${id}

Updates a global IP address pool.
DELETE <cluster-ip>/dna/intent/api/v1/ipam/globalIpAddressPools/${id}

Deletes a global IP address pool.
GET <cluster-ip>/dna/intent/api/v1/ipam/globalIpAddressPools/${globalIpAddressPoolId}/subpools

Retrieves subpools IDs of a global IP address pool.
GET <cluster-ip>/dna/intent/api/v1/ipam/globalIpAddressPools/${globalIpAddressPoolId}/subpools/count

Counts subpools of a global IP address pool.
GET <cluster-ip>/dna/intent/api/v1/ipam/globalIpAddressPools/count

Counts global IP address pools.
GET <cluster-ip>/dna/intent/api/v1/ipam/siteIpAddressPools

Retrieves IP address subpools.
POST <cluster-ip>/dna/intent/api/v1/ipam/siteIpAddressPools

Reserve (create) IP address subpools.
GET <cluster-ip>/dna/intent/api/v1/ipam/siteIpAddressPools/${id}

Retrieves an IP address subpool.
PUT <cluster-ip>/dna/intent/api/v1/ipam/siteIpAddressPools/{id}

Updates an IP address subpool.
DELETE <cluster-ip>/dna/intent/api/v1/ipam/siteIpAddressPools/{id}

Releases an IP address subpool.
GET <cluster-ip>/dna/intent/api/v1/ipam/siteIpAddressPools/count

Counts IP address subpools.

To access the new Network Settings APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Site Management drop-down list and choose Network Settings.

SD-Access APIs

Catalyst Center platform supports the following SDA APIs:

GET <cluster-ip>/dna/intent/api/v1/sda/pendingFabricEvents

Get Pending Fabric Events.
POST <cluster-ip>/dna/intent/api/v1/sda/pendingFabricEvents/apply

Apply Pending Fabric Events.
GET <cluster-ip>/dna/data/api/v1/fabricSummary

Read Fabric entity summary.
GET <cluster-ip>/dna/data/api/v1/fabricSiteHealthSummaries

Read list of Fabric Sites with their health summary.
GET <cluster-ip>/dna/data/api/v1/fabricSiteHealthSummaries/${id}

Read Fabric Sites with health summary from ID.
GET <cluster-ip>/dna/data/api/v1/fabricSiteHealthSummaries/${id}/trendAnalytics

The Trend analytics data for a fabric site in the specified time range.
GET <cluster-ip> /dna/data/api/v1/fabricSiteHealthSummaries/count

Read fabric site count.
GET <cluster-ip> //dna/data/api/v1/virtualNetworkHealthSummaries

Read list of Virtual Networks with their health summary.
GET <cluster-ip> /dna/data/api/v1/virtualNetworkHealthSummaries/${id}

Read virtual network with its health summary from ID.
GET <cluster-ip> /dna/data/api/v1/virtualNetworkHealthSummaries/count

Read Virtual Networks count.
GET <cluster-ip> /dna/data/api/v1/virtualNetworkHealthSummaries/${id}/trendAnalytics

The Trend analytics data for a virtual network in the specified time range.
GET <cluster-ip> //dna/data/api/v1/transitNetworkHealthSummaries

Read list of Transit Networks with their health summary.
GET <cluster-ip> /dna/data/api/v1/transitNetworkHealthSummaries/${id}

Read transit network with its health summary from ID.
GET <cluster-ip> /dna/data/api/v1/transitNetworkHealthSummaries/count

Read Transit Networks count.
GET <cluster-ip> /dna/data/api/v1/transitNetworkHealthSummaries/${id}/trendAnalytics

The Trend analytics data for a transit network in the specified time range.

To access the new SD-Access APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Connectivity drop-down list and choose SDA.

Sensor APIs

Catalyst Center platform supports the following Sensor APIs:

GET <cluster-ip>/dna/data/api/v1/icap/captureFiles

Lists ICAP packet capture files matching specified criteria.
GET <cluster-ip>/dna/data/api/v1/icap/captureFiles/count

Retrieves the total number of packet capture files matching specified criteria.
GET <cluster-ip>/dna/data/api/v1/icap/captureFiles/${id}

Retrieves details of a specific ICAP packet capture file.
GET <cluster-ip>/dna/data/api/v1/icap/captureFiles/${id}/download

Downloads a specific ICAP packet capture file.
GET <cluster-ip>/dna/data/api/v1/icap/spectrumSensorReports

Retrieves the spectrum sensor reports sent by WLC for provided AP Mac.
GET <cluster-ip>/dna/data/api/v1/icap/spectrumInterferenceDeviceReports

Retrieves the spectrum interference devices reports sent by WLC for provided AP Mac.
POST <cluster-ip>/dna/data/api/v1/icap/clients/${id}/stats

Retrieves specific client statistics over specified period of time.
POST <cluster-ip>/dna/data/api/v1/icap/radios/${id}/stats

Retrieves specific radio statistics over specified period of time.
POST <cluster-ip>/dna/intent/api/v1/icapSettings/deploy

Deploys the given ICAP configuration intent without preview and approve.
POST <cluster-ip>/dna/intent/api/v1/icapSettings/deploy/${id}/deleteDeploy

Remove the ICAP configuration on the device without preview.
POST <cluster-ip>/dna/intent/api/v1/icapSettings/configurationModels

Creates an ICAP configuration intent for preview-approve.
POST <cluster-ip>/dna/intent/api/v1/icapSettings/configurationModels/${id}/deleteDeploy

Creates a ICAP configuration workflow for ICAP intent to remove the ICAP configuration on the device.
GET <cluster-ip>/dna/intent/api/v1/icapSettings/configurationModels/${previewActivityId}/networkDeviceStatusDetails

Get ICAP configuration status per network device.
POST <cluster-ip>/dna/intent/api/v1/icapSettings/configurationModels/${previewActivityId}/networkDevices/${networkDeviceId}/config

Generates the device's CLIs of the ICAP configuration intent.
GET <cluster-ip>/dna/intent/api/v1/icapSettings/configurationModels/${previewActivityId}/networkDevices/${networkDeviceId}/config

Retrieves the device's CLIs of the ICAP intent.
DELETE <cluster-ip>/dna/intent/api/v1/icapSettings/configurationModels/${previewActivityId}

Discards the ICAP configuration intent by activity ID.
DELETE <cluster-ip>/dna/intent/api/v1/icapSettings/configurationModels/${previewActivityId}/deploy

Deploys the ICAP configuration intent by activity ID.
GET <cluster-ip>/dna/intent/api/v1/icapSettings/deviceDeployments

Get device deployment status.
GET <cluster-ip>/dna/intent/api/v1/icapSettings/deviceDeployments/count

Get device deployment status count.
GET <cluster-ip>/dna/intent/api/v1/icapSettings

Retrieves deployed ICAP configurations while supporting basic filtering.
GET <cluster-ip>/dna/intent/api/v1/icapSettings/count

Retrieves the count of deployed ICAP configurations while supporting basic filtering.

To access the new Sensor APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Know Your Network drop-down list and choose Sensors.

Site Design APIs

Catalyst Center platform supports the following Site Design APIs:

GET <cluster-ip>/dna/intent/api/v2/floors/${floorId}/accessPointPositions

Get Access Points positions.
GET <cluster-ip>/dna/intent/api/v2/floors/${floorId}/accessPointPositions/count

Get Access Points positions count.
POST <cluster-ip>/dna/intent/api/v2/floors/${floorId}/accessPointPositions/bulkChange

Edit the Access Points Positions.
POST <cluster-ip>/dna/intent/api/v2/floors/${floorId}/plannedAccessPointPositions/bulk

Add Planned Access Points Positions.
POST <cluster-ip>/dna/intent/api/v2/floors/${floorId}/plannedAccessPointPositions/bulkChange

Edit Planned Access Points Positions.
DELETE <cluster-ip>/dna/intent/api/v2/floors/${floorId}/plannedAccessPointPositions/${id}

Delete Planned Access Points Position.
GET <cluster-ip>/dna/intent/api/v2/floors/${floorId}/plannedAccessPointPositions

Get Planned Access Points Positions.
GET <cluster-ip>/dna/intent/api/v2/floors/${floorId}/plannedAccessPointPositions/count

Get Planned Access Points Positions count.
POST <cluster-ip>/dna/intent/api/v2/floors/${floorId}/plannedAccessPointPositions/assignAccessPointPositions

Assign Planned Access Points to operations ones.

To access the new Site Design APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Site Management drop-down list and choose Site Design.

SWIM APIs

Catalyst Center platform supports the following SWIM APIs:

POST <cluster-ip>/dna/intent/api/v1/images/ccoSync

Initiates sync of software images from Cisco.com.
GET <cluster-ip>dna/intent/api/v1/siteWiseImagesSummary

Returns the image summary for the given site.
DELETE <cluster-ip>/dna/intent/api/v1/images/${id}

Delete image.
POST <cluster-ip>/dna/intent/api/v1/images/${id}/sites/${siteId}/tagGolden

Tagging golden image.
POST <cluster-ip>/dna/intent/api/v1/images/${id}/sites/${siteId}/untagGolden

Untagging golden image.

To access the new SWIM APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Site Management drop-down list and choose Software Image Management (SWIM).

Tag APIs

Catalyst Center platform supports the following Tag APIs:

PUT <cluster-ip>/dna/intent/api/v1/tags/networkDevices/membersAssociations/bulk

Update tags associated with the network devices.
PUT <cluster-ip>/dna/intent/api/v1/tags/interfaces/membersAssociations/bulk

Update tags associated with the interfaces.

To access the new Tag APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Operational Tasks drop-down list and choose Tag.

Task APIs

Catalyst Center platform supports the following Task APIs:

GET <cluster-ip>/dna/intent/api/v1/activities/${activityId}/triggeredJobs/count

Retrieves the count of triggered jobs by activity ID.
GET <cluster-ip>/dna/intent/api/v1/activities

Get activities.
GET <cluster-ip>/dna/intent/api/v1/activities/count

Retrieves the count of activities.
GET <cluster-ip>/dna/intent/api/v1/activities/${id}

Get activity by ID.
GET <cluster-ip>/dna/intent/api/v1/activities/${activityId}/triggeredJobs

Get triggered jobs by activity ID.

To access the new Task APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Operational Tasks drop-down list and choose Task.

Wireless APIs

Catalyst Center platform supports the following Wireless APIs:

GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/anchorGroups

Get Anchor Groups.
POST <cluster-ip>/dna/intent/api/v1/wirelessSettings/anchorGroups

Create anchorGroup.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/anchorGroups/${id}

Get AnchorGroup by ID.
PUT <cluster-ip>/dna/intent/api/v1/wirelessSettings/anchorGroups/${id}

Update AnchorGroup.
DELETE <cluster-ip>/dna/intent/api/v1/wirelessSettings/anchorGroups/${id}

Delete anchorGroup by ID.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/anchorGroups/count

Get count of anchorGroups.
GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/anchorCapableDevices

Get Anchor capable devices.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/apAuthorizationLists

Get AP Authorization Lists.
POST <cluster-ip>/dna/intent/api/v1/wirelessSettings/apAuthorizationLists

Create AP Authorization List.
POST <cluster-ip>/dna/intent/api/v1/wirelessSettings/apAuthorizationLists/${id}

Get AP Authorization List by ID.
PUT <cluster-ip>/dna/intent/api/v1/wirelessSettings/apAuthorizationLists/${id}

Update AP Authorization List.
DELETE <cluster-ip>/dna/intent/api/v1/wirelessSettings/apAuthorizationLists/${id}

Delete AP Authorization List.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/apAuthorizationLists/count

Get AP Authorization List Count.
GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/${networkDeviceId}/apAuthorizationLists

Get AP Authorization List by network device ID.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/powerProfiles

Get Power Profiles.
POST <cluster-ip>/dna/intent/api/v1/wirelessSettings/powerProfiles

Create Power Profile.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/powerProfiles/${id}

Get Power Profile by ID.
PUT <cluster-ip>/dna/intent/api/v1/wirelessSettings/powerProfiles/${id}

Update Power Profile by ID.
DELETE <cluster-ip>/dna/intent/api/v1/wirelessSettings/powerProfiles/${id}

Delete Power Profile by ID.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/powerProfiles/count

Get Power Profiles Count.
GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/meshApNeighbours

Get Mesh Ap Neighbours.
GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/meshApNeighbours/count

Get Mesh Ap Neighbours Count.
POST <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/ssids/${id}/update

Update or override SSID.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/ssids/overrideAtSites

Retrieve sites with overridden SSIDs.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/apProfiles

Get AP Profiles.
POST <cluster-ip>/dna/intent/api/v1/wirelessSettings/apProfiles

Create AP Profile.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/apProfiles/${id}

Get AP Profile by ID.
PUT <cluster-ip>/dna/intent/api/v1/wirelessSettings/apProfiles/${id}

Update AP Profile by ID.
DELETE <cluster-ip>/dna/intent/api/v1/wirelessSettings/apProfiles/${id}

Delete AP Profile by ID.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/apProfiles/count

Get AP Profiles Count.
GET <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/siteTags

Retrieve all Site Tags for a Wireless Profile.
POST <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/siteTags/bulk

Create multiple Site Tags for a Wireless Profile in bulk.
GET <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/siteTags/${siteTagId}

Retrieve a specific Site Tag for a Wireless Profile.
GET <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/siteTags/${siteTagId}

Update a specific Site Tag for a Wireless Profile.
DELETE <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/siteTags/${siteTagId}

Delete a specific Site Tag from a Wireless Profile.
GET <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/siteTags/count

Retrieve the count of Site Tags for a Wireless Profile.
GET <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/policyTags

Retrieve all Policy Tags for a Wireless Profile.
POST <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/policyTags/bulk

Create multiple Policy Tags for a Wireless Profile in bulk.
GET <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/policyTags/${policyTagId}

Retrieve a specific Policy Tag for a Wireless Profile.
PUT <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/policyTags/${policyTagId}

Update a specific Policy Tag for a Wireless Profile.
DELETE <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/policyTags/${policyTagId}

Delete a specific Policy Tag from a Wireless Profile.
GET <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}/policyTags/count

Retrieve the count of Policy Tags for a Wireless Profile.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/${networkDeviceId}/assignAnchorManagedApLocations

Assign Anchor Managed AP Locations For WLC.
GET <cluster-ip>/dna/intent/api/v1/wireless/accesspoint-configuration/count

Get Access Point Configuration Count.

To access the new Wireless APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Connectivity drop-down list and choose Wireless.

Beta APIs

Wired APIs

With this release, Catalyst Center platform includes the following Campus Automation Beta APIs:

POST <cluster-ip>dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/configurationModels

Create a configuration model for the intended configs for a wired device.
PUT <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2/${feature}

Update configurations for an intended layer 2 feature on a wired device.
GET <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/deployed/layer2/${feature}

Get configurations for a deployed layer 2 feature on a wired device.
GET <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/deployed/layer2/${feature}/count

Get number of configurations for a deployed layer 2 feature on a device.
POST <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/deploy

Deploy the intended configuration features on a wired device.
PUT <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2

Update configurations for intended layer 2 features on a wired device.
GET <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/supported/layer2

Get the supported layer 2 features on a wired device.
GET <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/serviceDeployments

Get service deployment status.
POST <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/configurationModels/${previewActivityId}/config

Generate the device config for the configuration model.
POST <cluster-ip>/dna/intent/api/v1/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/configurationModels/${previewActivityId}/deploy

Deploys the configuration model on the network device.
DELETE <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2/${feature}

Delete configurations for an intended layer 2 feature on a wired device.
GET <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2/${feature}

Get configurations for an intended layer 2 feature on a wired device.
DELETE <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/configurationModels/${previewActivityId}

Delete the configuration model.
POST <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2/${feature}

Create configurations for an intended layer 2 feature on a wired device.
GET <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2/${feature}/count

Get number of configurations for an intended layer 2 feature on a wired device.
GET <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/configurationModels/${previewActivityId}/config

Gets the device config for the configuration model.
POST <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2

Create configurations for intended layer 2 features on a wired device.
GET <cluster-ip>/dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/deviceDeployments

Get device deployment status.
GET <cluster-ip>/dna/intent/api/v1/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2

Get configurations for intended layer 2 features on a wired device.

To access the Wired APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Connectivity drop-down list and choose Wired.

API Enhancements

Compliance API

With this release, the status and remediationSupported properties are added in the request query parameter of the Compliance Details of Device API, and a new response parameter called remediationSupported is introduced.

Devices APIs

The following Devices APIs now include the new response attributes physicalPortCount and virtualPortCount:

Get the device data for the given device id (Uuid).
Gets the Network Device details based on the provided query parameters.
Gets the list of Network Devices based on the provided complex filters and aggregation functions.

SD-Access APIs

The Delete Port Channel API now includes the PortchannelIds and connectedDeviceType request parameters. The networkDeviceId parameter is now optional.
With this release, a new request parameter called isGlobalAuthenticationProfile is added to the Get Authentication Profiles API.
The fabricId request attribute is now optional in the Get Authentication Profiles and Update Authentication Profiles APIs.

Wireless APIs

With this release:

The anchorGroupName, vlanGroupName, additionalInterfaces, apZones, apZoneName, rfProfileName and ssids attributes are included in the Update Wireless Profile, Create Wireless Profile, Get Wireless Profiles and Get Wireless Profile by ID APIs.
A new response parameter called provisioningStatus is included in the Get Access Point Configuration API.

Deprecated APIs

A Sunset banner indicates that the particular API will be deprecated:

Note

If there is an alternative API, the details are given under the respective deprecated API's Features tab.

Discovery API

With this release, the following Discovery API is marked as Sunset:

POST <cluster-ip>/dna/intent/api/v1/discovery

Delete all discovery.

Event Management APIs

With this release, the following Event Management APIs are marked as Sunset and the corresponding new APIs are supported:

Deprecated APIs

New APIs

POST <cluster-ip>/dna/intent/api/v1/event/subscription

Create Event Subscriptions.

POST <cluster-ip>/dna/intent/api/v1/event/subscription/rest

Create Rest/Webhook Event Subscription.

PUT <cluster-ip>/dna/intent/api/v1/event/subscription

Update Event Subscriptions.

PUT <cluster-ip>/dna/intent/api/v1/event/subscription/rest

Update Rest/Webhook Event Subscriptions.

GET <cluster-ip>/dna/intent/api/v1/event/subscription

Get Event Subscriptions.

GET <cluster-ip>/dna/intent/api/v1/event/subscription/rest

Update Rest/Webhook Event Subscriptions.

Network Settings APIs

With this release, the following Network Settings APIs are deprecated:

POST <cluster-ip>/dna/intent/api/v1/global-pool

Create Global Pool.
GET <cluster-ip>/dna/intent/api/v1/global-pool

Get Global Pool.
PUT <cluster-ip>/dna/intent/api/v1/global-pool

Update Global Pool.
DELETE <cluster-ip>/dna/intent/api/v1/global-pool/${id}

Delete Global IP Pool.
POST <cluster-ip>/dna/intent/api/v1/reserve-ip-subpool/${siteId}

Reserve IP Subpool.
GET <cluster-ip>/dna/intent/api/v1/reserve-ip-subpool

Get Reserve IP Subpool.
PUT <cluster-ip>/dna/intent/api/v1/reserve-ip-subpool/${siteId}

Update Reserve IP Subpool.
DELETE <cluster-ip>/dna/intent/api/v1/reserve-ip-subpool/${id}

Release Reserve IP Subpool.

SD-Access APIs

With this release, the following SD-Access business APIs are deprecated.

Fabric Creation APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/fabric

Add Fabric Site.
GET <cluster-ip>/dna/intent/api/v1/business/sda/fabric

Get SDA Fabric Info.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/fabric

Delete SDA Fabric.

Fabric Site in SDA Fabric APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/fabric-site

Add Site in SDA Fabric.
GET <cluster-ip>/dna/intent/api/v1/business/sda/fabric-site

Get Site from SDA Fabric.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/fabric-site

Delete Site from SDA Fabric.

Fabric Zone in SDA fabric APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/fabric-zone

Add fabric zone in SDA Fabric.
GET <cluster-ip>/dna/intent/api/v1/business/sda/fabric-zone

Get fabric zone from SDA Fabric.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/fabric-zone

Delete fabric zone from SDA Fabric.

Control Plane Device APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/control-plane-device

Add control plane device.
GET <cluster-ip>/dna/intent/api/v1/business/sda/control-plane-device

Get control plane device.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/control-plane-device

Delete control plane device in SDA Fabric.

Edge-Device Role Assignment APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/edge-device

Add edge device.
GET <cluster-ip>/dna/intent/api/v1/business/sda/edge-device

Get edge device.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/edge-device

Delete edge device.

Border Device Role Assignment APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/border-device

Adds border device in SDA Fabric.
GET <cluster-ip>/dna/intent/api/v1/business/sda/border-device

Gets border device detail from SDA Fabric.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/border-device

Deletes border device from SDA Fabric.

Default Authentication Template (Profile) APIs

PUT <cluster-ip>/dna/intent/api/v1/business/sda/authentication-profile

Update default authentication profile.
POST <cluster-ip>/dna/intent/api/v1/business/sda/authentication-profile

Add default authentication profile.
GET <cluster-ip>/dna/intent/api/v1/business/sda/authentication-profile

Get default authentication profile.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/authentication-profile

Delete default authentication profile.

Virtual Network Creation APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/virtual-network

Add VN in SDA Fabric.
GET <cluster-ip>/dna/intent/api/v1/business/sda/virtual-network

Get VN from SDA Fabric.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/virtual-network

Delete VN from SDA Fabric.
GET <cluster-ip>/dna/intent/api/v1/business/sda/virtual-network/summary

Get Virtual Network Summary.

SDA Segment APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/virtualnetwork/ippool

Add IP Pool in SDA Virtual Network.
GET <cluster-ip>/dna/intent/api/v1/business/sda/virtualnetwork/ippool

Get IP Pool in SDA Virtual Network.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/virtualnetwork/ippool

Delete IP Pool in SDA Virtual Network.

Port Assignment for User Devices APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/hostonboarding/user-device

Add Port assignment for user device.
GET <cluster-ip>/dna/intent/api/v1/business/sda/hostonboarding/user-device

Get Port assignment for user device.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/hostonboarding/user-device

Delete Port assignment for user device.

Port Assignment to Access Points APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/hostonboarding/access-point

Add Port assignment for access point.
GET <cluster-ip>/dna/intent/api/v1/business/sda/hostonboarding/access-point

Get Port assignment for access point.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/hostonboarding/access-point

Delete Port assignment for access point.

SDA Multicast APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/multicast

Add multicast.
GET <cluster-ip>/dna/intent/api/v1/business/sda/multicast

Get multicast.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/multicast

Delete multicast.

Wired Device Provisioning APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/provision-device

Provision Wired Device.
GET <cluster-ip>/dna/intent/api/v1/business/sda/provision-device

Get Provision Wired Device.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/provision-device

Delete Provision Wired Device.
PUT <cluster-ip>/dna/intent/api/v1/business/sda/provision-device

Re-Provision Wired Device.

Virtual Network APIs

POST <cluster-ip>/dna/intent/api/v1/virtual-network

Add virtual network with scalable groups.
GET <cluster-ip>/dna/intent/api/v1/virtual-network

Get virtual network with scalable groups.
DELETE <cluster-ip>/dna/intent/api/v1/virtual-network

Delete virtual network with scalable groups.
PUT <cluster-ip>/dna/intent/api/v1/virtual-network

Update virtual network with scalable groups.

Transit and Peer Networks APIs

POST <cluster-ip>/dna/intent/api/v1/business/sda/transit-peer-network

Add Transit Peer Network.
GET <cluster-ip>/dna/intent/api/v1/business/sda/transit-peer-network

Get Transit Peer Network.
DELETE <cluster-ip>/dna/intent/api/v1/business/sda/transit-peer-network

Delete Transit Peer Network.

Retrieve Device Information from SDA fabric API

GET <cluster-ip>/dna/intent/api/v1/business/sda/device

Get device info from SDA Fabric.

Get SDA Device Role for a given device API

GET <cluster-ip>/dna/intent/api/v1/business/sda/device/role

Get device role in SDA Fabric.

Get Number of Fabric - Cyclops API

GET <cluster-ip>/dna/intent/api/v1/business/sda/fabric/count

Get SDA Fabric Count.

Security Advisories APIs

With this release, the following Security Advisories APIs are marked as Sunset:

GET <cluster-ip>/dna/intent/api/v1/security-advisory/advisory/aggregate

Get Advisories Summary.
GET <cluster-ip>/dna/intent/api/v1/security-advisory/device/${deviceId}

Get Advisory Device Detail.
GET <cluster-ip>/dna/intent/api/v1/security-advisory/advisory

Get Advisories List.
GET <cluster-ip>/dna/intent/api/v1/security-advisory/device/${deviceId}/advisory

Get Advisories Per Device.
GET <cluster-ip>/dna/intent/api/v1/security-advisory/advisory/${advisoryId}/device

Get Devices Per Advisory.

SWIM APIs

With this release, the following SWIM APIs are marked as Sunset:

GET <cluster-ip>/dna/intent/api/v1/image/importation

Get software image details.
GET <cluster-ip>/dna/intent/api/v1/image/importation/device-family-identifiers

Get Device Family Identifiers.
POST <cluster-ip>/dna/intent/api/v1/image/importation/golden

Tag as Golden Image.
GET <cluster-ip>/dna/intent/api/v1/image/importation/golden/site/${siteId}/family/${deviceFamilyIdentifier}/role/${deviceRole}/image/${imageId}Swagger doc

Get Golden Tag Status of an Image.
DELETE <cluster-ip>/dna/intent/api/v1/image/importation/golden/site/${siteId}/family/${deviceFamilyIdentifier}/role/${deviceRole}/image/${imageId}

Remove Golden Tag for image.

API Changes That Break Backward Compatibility

None

—

Feature Description

Name change to Catalyst Center app

The Cisco DNA Center app on the ServiceNow Store is rebranded as Catalyst Center from app version 2.3.1 onwards.

The previous versions of the app are still called Cisco DNA Center. You can continue using those versions with the corresponding releases of Catalyst Center.

New APIs

Cisco Trusted Certificates API

Catalyst Center platform supports the following Import Trusted Certificate API:

POST <cluster-ip>/dna/intent/api/v1/trustedCertificates/import

Imports trusted certificate into a truststore. Accepts .pem or .der file as input.

To access the new Import Trusted Certificate API, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the System drop-down list and choose Cisco Trusted Certificates.

Clients API

Catalyst Center platform supports the following Clients API:

GET <cluster-ip>/dna/data/api/v1/clients

Retrieves the list of clients, while also offering basic filtering and sorting capabilities.
GET <cluster-ip>/dna/data/api/v1/clients/${id}

Retrieves specific client information matching the MAC address.
GET <cluster-ip>/dna/data/api/v1/clients/count

Retrieves the total count of clients by applying basic filtering.
POST <cluster-ip>/dna/data/api/v1/clients/query

Retrieves the list of clients by applying complex filters while also supporting aggregate attributes.
POST <cluster-ip>/dna/data/api/v1/clients/query/count

Retrieves the number of clients by applying complex filters.
POST <cluster-ip>/dna/data/api/v1/clients/trendAnalytics

Retrieves the Trend analytics data related to clients.
POST <cluster-ip>/dna/data/api/v1/clients/${id}/trendAnalytics

Retrieves specific client information over a specified period of time.
POST <cluster-ip>/dna/data/api/v1/clients/summaryAnalytics

Retrieves summary analytics data related to clients.
POST <cluster-ip>/dna/data/api/v1/clients/topNAnalytics

Retrieves the Top-N analytics data related to clients.

To access the new Clients APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Know Your Network drop-down list and choose Clients.

Compliance API

Catalyst Center platform supports the following Compliance API:

POST <cluster-ip>/dna/intent/api/v1/compliance/networkDevices/${id}/issues/remediation/provision

Compliance Remediation.

To access the new Compliance API, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Know Your Network drop-down list and choose Compliance.

Devices APIs

Catalyst Center platform supports the following Devices APIs:

PUT <cluster-ip>/dna/intent/api/v1/networkDevices/resyncIntervalSettings

Update global resync interval.
PUT <cluster-ip>/dna/intent/api/v1/networkDevices/${id}/resyncIntervalSettings

Update resync interval for the network device.
GET <cluster-ip>/dna/intent/api/v1/networkDevices/${id}/resyncIntervalSettings

Get resync interval for the network device.
POST <cluster-ip>/dna/intent/api/v1/networkDevices/resyncIntervalSettings/override

Override resync interval.
GET <cluster-ip>/dna/data/api/v1/assuranceEvents

Query assurance events.
GET <cluster-ip>/dna/data/api/v1/assuranceEvents/count

Count the number of events.
GET <cluster-ip>/dna/data/api/v1/assuranceEvents/${id}

Get details of a single assurance event.
GET <cluster-ip>/dna/data/api/v1/assuranceEvents/${id}/childEvents

Get list of child events for the given wireless client event.
POST <cluster-ip>/dna/data/api/v1/assuranceEvents/query
Query assurance events with filters.
POST <cluster-ip>/dna/data/api/v1/assuranceEvents/query/count

Count the number of events with filters.
PUT <cluster-ip>/dna/intent/api/v1/healthScoreDefinitions/${id}

Update health score definition for the given ID.
GET <cluster-ip>/dna/intent/api/v1/healthScoreDefinitions

Get all health score definitions for given filters.
GET <cluster-ip>/dna/intent/api/v1/healthScoreDefinitions/${id}

Get health score definition for the given ID.
GET <cluster-ip>/dna/intent/api/v1/healthScoreDefinitions/count

Get the count of health score definitions based on provided filters.
POST <cluster-ip>/dna/intent/api/v1/healthScoreDefinitions/bulkUpdate

Update health score definitions.
GET <cluster-ip>/dna/data/api/v1/networkDevices

Gets the Network Device details based on the provided query parameters.
GET <cluster-ip>/dna/data/api/v1/networkDevices/{id}

Get the device data for the given device ID (Uuid).
GET <cluster-ip>/dna/data/api/v1/networkDevices/count

Gets the total Network Device counts based on the provided query parameters.
POST <cluster-ip>/dna/data/api/v1/networkDevices/query

Gets the list of Network Devices based on the provided complex filters and aggregation functions.
POST <cluster-ip>/dna/data/api/v1/networkDevices/query/count

Gets the total number of Network Devices based on the provided complex filters and aggregation functions.
POST <cluster-ip>/dna/data/api/v1/networkDevices/trendAnalytics

Gets the Trend analytics data.
POST <cluster-ip>/dna/data/api/v1/networkDevices/${id}/trendAnalytics

The Trend analytics data for the network Device in the specified time range.
POST <cluster-ip>/dna/data/api/v1/networkDevices/summaryAnalytics

Gets the summary analytics data related to network devices.
GET <cluster-ip>/dna/data/api/v1/interfaces

Gets interfaces along with statistics data from all network devices.
GET <cluster-ip>/dna/data/api/v1/interfaces/${id}

Get the interface data for the given interface ID (instance Uuid) along with the statistics data.
GET <cluster-ip>/dna/data/api/v1/interfaces/count

Gets the total Network device interface counts in the specified time range. When there is no start and end time specified returns the latest interfaces total count.
POST <cluster-ip>/dna/data/api/v1/interfaces/query

Gets the list of interfaces across the Network Devices based on the provided complex filters and aggregation functions.
POST <cluster-ip>/dna/data/api/v1/interfaces/query/count

The Total interfaces count across the Network devices.

To access the new Devices APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Know Your Network drop-down list and choose Devices.

Fabric Wireless APIs

Catalyst Center platform supports the following Fabric Wireless APIs:

PUT <cluster-ip>/dna/intent/api/v1/sda/fabrics/${fabricId}/vlanToSsids

Add, Update or Remove SSID mapping to a VLAN.
GET <cluster-ip>/dna/intent/api/v1/sda/fabrics/vlanToSsids/count

Return the count of all the fabric site which has SSID to IP Pool mapping.
GET <cluster-ip>/dna/intent/api/v1/sda/fabrics/vlanToSsids

Returns all the Fabric Sites that have VLAN to SSID mapping.
GET <cluster-ip>/dna/intent/api/v1/sda/fabrics/${fabricId}/vlanToSsids/count

Returns the count of VLANs mapped to SSIDs in a Fabric Site.
GET <cluster-ip>/dna/intent/api/v1/sda/fabrics/${fabricId}/vlanToSsids

Retrieve the VLANs and SSIDs mapped to the VLAN within a Fabric Site.

To access the new Fabric Wireless APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Connectivity drop-down list and choose Fabric Wireless.

Health and Performance APIs

Catalyst Center platform supports the following Health and Performance APIs:

GET <cluster-ip>/dna/intent/api/v1/diagnosticValidationSets

Retrieves all the validation sets.
GET <cluster-ip>/dna/intent/api/v1/diagnosticValidationSets/${id}

Retrieves validation details for a validation set.
GET <cluster-ip>/dna/intent/api/v1/diagnosticValidationWorkflows/count

Retrieves the count of validation workflows.
GET <cluster-ip>/dna/intent/api/v1/diagnosticValidationWorkflows/${id}

Retrieves validation workflow details.
GET <cluster-ip>/dna/intent/api/v1/diagnosticValidationWorkflows

Retrieves the list of validation workflows.
POST <cluster-ip>/dna/ intent/api/v1/diagnosticValidationWorkflows

Submits the workflow for executing validations.
DELETE <cluster-ip>/dna/intent/api/v1/diagnosticValidationWorkflows/${id}

Deletes a validation workflow.

To access the new Health and Performance APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Cisco DNA Center System drop-down list and choose Health and Performance.

Issues APIs

Catalyst Center platform supports the following Issues APIs:

GET <cluster-ip>/dna/data/api/v1/assuranceIssues

Get the details of issues for given set of filters.
GET <cluster-ip>/dna/data/api/v1/assuranceIssues/${id}

Get all the details and suggested actions of an issue for the given issue ID.
GET <cluster-ip>/dna/data/api/v1/assuranceIssues/count

Get the total number of issues for given set of filters.
POST <cluster-ip>/dna/data/api/v1/assuranceIssues/query

Get the details of issues for given set of filters.
POST <cluster-ip>/dna/data/api/v1/assuranceIssues/query/count

Get the total number of issues for given set of filters.
POST <cluster-ip>/dna/data/api/v1/assuranceIssues/topNAnalytics

Get Top N analytics data of issues.
POST <cluster-ip>/dna/data/api/v1/assuranceIssues/summaryAnalytics

Get summary analytics data of issues.
POST <cluster-ip>/dna/data/api/v1/assuranceIssues/trendAnalytics

Get trend analytics data of issues.
POST <cluster-ip>/dna/intent/api/v1/assuranceIssues/resolve

Resolve the given lists of issues.
POST <cluster-ip>/dna/intent/api/v1/assuranceIssues/ignore

Ignore the given list of issues.
POST <cluster-ip>/dna/intent/api/v1/assuranceIssues/${id}/update

Update the given issue by updating selected fields.
GET <cluster-ip>/dna/intent/api/v1/customIssueDefinitions

Get all the custom issue definitions based on the given filters.
POST <cluster-ip>/dna/intent/api/v1/customIssueDefinitions

Creates a new user-defined issue definition.
GET <cluster-ip>/dna/intent/api/v1/customIssueDefinitions/count

Get the total custom issue definitions count based on the provided filters.
GET <cluster-ip>/dna/intent/api/v1/customIssueDefinitions/${id}

Get the custom issue definition for the given custom issue definition ID.
PUT <cluster-ip>/dna/intent/api/v1/customIssueDefinitions/${id}

Updates an existing custom issue definition based on the provided ID.
DELETE <cluster-ip>/dna/intent/api/v1/customIssueDefinitions/${id}

Deletes an existing custom issue definition.
GET <cluster-ip>/dna/intent/api/v1/systemIssueDefinitions

Returns all issue trigger definitions for given filters.
GET <cluster-ip>/dna/intent/api/v1/systemIssueDefinitions/${id}

Get issue trigger definition for given ID.
GET <cluster-ip>/dna/intent/api/v1/systemIssueDefinitions/count

Get the count of system defined issue definitions based on provided filters.
PUT <cluster-ip>/dna/intent/api/v1/systemIssueDefinitions/${id}

Issue trigger definition update.

To access the new Issues APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Know Your Network drop-down list and choose Issues.

Licenses APIs

Catalyst Center platform supports the following Licenses APIs:

PUT <cluster-ip>/dna/intent/api/v1/licenseSetting

Update license setting.
GET <cluster-ip>/dna/intent/api/v1/licenseSetting

Retrieve license setting.

To access the new Licenses APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Cisco DNA Center System drop-down list and choose Licenses.

Network Settings APIs

Catalyst Center platform supports the following Network Settings APIs:

PUT <cluster-ip>/dna/intent/api/v1/sites/{id}/timeZoneSettings

Set time zone for a site.
PUT <cluster-ip>/dna/intent/api/v1/sites/{id}/bannerSettings

Set banner settings for a site.
GET <cluster-ip>/dna/intent/api/v1/sites/${id}/telemetrySettings

Retrieve Telemetry settings for a site.
PUT <cluster-ip>/dna/intent/api/v1/sites/${id}/telemetrySettings

Set Telemetry settings for a site.
POST <cluster-ip>/dna/intent/api/v1/telemetrySettings/apply

Update a device(s) telemetry settings to conform to the telemetry settings for its site.
GET <cluster-ip>/dna/intent/api/v1/sites/${id}/deviceCredentials

Get device credential settings for a site.
GET <cluster-ip>/dna/intent/api/v1/sites/${id}/deviceCredentials/status

Get network devices credentials sync status at a given site.
GET <cluster-ip>/dna/intent/api/v1/sites/deviceCredentials/apply

Sync network devices credential.
PUT <cluster-ip>/dna/intent/api/v1/sites/${id}/deviceCredentials

Update device credential settings for a site.
PUT <cluster-ip>/dna/intent/api/v1/sites/${id}/aaaSettings

Set AAA settings for a site.
PUT <cluster-ip>/dna/intent/api/v1/sites/${id}/dnsSettings

Set DNS settings for a site.
PUT <cluster-ip>/dna/intent/api/v1/sites/${id}/dhcpSettings

Set DHCP settings for a site.
PUT <cluster-ip>/dna/intent/api/v1/sites/${id}/ntpSettings

Set NTP settings for a site.
PUT <cluster-ip>/dna/intent/api/v1/sites/${id}/imageDistributionSettings

Set image distribution settings for a site.
GET<cluster-ip>/dna/intent/api/v1/sites/${id}/aaaSettings

Retrieve AAA settings for a site.
GET <cluster-ip>/dna/intent/api/v1/sites/${id}/dnsSettings

Retrieve DNS settings for a site.
GET <cluster-ip>/dna/intent/api/v1/sites/${id}/dhcpSettings

Retrieve DHCP settings for a site.
GET <cluster-ip>/dna/intent/api/v1/sites/${id}/ntpSettings

Retrieve NTP settings for a site.
GET <cluster-ip>/dna/intent/api/v1/sites/${id}/imageDistributionSettings

Retrieve image distribution settings for a site.

To access the new Network Settings APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Site Management drop-down list and choose Network Settings.

SDA APIs

Catalyst Center platform supports the following SDA APIs:

Extranet API

DELETE <cluster-ip>/dna/intent/api/v1/sda/extranetPolicies

Delete extranet policies.

Multicast APIs

GET <cluster-ip>/dna/intent/api/v1/sda/multicast/virtualNetworks

Get multicast virtual networks.
GET <cluster-ip>/dna/intent/api/v1/sda/multicast

Get multicast.
PUT <cluster-ip>/dna/intent/api/v1/sda/multicast/virtualNetworks

Update multicast virtual networks.
GET <cluster-ip>/dna/intent/api/v1/sda/multicast/virtualNetworks/count

Get multicast virtual network count.
DELETE <cluster-ip>/dna/intent/api/v1/sda/multicast/virtualNetworks/${id}

Delete multicast virtual network by ID.
POST <cluster-ip>/dna/intent/api/v1/sda/multicast/virtualNetworks

Add multicast virtual networks.
PUT <cluster-ip>/dna/intent/api/v1/sda/multicast

Update multicast.

Port Channel APIs

POST <cluster-ip>/dna/intent/api/v1/sda/portChannels

Add Port Channels.
GET <cluster-ip>/dna/intent/api/v1/sda/portChannels

Get Port Channels.
PUT <cluster-ip>/dna/intent/api/v1/sda/portChannels

Update Port Channels.
DELETE <cluster-ip>/dna/intent/api/v1/sda/portChannels

Delete Port Channels.
DELETE <cluster-ip>/dna/intent/api/v1/sda/portChannels/{id}

Delete Port Channels by ID.
GET <cluster-ip>/dna/intent/api/v1/sda/portChannels/count

Get Port Channels count.

Transit Network APIs

GET <cluster-ip>/dna/intent/api/v1/sda/transitNetworks

Get Transit Networks.
POST <cluster-ip>/dna/intent/api/v1/sda/transitNetworks

Add Transit Networks.
PUT <cluster-ip>/dna/intent/api/v1/sda/transitNetworks

Update Transit Networks.
DELETE <cluster-ip>/dna/intent/api/v1/sda/transitNetworks/${id}

Delete transit network by ID.
GET <cluster-ip>/dna/intent/api/v1/sda/transitNetworks/count

Get transit networks count.

Layer 2 Virtual Network APIs

PUT <cluster-ip>/dna/intent/api/v1/sda/layer2VirtualNetworks

Update layer 2 virtual networks.
GET <cluster-ip>/dna/intent/api/v1/sda/layer2VirtualNetworks/count

Get layer 2 virtual network count.
DELETE <cluster-ip>/dna/intent/api/v1/sda/layer2VirtualNetworks/${id}

Delete layer 2 virtual network by ID.
DELETE <cluster-ip>/dna/intent/api/v1/sda/layer2VirtualNetworks

Delete layer 2 virtual networks.
POST <cluster-ip>/dna/intent/api/v1/sda/layer2VirtualNetworks

Add layer 2 virtual networks.
GET <cluster-ip>/dna/intent/api/v1/sda/layer2VirtualNetworks

Get layer 2 virtual networks.

Layer 3 Virtual Network APIs

POST <cluster-ip>/dna/intent/api/v1/sda/layer3VirtualNetworks

Add layer 3 virtual networks.
GET <cluster-ip>/dna/intent/api/v1/sda/layer3VirtualNetworks

Get layer 3 virtual networks.
PUT <cluster-ip>/dna/intent/api/v1/sda/layer3VirtualNetworks

Update layer 3 virtual networks.
DELETE <cluster-ip>/dna/intent/api/v1/sda/layer3VirtualNetworks

Delete layer 3 virtual networks.
DELETE <cluster-ip>/dna/intent/api/v1/sda/layer3VirtualNetworks/${id}

Delete layer 3 virtual network by ID.
GET <cluster-ip>/dna/intent/api/v1/sda/layer3VirtualNetworks/count

Get layer 3 virtual network count.

To access the new SDA APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Connectivity drop-down list and choose SDA.

Site APIs

Catalyst Center platform supports the following Site APIs:

GET <cluster-ip>/dna/data/api/v1/siteHealthSummaries

Read list of site health summaries.
GET <cluster-ip>/dna/data/api/v1/siteHealthSummaries/${id}

Read site health summary data by site ID.
GET <cluster-ip>/dna/data/api/v1/siteHealthSummaries/count

Read site count.
GET <cluster-ip>/dna/data/api/v1/siteHealthSummaries/summaryAnalytics

Read an aggregated summary of site health data.
POST <cluster-ip>/dna/data/api/v1/siteHealthSummaries/summaryAnalytics

Query an aggregated summary of site health data.
GET <cluster-ip>/dna/data/api/v1/siteHealthSummaries/trendAnalytics

Read trend analytics data for a grouping of sites in your network.
GET <cluster-ip>/dna/data/api/v1/siteHealthSummaries/${id}/trendAnalytics

Read trend analytics data for a specific site in your network.

To access the new Site APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Know Your Network drop-down list and choose Sites.

Site Design APIs

Catalyst Center platform supports the following Site Design APIs:

POST <cluster-ip>/dna/intent/api/v1/areas

Creates an area.
GET <cluster-ip>/dna/intent/api/v1/areas/${id}

Gets an area.
PUT <cluster-ip>/dna/intent/api/v1/areas/${id}

Updates an area.
DELETE <cluster-ip>/dna/intent/api/v1/areas/${id}

Deletes an area.
POST <cluster-ip>/dna/intent/api/v2/buildings

Creates a building.
GET <cluster-ip>/dna/intent/api/v2/buildings/${id}

Gets a building.
PUT <cluster-ip>/dna/intent/api/v2/buildings/${id}

Updates a building.
DELETE <cluster-ip>/dna/intent/api/v2/buildings/${id}

Deletes a building.
POST <cluster-ip>/dna/intent/api/v2/floors

Creates a floor.
GET <cluster-ip>/dna/intent/api/v2/floors/${id}

Gets a floor.
PUT <cluster-ip>/dna/intent/api/v2/floors/${id}

Updates a floor.
DELETE <cluster-ip>/dna/intent/api/v2/floors/${id}

Deletes a floor.
POST <cluster-ip>/dna/intent/api/v2/floors/${id}/uploadImage

Uploads floor image.
POST <cluster-ip>/dna/intent/api/v1/sites/bulk

Create sites.
GET <cluster-ip>/dna/intent/api/v1/sites

Get sites.
GET <cluster-ip>/dna/intent/api/v1/sites/count

Get sites count.
POST <cluster-ip>/dna/intent/api/v1/networkDevices/assignToSite/apply

Assign network devices to a site.
POST <cluster-ip>/dna/intent/api/v1/networkDevices/unassignFromSite/apply

Unassign network devices from sites.
GET <cluster-ip>/dna/intent/api/v1/networkDevices/assignedToSite

Get site assigned network devices.
GET <cluster-ip>/dna/intent/api/v1/networkDevices/assignedToSite/count

Get site assigned network devices count.
GET <cluster-ip>/dna/intent/api/v1/networkDevices/notAssignedToSite

Get site not assigned network devices.
GET <cluster-ip>/dna/intent/api/v1/networkDevices/${id}/assignedToSite

Get site assigned network device.
GET <cluster-ip>/dna/intent/api/v1/networkDevices/notAssignedToSite/count

Get site not assigned network devices count.
GET <cluster-ip>/dna/intent/api/v1/networkDevices/deviceControllability/settings

Get device controllability settings.
PUT <cluster-ip>/dna/intent/api/v1/networkDevices/deviceControllability/settings

Update device controllability settings.
GET <cluster-ip>/dna/intent/api/v1/networkProfilesforSites

Retrieves the list of network profiles for sites.
GET <cluster-ip>/dna/intent/api/v1/networkProfilesforSites/count

Retrieves the count of network profiles for sites.
GET <cluster-ip>/dna/intent/api/v1/networkProfilesforSites/${id}

Retrieves a network profiles for sites by ID.
DELETE <cluster-ip>/dna/intent/api/v1/networkProfilesforSites/${id}

Delete a network profiles for sites.
GET <cluster-ip>/dna/intent/api/v1/networkProfilesForSites/${profileId}/siteAssignments

Retrieves the list of sites that the given network profile for sites is assigned to.
POST <cluster-ip>/dna/intent/api/v1/networkProfilesForSites/${profileId}/siteAssignments

Assign a network profile for sites to the given site.
POST <cluster-ip>/dna/intent/api/v1/networkProfilesForSites/${profileId}/siteAssignments/bulk

Assign a network profile for sites to a list of sites.
DELETE <cluster-ip>/dna/intent/api/v1/networkProfilesForSites/${profileId}/siteAssignments/bulk

Unassigns a network profile for sites from multiple sites.
DELETE <cluster-ip>/dna/intent/api/v1/networkProfilesForSites/${profileId}/siteAssignments/${id}

Unassigns a network profile for sites from a site.
GET <cluster-ip>/dna/intent/api/v1/networkProfilesForSites/${profileId}/siteAssignments/count

Retrieves the count of sites that the given network profile for sites is assigned to.
GET <cluster-ip>/dna/intent/api/v1/sites/${siteId}/profileAssignments

Retrieves the list of network profiles that the given site has been assigned.
GET <cluster-ip>/dna/intent/api/v1/sites/${siteId}/profileAssignments/count

Retrieves the count of profiles that the given site has been assigned.

To access the new Site Design APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Site Management drop-down list and choose Site Design.

SWIM APIs

Catalyst Center platform supports the following SWIM APIs:

GET <cluster-ip>/dna/intent/api/v1/images

Returns list of software images.
POST <cluster-ip>/dna/intent/api/v1/images/${id}/download

Download the software image.
GET <cluster-ip>/dna/intent/api/v1/productNames

Retrieves the list of network device product names.
GET <cluster-ip>/dna/intent/api/v1/productNames/count

Count of network product names.
GET <cluster-ip>/dna/intent/api/v1/productNames/${productNameOrdinal}

Retrieve network device product name.
GET <cluster-ip>/dna/intent/api/v1/siteWiseProductNames

Returns network device product names for a site.
POST <cluster-ip>/dna/intent/api/v1/images/${imageId}/siteWiseProductNames

Assign network device product name to the given software image.
GET <cluster-ip>/dna/intent/api/v1/siteWiseProductNames/count

Returns the count of network device product names for a site.
DELETE <cluster-ip>/dna/intent/api/v1/images/${imageId}/siteWiseProductNames/${productNameOrdinal}

Unassign network device product name from the given software image.
PUT <cluster-ip>/dna/intent/api/v1/images/${imageId}/siteWiseProductNames/${productNameOrdinal}

Update the list of sites for the network device product name assigned to the software image.
GET <cluster-ip>/dna/intent/api/v1/images/count

Returns count of software images.
GET <cluster-ip>dna/intent/api/v1/images/${id}/addonImages/count

Returns count of add-on images.
GET <cluster-ip>/dna/intent/api/v1/images/distributionServerSettings

Retrieve image distribution servers.
POST <cluster-ip>/dna/intent/api/v1/images/distributionServerSettings

Add image distribution server.
GET <cluster-ip>/dna/intent/api/v1/images/distributionServerSettings/${id}

Retrieve specific image distribution server.
PUT <cluster-ip>/dna/intent/api/v1/images/distributionServerSettings/${id}

Update remote image distribution server.
DELETE <cluster-ip>/dna/intent/api/v1/images/distributionServerSettings/${id}

Remove image distribution server.
GET <cluster-ip>/dna/intent/api/v1/networkDeviceImageUpdates

Get network device image updates.
GET <cluster-ip>/dna/intent/api/v1/networkDeviceImageUpdates/count

Count of network device image updates.
GET <cluster-ip>/dna/intent/api/v1/images/${imageId}/siteWiseProductNames

Retrieves network device product names assigned to a software image
GET <cluster-ip>/dna/intent/api/v1/siteWiseProductNames/count

Returns the count of network device product names for a site.

To access the new SWIM APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Site Management drop-down list and choose Software Image Management (SWIM).

System Settings APIs

Catalyst Center platform supports the following System Settings APIs:

POST <cluster-ip>/dna/intent/api/v1/ipam/serverSetting

Creates configuration details of the external IPAM server. You should only create one external IPAM server; delete any existing external server before creating a new one.
GET <cluster-ip>/dna/intent/api/v1/ipam/serverSetting

Retrieves configuration details of the external IPAM server. If an external IPAM server has not been created, this resource will return a `404` response.
PUT <cluster-ip>/dna/intent/api/v1/ipam/serverSetting

Updates configuration details of the external IPAM server.
DELETE <cluster-ip>/dna/intent/api/v1/ipam/serverSetting

Deletes configuration details of the external IPAM server.
GET <cluster-ip>/dna/intent/api/v1/provisioningSettings

Get provisioning settings.
PUT <cluster-ip>/dna/intent/api/v1/provisioningSettings

Set provisioning settings.

To access the new System Settings APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Scroll down and click System Settings.

Task APIs

Catalyst Center platform supports the following Task APIs:

GET<cluster-ip>/dna/intent/api/v1/tasks

Get tasks.
GET<cluster-ip>/dna/intent/api/v1/tasks/count

Get tasks count.
GET<cluster-ip>/dna/intent/api/v1/tasks/${id}

Get tasks by ID.
GET<cluster-ip>/dna/intent/api/v1/tasks/${id}/detail

Get task details by ID.
GET <cluster-ip>/dna/data/api/v1/assuranceTasks/${id}

Retrieve a specific assurance task by id.
GET <cluster-ip>/dna/data/api/v1/assuranceTasks/count

Retrieve a count of the number of assurance tasks that currently exist.
GET <cluster-ip>/dna/data/api/v1/assuranceTasks

Retrieve a list of assurance tasks.

To access the new Task APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Operational Tasks drop-down list and choose Task.

Tag APIs

Catalyst Center platform supports the following Tag APIs:

GET <cluster-ip>/dna/intent/api/v1/tags/networkDevices/membersAssociations

Retrieve tags associated with network devices.
GET <cluster-ip>/dna/intent/api/v1/tags/interfaces/membersAssociations/count

Retrieve the count of interfaces that are associated with at least one tag.
GET <cluster-ip>/dna/intent/api/v1/tags/networkDevices/membersAssociations/count

Retrieve the count of network devices that are associated with at least one tag.
POST <cluster-ip>/dna/intent/api/v1/tags/networkDevices/membersAssociations/query

Query the tags associated with network devices.
POST <cluster-ip>/dna/intent/api/v1/tags/interfaces/membersAssociations/query

Query the tags associated with interfaces.
GET <cluster-ip>/dna/intent/api/v1/tags/interfaces/membersAssociations

Retrieve tags associated with the interfaces.

To access the new Tag APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Operation Tasks drop-down list and choose Tag.

Wireless APIs

With this release, Catalyst Center platform introduces the following new Wireless APIs.

Note

The new Wireless APIs do not support Cisco AireOS Wireless Controller. The support is extended only to the Cisco Catalyst 9800 family of devices.

GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/${networkDeviceId}/anchorManagedApLocations

Get Anchor Managed AP Locations for specific Wireless Controller.
GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/${networkDeviceId}/managedApLocations/count

Get Managed AP Locations Count for specific Wireless Controller.
GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/${networkDeviceId}/primaryManagedApLocations

Get Primary Managed AP Locations for specific Wireless Controller.
GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/${networkDeviceId}/secondaryManagedApLocations

Get Secondary Managed AP Locations for specific Wireless Controller.
GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/wirelessMobilityGroups/count

Get MobilityGroups Count.
GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/wirelessMobilityGroups

Get All MobilityGroups.
POST <cluster-ip>/dna/intent/api/v1/wirelessControllers/wirelessMobilityGroups/mobilityProvision

Mobility Provision.
POST <cluster-ip>/dna/intent/api/v1/wirelessControllers/wirelessMobilityGroups/mobilityReset

Mobility Reset.
GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/${networkDeviceId}/ssidDetails

Get SSID Details for specific Wireless Controller.
GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/${networkDeviceId}/ssidDetails/count

Get SSID Count for specific Wireless Controller.
PUT <cluster-ip>/dna/intent/api/v1/wirelessSettings/interfaces/${id}

Update Interface.
DELETE <cluster-ip>/dna/intent/api/v1/wirelessSettings/interfaces/${id}

Delete Interface.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/interfaces

Get Interfaces.
POST <cluster-ip>/dna/intent/api/v1/wirelessSettings/interfaces

Create Interface.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/interfaces/${id}

Get Interface by ID.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/interfaces/count

Get Interfaces Count.
POST <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/ssids

Create SSID.
PUT <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/ssids/${id}

Update SSID.
DELETE <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/ssids/${id}

Delete SSID.
GET <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/ssids

Get SSID by Site.
GET <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/ssids/${id}

Get SSID by ID.
GET <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/ssids/count

Get SSID Count by Site.
DELETE <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}

Delete Wireless Profile.
PUT <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}

Update Wireless Profile.
POST <cluster-ip>/dna/intent/api/v1/wirelessProfiles

Create Wireless Profile.
GET <cluster-ip>/dna/intent/api/v1/wirelessProfiles

Get Wireless Profiles.
GET <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}

Get Wireless Profile by ID.
GET <cluster-ip>/dna/intent/api/v1/wirelessProfiles/count

Get Wireless Profiles Count.
DELETE <cluster-ip>/dna/intent/api/v1/wirelessSettings/rfProfiles/${id}

Delete RF Profile.
POST <cluster-ip>/dna/intent/api/v1/wirelessSettings/rfProfiles

Create RF Profile.
PUT <cluster-ip>/dna/intent/api/v1/wirelessSettings/rfProfiles/${id}

Update RF Profile.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/rfProfiles

Get RF Profiles.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/rfProfiles/${id}

Get RF Profile by ID.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/rfProfiles/count

Get RF Profiles Count.
POST <cluster-ip>/dna/intent/api/v1/wirelessAccessPoints/factoryResetRequest/provision

Factory Reset Access Point(s).
GET <cluster-ip>/dna/intent/api/v1/wirelessAccessPoints/factoryResetRequestStatus

Get Access Point(s) Factory Reset status.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/dot11beProfiles

Get all 802.11be Profiles.
PUT <cluster-ip>/dna/intent/api/v1/wirelessSettings/dot11beProfiles/${id}

Update 802.11be Profile.
DELETE <cluster-ip>/dna/intent/api/v1/wirelessSettings/dot11beProfiles/${id}

Delete a 802.11be Profile.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/dot11beProfiles/${id}

Get 802.11be Profile by ID.
GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/dot11beProfiles/count

Get 802.11be Profiles Count.
POST <cluster-ip>/dna/intent/api/v1/wirelessSettings/dot11beProfiles

Create a 802.11be Profile.
POST<cluster-ip>/dna/intent/api/v1/wirelessControllers/${deviceId}/assignManagedApLocations

Assign Managed AP Locations For WLC.
POST<cluster-ip>/dna/intent/api/v1/wirelessControllers/${deviceId}/provision

Wireless Controller Provision.
POST <cluster-ip>/dna/intent/api/v1/wirelessAccessPoints/provision

AP Provision.

To access the new Wireless APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Connectivity drop-down list and choose Wireless.

API Enhancements

Device Onboarding (PnP) APIs

With this release:

The sudiSerialNos request parameter is renamed as userSudiSerialNos in the Update Device and Add Device APIs.
The addressIpV6 request parameter is added to the Add Virtual Account and Update PnP Server Profile APIs. This parameter is required when the cluster is configured with IPv6.
The isSudiRequired request parameter is renamed as sudiRequired in the Import Devices in bulk API.
A new optional request parameter called hostname is added to the Claim a Device to a Site API.
A new optional request parameter called authorizationNeeded is added to the Claim Device API.

Devices API

With this release, syncRequestedByApp and lastManagedResyncReasons response parameters are introduced in the Get Device list API.

Event Management API

The Get EventArtifacts API now includes the optional deprecationMessage and deprecated response parameters. If the deprecated value is true, then the event artifact is deprecated and a deprecation message is displayed.

Fabric Device APIs

With this release:

The request parameter deviceRoles accepts the WIRELESS_CONTROLLER_NODE value.
The Fabric Device APIs support is extended to wireless role.

Path Trace API

The egressPhysicalInterface, ingressPhysicalInterface, egressInterface, ingressInterface attributes are now optional attributes in the Retrieves Previous Pathtrace API.

SDA API

In this release, an optional isBpduGuardEnabled request body parameter is added in the Update authentication profile API. The value must not be null when the authenticationProfileName parameter is set as Closed Authentication.

Deprecated APIs

Fabric Wireless APIs

With this release, the following Fabric Wireless APIs are marked as Sunset:

DELETE <cluster-ip>/dna/intent/api/v1/business/sda/wireless-controller

Remove WLC from Fabric Domain.
PUT <cluster-ip>/dna/intent/api/v1/business/sda/hostonboarding/ssid-ippool

Update SSID to IP Pool Mapping.
POST <cluster-ip>/dna/intent/api/v1/business/sda/hostonboarding/ssid-ippool

Add SSID to IP Pool Mapping.
GET <cluster-ip>/dna/intent/api/v1/business/sda/hostonboarding/ssid-ippool

Get SSID to IP Pool Mapping.
POST <cluster-ip>/dna/intent/api/v1/business/sda/wireless-controller

Add WLC to Fabric Domain.

Network Settings APIs

With this release, the following Network Settings APIs are marked as Sunset:

POST <cluster-ip>/dna/intent/api/v1/network/${siteId}

Create Network.
POST <cluster-ip>/dna/intent/api/v2/network/${siteId}

Create Network V2.
PUT <cluster-ip>/dna/intent/api/v1/network/${siteId}

Update Network.
PUT <cluster-ip>/dna/intent/api/v2/network/${siteId}

Update Network V2.
GET <cluster-ip>/dna/intent/api/v1/network

Get Network.
GET <cluster-ip>/dna/intent/api/v2/network

Get Network V2.
POST <cluster-ip>/dna/intent/api/v1/credential-to-site/${siteId}

Assign Device Credential To Site.
POST <cluster-ip>/dna/intent/api/v2/credential-to-site/${siteId}

Assign Device Credential To Site V2.

Site Design APIs

With this release, the following Site Design APIs are marked as Sunset:

POST <cluster-ip>/dna/intent/api/v1/networkprofile/${networkProfileId}/site/${siteId}

Associate.
DELETE <cluster-ip>/dna/intent/api/v1/networkprofile/${networkProfileId}/site/${siteId}

Disassociate.

Site APIs

With this release, the following Site APIs are marked as Sunset:

GET <cluster-ip>/dna/intent/api/v1/site-member/${id}/member

Get devices that are assigned to a site.
POST <cluster-ip>/dna/intent/api/v1/assign-device-to-site/${siteId}/device

Assign Devices To Site.
POST <cluster-ip>/dna/intent/api/v1/site

Create Site.
DELETE <cluster-ip>/dna/intent/api/v1/site/${siteId}

Delete Site.
PUT <cluster-ip>/dna/intent/api/v1/site/${siteId}

Update Site.
GET <cluster-ip>/dna/intent/api/v1/site

Get Site.
GET <cluster-ip>/dna/intent/api/v2/site

Get Site V2.
GET <cluster-ip>/dna/intent/api/v1/site/count

Get Site Count.
GET <cluster-ip>/dna/intent/api/v1/membership/${siteId}

Get Membership.
GET <cluster-ip>/dna/intent/api/v2/site/count

Get Site Count V2.

Task APIs

With this release, the following Task APIs are marked as Sunset:

GET <cluster-ip>/dna/intent/api/v1/task

Get tasks.
GET <cluster-ip>/dna/intent/api/v1/task/${taskId}

Get task by ID.
GET <cluster-ip>/dna/intent/api/v1/task/operation/${operationId}/${offset}/${limit}

Get task by OperationId.
GET <cluster-ip>/dna/intent/api/v1/task/${taskId}/tree

Get task tree.
GET <cluster-ip>/dna/intent/api/v1/task/count

Get task count.

Wireless APIs

With this release, the following Wireless APIs are marked as Sunset:

POST <cluster-ip>/dna/intent/api/v1/wireless/profile

Create Wireless Profile.
GET <cluster-ip>/dna/intent/api/v1/wireless/profile

Get Wireless Profile.
DELETE <cluster-ip>/dna/intent/api/v1/wireless-profile/${wirelessProfileName}

Delete Wireless Profile.
PUT <cluster-ip>/dna/intent/api/v1/wireless/profile

Update Wireless Profile.
GET <cluster-ip>/dna/intent/api/v1/wireless/rf-profile

Retrieve RF profiles.
DELETE <cluster-ip>/dna/intent/api/v1/wireless/rf-profile/${rfProfileName}

Delete RF profiles.
POST <cluster-ip>/dna/intent/api/v1/wireless/rf-profile

Create or Update RF profile.
GET <cluster-ip>/dna/intent/api/v1/wireless/dynamic-interface

Get dynamic interface.
PUT <cluster-ip>/dna/intent/api/v1/wireless/dynamic-interface

Create Update Dynamic interface.
DELETE <cluster-ip>/dna/intent/api/v1/wireless/dynamic-interface

Delete dynamic interface.
POST <cluster-ip>/dna/intent/api/v1/enterprise-ssid

Create Enterprise SSID.
PUT <cluster-ip>/dna/intent/api/v1/enterprise-ssid

Update Enterprise SSID.
Delete <cluster-ip>/dna/intent/api/v1/enterprise-ssid/${ssidName}

Delete Enterprise SSID.
GET <cluster-ip>/dna/intent/api/v1/enterprise-ssid

Get Enterprise SSID.
DELETE <cluster-ip>/dna/intent/api/v1/business/ssid/${ssidName}/${managedAPLocations}

Delete SSID and provision it to devices.
POST <cluster-ip>/dna/intent/api/v1/business/ssid

Create and Provision SSID.
GET <cluster-ip>/dna/intent/api/v1/task/count

AP Provision.
POST <cluster-ip>/dna/intent/api/v1/wireless/ap-provision

Provision update.
POST <cluster-ip>/dna/intent/api/v1/wireless/provision

Provision.

API Changes That Break Backward Compatibility

None

—

Feature

Description

Where documented

Audit Log Report

This Catalyst Center platform release supports a new Audit Log report.

For more information, see:

Run an audit log report.
New Report in the Cisco Catalyst Center Release Notes.

New APIs

LAN Automation APIs

Catalyst Center platform supports the following LAN Automation APIs:

POST <cluster-ip>/dna/intent/api/v2/lan-automation

LAN Automation Start V2.
PUT <cluster-ip>/dna/intent/api/v2/lan-automation/${id}

LAN Automation Stop and Update Devices V2.

To access the new LAN Automation APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Site Management drop-down list and choose LAN Automation.

Reports APIs

Catalyst Center platform supports the following Reports APIs:

GET <cluster-ip>/dna/data/api/v1/flexible-report/schedule/${reportId}

Get Flexible report schedule by report ID.
GET <cluster-ip>/dna/data/api/v1/flexible-report/report/${reportId}/executions

Get Execution ID by report ID.
POST <cluster-ip>/dna/data/api/v1/flexible-report/report/${reportId}/execute

Executing the Flexible report.
PUT <cluster-ip>/dna/data/api/v1/flexible-report/schedule/${reportId}

Update schedule of Flexible report.
GET <cluster-ip>/dna/data/api/v1/flexible-report/schedules

Get all Flexible report schedules.
GET <cluster-ip>/dna/data/api/v1/flexible-report/report/content/${reportId}/${executionId}

Download Flexible report.

To access the new Reports APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Operational Tasks drop-down list and choose Reports.

SD-Access APIs

Catalyst Center platform supports the following SDA APIs:

Extranet Policy APIs

GET <cluster-ip>/dna/intent/api/v1/sda/extranetPolicies

Get extranet policies.
PUT <cluster-ip>/dna/intent/api/v1/sda/extranetPolicies

Update extranet policy.
POST <cluster-ip>/dna/intent/api/v1/sda/extranetPolicies

Add extranet policy.
GET <cluster-ip>/dna/intent/api/v1/sda/extranetPolicies/count

Get extranet policy count.
DELETE <cluster-ip>/dna/intent/api/v1/sda/extranetPolicies/${id}

Delete extranet policy by ID.

Port Assignment APIs

POST <cluster-ip>/dna/intent/api/v1/sda/portAssignments

Add port assignments.
GET <cluster-ip>/dna/intent/api/v1/sda/portAssignments

Get port assignments.
PUT <cluster-ip>/dna/intent/api/v1/sda/portAssignments

Update port assignments.
GET <cluster-ip>/dna/intent/api/v1/sda/portAssignments/count

Get port assignment count.
DELETE <cluster-ip>/dna/intent/api/v1/sda/portAssignments/${id}

Delete port assignment by ID.
DELETE <cluster-ip>/dna/intent/api/v1/sda/portAssignments

Delete port assignments.

Fabric Site APIs

POST <cluster-ip>/dna/intent/api/v1/sda/fabricSites

Add fabric site.
PUT <cluster-ip>/dna/intent/api/v1/sda/fabricSites

Update fabric site.
DELETE <cluster-ip>/dna/intent/api/v1/sda/fabricSites/${id}

Delete fabric site by ID.
GET <cluster-ip>/dna/intent/api/v1/sda/fabricSites

Get fabric sites.
GET <cluster-ip>/dna/intent/api/v1/sda/fabricSites/count

Get fabric site count.

Fabric Zone APIs

POST <cluster-ip>/dna/intent/api/v1/sda/fabricZones

Add fabric zone.
PUT <cluster-ip>/dna/intent/api/v1/sda/fabricZones

Update fabric zone.
DELETE <cluster-ip>/dna/intent/api/v1/sda/fabricZones/${id}

Delete fabric zone by ID.
GET <cluster-ip>/dna/intent/api/v1/sda/fabricZones

Get fabric zones.
GET <cluster-ip>/dna/intent/api/v1/sda/fabricZones/count

Get fabric zone count.

Authentication Profile APIs

PUT <cluster-ip>/dna/intent/api/v1/sda/authenticationProfiles

Update authentication profile.
GET <cluster-ip>/dna/intent/api/v1/sda/authenticationProfiles

Get authentication profiles.

Bulk Device Provisioning APIs

GET <cluster-ip>/dna/intent/api/v1/sda/provisionDevices

Get provisioned devices.
POST <cluster-ip>/dna/intent/api/v1/sda/provisionDevices

Provision devices.
GET <cluster-ip>/dna/intent/api/v1/sda/provisionDevices/count

Get provisioned devices count.
DELETE <cluster-ip>/dna/intent/api/v1/sda/provisionDevices

Delete provisioned devices.
PUT <cluster-ip>/dna/intent/api/v1/sda/provisionDevices

Reprovision devices.
DELETE <cluster-ip>/dna/intent/api/v1/ sda/provisionDevices/${id}

Delete provisioned device by ID.

Fabric Device APIs

POST <cluster-ip>/dna/intent/api/v1/sda/fabricDevices

Add fabric devices.
GET <cluster-ip>/dna/intent/api/v1/sda/fabricDevices

Get fabric devices.
GET <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/count

Get fabric devices count.
DELETE <cluster-ip>/dna/intent/api/v1/sda/fabricDevices

Delete fabric devices.
DELETE <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/${id}

Delete a fabric device by ID.
PUT <cluster-ip>/dna/intent/api/v1/sda/fabricDevices

Update fabric devices.

Fabric Device Layer 2 Handoff APIs

POST <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/ layer2Handoffs

Add fabric devices Layer 2 handoffs.
GET <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/ layer2Handoffs

Get fabric devices Layer 2 handoffs.
GET <cluster-ip>/ dna/intent/api/v1/sda/fabricDevices/layer2Handoffs/count

Get fabric devices Layer 2 handoffs count.
DELETE <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/ layer2Handoffs

Delete fabric devices Layer 2 handoffs.
DELETE <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/ layer2Handoffs/${id}

Delete fabric device Layer 2 handoff by ID.

Fabric Device IP Transit Layer 3 Handoff APIs

POST <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits

Add fabric devices Layer 3 handoffs with IP transit.
GET <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits

Get fabric devices Layer 3 handoffs with IP transit.
GET <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits/count

Get fabric devices Layer 3 handoffs with IP transit count.
DELETE <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits

Delete fabric devices Layer 3 handoffs with IP transit.
DELETE <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits/${id}

Delete fabric device Layer 3 handoff with IP transit by ID.
PUT <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits

Update fabric devices Layer 3 handoffs with IP transit.

Fabric Device SDA Transit Layer 3 Handoff APIs

POST <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/sdaTransits

Add fabric devices Layer 3 handoffs with SDA transit.
GET <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/ layer3Handoffs/sdaTransits

Get fabric devices Layer 3 handoffs with SDA transit.
GET <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/ layer3Handoffs/sdaTransits/count

Get fabric devices Layer 3 handoffs with SDA transit count.
DELETE <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/ layer3Handoffs/sdaTransits

Delete fabric devices Layer 3 handoffs with SDA transit.
PUT <cluster-ip>/dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/sdaTransits

Update fabric devices Layer 3 handoffs with SDA transit.

Anycast Gateways APIs

DELETE <cluster-ip>/dna/intent/api/v1/sda/anycastGateways/${id}

Delete anycast gateway by ID.
PUT <cluster-ip>/dna/intent/api/v1/sda/anycastGateways

Update anycast gateways.
GET <cluster-ip>/dna/intent/api/v1/sda/anycastGateways

Get anycast gateways.
POST <cluster-ip>/dna/intent/api/v1/sda/anycastGateways

Add anycast gateways.
GET <cluster-ip>/dna/intent/api/v1/sda/anycastGateways/count

Get anycast gateway count.

To access the new SDA APIs, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the Connectivity drop-down list and choose SDA.

API Enhancements

LAN Automation APIs

The LAN Automation Device Update API now includes a new query param HOSTNAME_UPDATE to change the hostname of the device based on the new request body parameter hostnameUpdateDevices.
The LAN Automation Status By Id and LAN Automation Status APIs now include three additional optional parameters discoveryLevel, discoveryTimeout, and discoveryDevices which are displayed in the response body when the user starts LAN Automation using the LAN Automation Start V2 API.

Devices APIs

In this release, you can provide IPv6 addresses to assign the devices in the Assign Devices to Site API.
In the Export Device list API, the password parameter is now optional.
With this release, Catalyst Center platform supports the following changes in the response parameters of the Get Device Interfaces by specified range, Get Interface info by Id, Get Interface by IP, Get OSPF interfaces, Get ISIS interfaces, Get Interface by interface name, Get all interfaces, and Get Interface by Id APIs:
- The addresses, lastOutgoingPacketTime, lastIncomingPacketTime, mtu, and name response parameters are now included in the above APIs.
- The poweroverethernet, networkdevice_id, managedNetworkElementUrl, managedNetworkElement, managedComputeElementUrl, and managedComputeElement response parameters are now removed from the above APIs.

Network Settings API

In this release, a new groupName request query parameter is added in the Get Reserve IP Subpool API. The siteId parameter is now optional.

Note

When you omit the siteId parameter:

You must use the ignoreInheritedGroups parameter.
The maximum page size of the response is 1000 entries.

Deprecated APIs

None

—

API Changes That Break Backward Compatibility

None

—

Table 5. New and changed features in Catalyst Center platform 2.3.7.4
Feature	Description
Name Change to Catalyst Center	As part of our vision to converge our products around an integrated platform, we are changing the name of the Cisco DNA Center platform to Catalyst Center platform in this release. The capability and functionality of Catalyst Center remains the same as Cisco DNA Center.
New APIs
User and Roles APIs	Catalyst Center platform supports the following User and Roles APIs: POST <cluster-ip>/dna/system/api/v1/users/external-servers/aaa-attribute Add and update AAA Attribute API. GET <cluster-ip>/dna/system/api/v1/users/external-servers/aaa-attribute Get AAA Attribute API. DELETE <cluster-ip>/dna/system/api/v1/users/external-servers/aaa-attribute Delete AAA Attribute API. POST <cluster-ip>/dna/system/api/v1/users/external-authentication Manage External Authentication Setting API. GET <cluster-ip>/dna/system/api/v1/users/external-authentication Get External Authentication Setting API. To access the new User and Roles APIs, click the menu icon and choose Platform > Developer Toolkit > APIs > User and Roles.
ITSM Integration API	Catalyst Center platform supports the following ITSM Integration API: GET <cluster-ip>/dna/intent/api/v1/integration-settings/status Fetches the ITSM integration status. To access the new ITSM Integration API, click the menu icon and choose Platform > Developer Toolkit > APIs. Expand the Integrations drop-down list and choose ITSM Integration.
API Enhancements
Devices API	In the Add User-Defined-Field to device API, the `value` request parameter is now a required attribute.
Discovery APIs	The request parameters of the Create Global Credentials V2 and Update Global Credentials V2 APIs, `httpRead.name` and `httpWrite.name`, are now changed to `httpRead.description` and `httpWrite.description`, respectively.
Deprecated APIs
Devices API	The Get Device Config for all devices API is deprecated.

Bias-Free Language

Book Title

Cisco Catalyst Center Platform User Guide, Release 2.3.7.x

Chapter Title

New and Changed Information

Results

Chapter: New and Changed Information

New and Changed Information

New and changed information

Was this Document Helpful?

Contact Cisco