Client Report

Catalyst Center platform supports a new Client report template called Client Roam Events.

Use this template to generate a report on devices that frequently (within 10 minutes) switch between adjacent access points (APs) despite being stationary.

For more information, see:

• Generate a client report.

• New and changed features in Catalyst Center platform 3.1.6 in the Cisco Catalyst Center Release Notes.

New API Operations

Devices API Operations

Catalyst Center platform supports these Devices API operations:

• GET <cluster-ip>/dna/intent/api/v1/discoverys/${id}/jobs

  Fetches all the discovery job details by discovery ID.

• POST <cluster-ip>/dna/intent/api/v1/discoverys

  Creates discovery.

• POST <cluster-ip>/dna/intent/api/v1/discoverys/${discoveryId}/jobs/${jobId}/stop

  Stops the existing discovery.

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

  Adds a new network device.

• PUT <cluster-ip>/dna/intent/api/v1/networkDevices/${id}

  Updates the network device.

• POST <cluster-ip>/dna/intent/api/v1/networkDevices/${id}/update

  Partially updates an existing network device.

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

  Exports the credentials of network devices.

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

  Validates a network device.

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

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

Network Settings API Operations

Catalyst Center platform supports these Network Settings API operations:

• POST <cluster-ip>/dna/intent/api/v1/globalCredentials

  Adds new global credential.

• GET <cluster-ip>/dna/intent/api/v1/globalCredentials/count

  Get count of the global credentials.

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

  Get details of a single global credential.

• PUT <cluster-ip>/dna/intent/api/v1/globalCredentials/${id}

  Update global credential by the given identifier.

• DELETE <cluster-ip>/dna/intent/api/v1/globalCredentials/${id}

  Delete global credential by the given identifier.

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

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

Security API Operations

Catalyst Center platform supports these Security API operations:

• GET <cluster-ip>/dna/data/api/v1/trafficSteeringContracts/topNAnalytics

  Retrieves the top-n analytics data related to contracts.

• GET <cluster-ip>/dna/data/api/v1/trafficSteeringNodes/topNAnalytics

  Retrieves the top-n analytics data related to nodes.

• GET <cluster-ip>/dna/data/api/v1/trafficSteeringFirewalls/topNAnalytics

  Retrieves the top-n analytics data related to firewalls.

• GET <cluster-ip>/dna/intent/api/v1/trafficSteeringPolicys

  Retrieve traffic steering policies.

• POST <cluster-ip>/dna/intent/api/v1/trafficSteeringPolicys

  Creates a traffic steering policy.

• GET <cluster-ip>/dna/intent/api/v1/trafficSteeringPolicys/count

  Retrieve the count of traffic steering policies.

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

  Retrieve a traffic steering policy.

• PUT <cluster-ip>/dna/intent/api/v1/trafficSteeringPolicys/${id}

  Update a steering policy.

• DELETE <cluster-ip>/dna/intent/api/v1/trafficSteeringPolicys/${id}

  Delete a steering policy.

• POST <cluster-ip>/dna/intent/api/v1/trafficSteeringPolicys/bulk

  Create multiple traffic steering policies in bulk.

• GET <cluster-ip>/dna/intent/api/v1/trafficSteeringContracts

  Retrieve traffic steering contracts.

• POST <cluster-ip>/dna/intent/api/v1/trafficSteeringContracts

  Creates a traffic steering contract.

• GET <cluster-ip>/dna/intent/api/v1/trafficSteeringContracts/count

  Retrieve the count of traffic steering contracts.

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

  Retrieve a traffic steering contract by its ID.

• PUT <cluster-ip>/dna/intent/api/v1/trafficSteeringContracts/${id}

  Modify a traffic steering contract.

• DELETE <cluster-ip>/dna/intent/api/v1/trafficSteeringContracts/${id}

  Delete a traffic steering contract.

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

Expand the Policy drop-down list and choose Security.

Site Design API Operation

Catalyst Center platform supports this Site Design API operation:

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

Get a site.

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

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

System Software Upgrade API Operations

Catalyst Center platform supports these System Software Upgrade API operations:

• GET <cluster-ip>/dna/system/api/v1/softwareManagementExecutions/${id}

  Get software management execution details.

• POST <cluster-ip>/dna/system/api/v1/downloadSoftwareRelease

  Download release.

• GET <cluster-ip>/dna/system/api/v1/installedRelease

  Get installed release details.

• DELETE <cluster-ip>/dna/system/api/v1/downloadSoftwareRelease

  Delete downloaded release.

• PUT <cluster-ip>/dna/system/api/v1/downloadSoftwareRelease

  Update downloaded release.

• POST <cluster-ip>/dna/system/api/v1/upgradeSoftwareRelease

  Update release.

• POST <cluster-ip>/dna/system/api/v1/installOptionalPackages

  Install optional packages.

• GET <cluster-ip>/dna/system/api/v1/releases/releaseSummary

  Get release detail.

• GET <cluster-ip>/dna/system/api/v1/releases

  Get all releases.

• POST <cluster-ip>/dna/system/api/v1/uninstallOptionalPackages

  Uninstall optional packages.

To access the new System Software Upgrade API operations, click the menu icon and choose Platform > Developer Toolkit > APIs.

Expand the System drop-down list and choose System Software Upgrade.

Wireless API Operations

Catalyst Center platform supports these Wireless API operations:

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

  Get LSC Certificate Renewal profiles.

• GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/certificateRenewalProfiles/${id}

  Get LSC Certificate Renewal Profile by ID.

• GET <cluster-ip>/dna/intent/api/v1/wirelessSettings/certificateRenewalProfiles/count

  Get LSC certificate renewal profile count.

• POST <cluster-ip>/dna/intent/api/v1/wirelessSettings/certificateRenewalProfiles

  Create LSC Certificate Renewal Profile.

• PUT <cluster-ip>/dna/intent/api/v1/wirelessSettings/certificateRenewalProfiles/${id}

  Update LSC Certificate Renewal Profile.

• DELETE <cluster-ip>/dna/intent/api/v1/wirelessSettings/certificateRenewalProfiles/${id}

  Delete LSC Certificate Renewal Profile by ID.

• POST <cluster-ip>/dna/intent/api/v1/wirelessControllers/${deviceId}/certificateRenewal

  Access points LSC Certificate Instantaneous renewal.

• GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/${deviceId}/siteTags

  Get all site tags from Wireless Controller.

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

Expand the Connectivity drop-down list and choose Wireless.

API Changes

Devices API Operation

This API operation includes a new response view called Credentials which allows you to fetch device credentials:

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

Get details of a single network device.

Wireless API Operations

This release supports changes in these Wireless API operations:

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

  Get 802.11be profiles.

• PUT <cluster-ip>/dna/intent/api/v1/wirelessSettings/dot11beProfiles/${id}

  Update 802.11be profile.

• POST <cluster-ip>/dna/intent/api/v1/wirelessSettings/dot11beProfiles

  Create a 802.11be profile.

List of changes in the above API operations:

• The Multi Link Operation (MLO) groups in the 802.11be profiles now include the primary24ghzEnable, primary5ghzEnable, secondary5ghzEnable and primary6ghzEnable query parameters.

• Default is a new query parameter that specifies whether the 802.11be profile's properties should be set to system default profile on device (default-dot11be-profile) or not.

• The ofdmaDownLink, ofdmaUpLink, muMimoDownLink and muMimoUpLink parameters are deprecated in IOS-XE versions 17.18.2 and above, and will be ignored during provisioning.

This API operation now includes the new lscProfileName and lscPercentage query parameters:

POST <cluster-ip>/dna/intent/api/v1/wirelessControllers/${deviceId}/provision

Wireless Controller Provision.

Deprecated API Operations

None

API Operation Changes That Break Backward Compatibility

None

New API Operations

Compliance API Operations

Catalyst Center platform supports these Compliance API operations:

• POST <cluster-ip>/dna/intent/api/v1/compliancePolicys

  Create a new policy.

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys

  Retrieve the policies.

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys/count

  Retrieve the count of policies.

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

  Retrieve a specific policy.

• PUT <cluster-ip>/dna/intent/api/v1/compliancePolicys/${id}

  Update an existing policy.

• DELETE <cluster-ip>/dna/intent/api/v1/compliancePolicys/${id}

  Delete a specific policy.

• POST <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules

  Create a new rule.

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules

  Retrieve the rules.

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/count

  Retrieve the count of rules.

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${id}

  Retrieve a specific rule.

• PUT <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${id}

  Update an existing rule.

• DELETE <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${id}

  Delete a specific rule.

• POST <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/conditions

  Create a new condition

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/conditions

  Retrieve the conditions.

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/conditions/count

  Retrieve the count of conditions.

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/conditions/${id}

  Retrieve a specific condition.

• PUT <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/conditions/${id}

  Update an existing condition.

• DELETE <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/conditions/${id}

  Delete a specific condition.

• POST <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/variables

  Create a new variable.

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/variables

  Retrieve the variables.

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/variables/count

  Retrieve the count of variables.

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/variables/${id}

  Retrieve a specific variable.

• PUT <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/variables/${id}

  Update an existing variable.

• DELETE <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/rules/${ruleId}/variables/${id}

  Delete a specific variable.

• PUT <cluster-id>/dna/intent/api/v1/compliancePolicys/${policyId}/siteAssignments

  Set site assignments for policy.

• GET <cluster-id>/dna/intent/api/v1/compliancePolicys/${policyId}/siteAssignments

  Retrieve site assignments for policy.

• PUT <cluster-id>/dna/intent/api/v1/compliancePolicys/${policyId}/sites/${siteId}/rules/${ruleId}/variables

  Set site variables.

• GET <cluster-ip>/dna/intent/api/v1/compliancePolicys/${policyId}/sites/ ${siteId}/rules/${ruleId}/variables

  Retrieve site variables.

• GET <cluster-ip>/dna/intent/api/v1/compliance/networkDevices/${networkDeviceId}/detail/policys

  Retrieve the violating policies.

• GET <cluster-ip>/dna/intent/api/v1/compliance/networkDevices/${networkDeviceId}/detail/policys/${policyId}/violations

  Retrieve the policy violations.

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

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

Devices API Operations

Catalyst Center platform supports these Devices API operations:

• GET <cluster-ip>/dna/intent/api/v1/filterGroups

  Get the filter groups for given search criteria.

• POST <cluster-ip>/dna/intent/api/v1/filterGroups

  Create filter group.

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

  Get the filter group details for the given ID.

• PUT <cluster-ip>/dna/intent/api/v1/filterGroups/${id}

  Update filter group.

• DELETE <cluster-ip>/dna/intent/api/v1/filterGroups/${id}

  Delete a filter group.

• GET <cluster-ip>/dna/intent/api/v1/filterGroupAssociations

  Get the filter group associations.

• DELETE <cluster-ip>/dna/intent/api/v1/filterGroupAassociations/${id}

  Delete filter group association.

• POST <cluster-ip>/dna/intent/api/v1/filterGroupAssociations

  Create filter group association.

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

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

User and Roles API Operations

Catalyst Center platform supports these User and Roles API operations:

• POST <cluster-ip>/dna/system/api/v2/roles

  Add role v2.

• POST <cluster-ip>/dna/system/api/v1/accessGroups

  Add access group.

• GET <cluster-ip>/dna/system/api/v1/accessGroups/${id}

  Get access group.

• DELETE <cluster-ip>/dna/system/api/v1/accessGroups/${id}

  Delete access group.

• PUT <cluster-ip>/dna/system/api/v1/accessGroups/${id}

  Update access group.

• GET <cluster-ip>/dna/system/api/v1/accessGroups

  Get access groups.

• GET <cluster-ip>/dna/system/api/v1/accessGroups/count

  Get access group count.

• DELETE <cluster-ip>/dna/system/api/v2/roles/${id}

  Delete role v2.

• GET <cluster-ip>/dna/system/api/v2/roles/Permissions

  Get permissions v2.

• GET <cluster-ip>/dna/system/api/v2/roles/${id}

  Get role v2.

• PUT <cluster-ip>/dna/system/api/v2/roles/${id}

  Update role v2.

• GET <cluster-ip>/dna/system/api/v2/roles

  Get roles v2.

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

Expand the System drop-down list and choose User and Roles.

API Operation Enhancements

Backup API Operations

This release supports these new enhancements in the Backup API operations:

• The nfsVersion attribute is now a required attribute in the Create NFS Configuration. API operation.

• The storageType query parameter now includes enum values in the Get Backup Storages API operation.

• The taskId attribute is now a required attribute in the Async response schema.

• The Get Backup By ID, Get Backup And Restore Execution, Get All Backup, and Get Backup And Restore Executions API operations now include enum values for the status, jobType, and scope response parameters.

Health and Performance API Operations

With this release, these Health and Performance API Operations support new changes:

1. GET <cluster-ip>/dna/intent/api/v1/diagnostics/system/performance

   System Performance API.

   • Functionality: Retrieves average values of cluster KPIs (CPU utilization, memory utilization, network rates) for the past 15 minutes.

   • Parameter changes: The parameters function, startTime, and endTime are no longer supported from this release.

2. GET <cluster-ip>/dna/intent/api/v1/diagnostics/system/performance/history

   System Performance Historical API

   • Functionality: Retrieves hourly data of cluster KPIs (CPU utilization, memory utilization, network rates) for the past 24 hours.

   • Parameter changes: The parameters startTime and endTime are no longer supported from this release.

   • Default behavior change: The API operation will return hourly data for 24 hours, by default.

Network Settings API operations

The overlapping and addressSpaceId attributes are included as optional fields in the response of these API operations:

• GET <cluster-ip>/dna/intent/api/v1/ipam/siteIpAddressPools

  Retrieves IP address subpools.

• GET <cluster-ip>/dna/intent/api/v1/ipam/siteIpAddressPools/${id}

  Retrieves an IP address subpool.

The overlapping and addressSpaceId attributes are now included as optional fields in the payload of this API operation:

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

Reserve (create) IP address subpools.

The overlapping attribute is now included as an optional field in the payload of this API operation:

PUT <cluster-ip>/dna/intent/api/v1/ipam/siteIpAddressPools/${id}

Updates an IP address subpool.

Deprecated API Operations

User and Roles API Operations

With this release, these User and Roles API operations are marked as Sunset:

• POST <cluster-ip>/dna/system/api/v1/role

  Add role API.

• DELETE <cluster-ip>/dna/system/api/v1/role/${roleId}

  Delete role API.

• GET <cluster-ip>/dna/system/api/v1/roles

  Get roles API.

• PUT <cluster-ip>/dna/system/api/v1/role

  Update role API.

• GET <cluster-ip>/dna/system/api/v1/role/permissions

  Get permissions API.

API Operation Changes That Break Backward Compatibility

Devices API Operations

The minimum periodic resync interval (both per device and global) has been increased from 25 minutes to 6 hours to improve performance and optimize resource allocation. These changes apply to both these API operations:

• PUT <cluster-ip>/dna/intent/api/v1/networkDevices/${id}/resyncIntervalSettings

  Update Resync Interval for a Network Device.

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

  Update Global Resync Interval.

Behavior changes:

• Any device with a resync interval of less than 6 hours will automatically have its interval increased to the new minimum of 6 hours.

• Devices already configured with a resync interval of 6 hours or longer will remain unchanged.

• If the global resync interval is set to less than 6 hours, it will be increased to 6 hours. If the global resync interval is already 6 hours or more, it will remain unchanged.

Network Devices Report

This Catalyst Center Platform release supports a new Network Devices report template called Energy Management.

Using this report template, you can retrieve a consolidated Energy Management report showing energy consumption, cost, carbon emission, and carbon intensity data of your network devices, providing complete visibility.

For more information, see:

• Generate a network devices report.

• New Report Template in the Cisco Catalyst Center Release Notes.

New API Operations

Applications API Operations

Catalyst Center platform supports these Applications API operations:

• POST <cluster-ip>/dna/data/api/v1/networkApplications/${id}/trendAnalytics

  Retrieves the Trend analytics related to specific network application.

• POST <cluster-ip>/dna/data/api/v1/networkApplications/summaryAnalytics

  Retrieves summary analytics data related to network applications along with health metrics.

• GET <cluster-ip>/dna/data/api/v1/thousandEyesTestResults/trendAnalytics

  The trend analytics data for ThousandEyes test results in the specified time range.

• GET <cluster-ip>/dna/data/api/v1/thousandEyesTestResults

  Retrieves the list of ThousandEyes test results along with related metrics.

• GET <cluster-ip>/dna/data/api/v1/thousandEyesTestResults/count

  Retrieves the total count of ThousandEyes test results.

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

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

Backup API Operations

Catalyst Center platform supports these Backup APIs operations:

• GET <cluster-ip>/dna/system/api/v1/backupStorages

  Get Backup Storages.

• GET <cluster-ip>/dna/system/api/v1/backups/${id}

  Get Backup By ID.

• POST <cluster-ip>/dna/system/api/v1/backupNfsConfigurations

  Create NFS Configuration.

• DELETE <cluster-ip>/dna/system/api/v1/backups/${id}

  Delete Backup.

• GET <cluster-ip>/dna/system/api/v1/backupRestoreExecutions/${id}

  Get Backup And Restore Execution.

• DELETE <cluster-ip>/dna/system/api/v1/backupNfsConfigurations/${id}

  Delete NFS Configuration.

• GET <cluster-ip>/dna/system/api/v1/backupNfsConfigurations

  Get All NFS Configuration.

• GET <cluster-ip>/dna/system/api/v1/backups

  Get All Backup.

• GET <cluster-ip>/dna/system/api/v1/backupRestoreExecutions

  Get Backup And Restore Executions.

• POST <cluster-ip>/dna/system/api/v1/backups

  Create Backup.

• POST <cluster-ip>/dna/system/api/v1/backupConfiguration

  Create Backup Configuration.

• GET <cluster-ip>/dna/system/api/v1/backupConfiguration

  Get Backup Configuration.

• POST <cluster-ip>/dna/system/api/v1/backups/${id}/restore

  Restore Backup.

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

Expand the System drop-down list and choose Backup.

Clients API Operations

Catalyst Center platform supports these Clients API operations:

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

  Count clients energy.

• POST <cluster-ip>/dna/data/api/v1/energy/clients/query

  Query clients energy.

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

  Get clients energy.

• GET <cluster-ip>/dna/data/api/v1/energy/clients/${id}

  Get client energy by ID.

• POST <cluster-ip>/dna/data/api/v1/energy/clients/query/count

  Count clients energy from query.

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

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

Devices API operations

Catalyst Center platform supports these Devices API operations:

• POST <cluster-ip>/dna/data/api/v1/energy/networkDevices/query

  Query devices energy.

• POST <cluster-ip>/dna/data/api/v1/energy/networkDevices/query/count

  Count devices energy from query.

• GET <cluster-ip>/dna/data/api/v1/energy/networkDevices/count

  Count devices energy.

• GET <cluster-ip>/dna/data/api/v1/energy/networkDevices/${id}

  Get device energy by ID.

• GET <cluster-ip>/dna/data/api/v1/energy/networkDevices

  Get devices energy.

• GET <cluster-ip>/dna/intent/api/v1/networkDevices/${networkDeviceId}/portChannels/count

  Retrieve port channels count for a network device.

• GET <cluster-ip>/dna/intent/api/v1/networkDevices/${networkDeviceId}/portChannels/${id}

  Retrieves information for the given port channel on a specific network device.

• GET <cluster-ip>/dna/intent/api/v1/networkDevices/${networkDeviceId}/portChannels

  Retrieves the list of port channels for the network device.

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

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

Energy Analytics API Operations

Catalyst Center platform supports these energy analytics API operations:

• POST <cluster-ip>/dna/data/api/v1/energy/trendAnalytics

  Get energy trend analytics.

• POST <cluster-ip>/dna/data/api/v1/energy/summaryAnalytics

  Get energy summary analytics.

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

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

Industrial Configuration API Operations

Catalyst Center platform supports these Industrial Configuration API operations:

• GET <cluster-ip>/dna/intent/api/v1/iot/repRings/{id}

  Get the REP ring based on the ring ID.

• POST <cluster-ip>/dna/intent/api/v1/iot/repRings/query

  Retrieves the list of REP rings.

• POST <cluster-ip>/dna/intent/api/v1/iot/nonFabric/repRings

  Configure a REP Ring on NON-FABRIC deployment.

• POST <cluster-ip>/dna/intent/api/v1/iot/fabric/repRings

  Configure a REP Ring on FABRIC deployment.

• DELETE <cluster-ip>/dna/intent/api/v1/iot/fabric/repRings/${id}

  Delete REP ring configured in the FABRIC deployment.

• DELETE <cluster-ip>/dna/intent/api/v1/iot/nonFabric/repRings/${id}

  Delete REP ring configured in the NON-FABRIC deployment.

• POST <cluster-ip>/dna/intent/api/v1/iot/repRings/query/count

  Retrieves the count of REP rings.

• GET <cluster-ip>/dna/intent/api/v1/iot/networkDevices/${networkDeviceId}/mrpRings/count

  Retrieves the count of MRP rings.

• GET <cluster-ip>/dna/intent/api/v1/iot/networkDevices/${networkDeviceId}/mrpRings

  Retrieves the list of MRP rings.

• GET <cluster-ip>/dna/intent/api/v1/iot/networkDevices/${networkDeviceId}/mrpRings/${id}/members

  Retrieves the list of network devices part of MRP ring.

• GET <cluster-ip>/dna/intent/api/v1/iot/networkDevices/${networkDeviceId}/mrpRings/${id}/members/count

  Retrieves the count of MRP ring members.

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

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

LAN Automation Port Channel API Operations

Catalyst Center platform supports these LAN Automation API operations for Port Channels:

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

  Create a New Port Channel between devices.

• GET <cluster-ip>/dna/intent/api/v1/lanAutomation/portChannels.

  Get Port Channels.

• GET <cluster-ip>/dna/intent/api/v1/lanAutomation/portChannels/${id}

  Get Port Channel information by ID.

• DELETE <cluster-ip>/dna/intent/api/v1/lanAutomation/portChannels/${id}

  Delete Port Channel.

• POST <cluster-ip>/dna/intent/api/v1/lanAutomation/portChannels/${id}/addLink

  Add a LAN Automated link to a Port Channel.

• POST <cluster-ip>/dna/intent/api/v1/lanAutomation/portChannels/${id}/removeLink

  Remove a link from Port Channel.

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

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

Sites API Operations

Catalyst Center platform supports these Sites API operations:

• GET <cluster-ip>/dna/data/api/v1/energy/sites/${id}

  Get site energy by ID.

• GET <cluster-ip>/dna/data/api/v1/energy/sites

  Get sites energy.

• GET <cluster-ip>/dna/data/api/v1/energy/sites/count

  Count sites energy.

• POST <cluster-ip>/dna/data/api/v1/energy/sites/query

  Submit request to query sites energy.

• POST <cluster-ip>/dna/data/api/v1/energy/sites/query/count

  Submit request to count sites energy from query.

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

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

Software Image Management (SWIM) API Operations

Catalyst Center platform supports these SWIM API operations:

• GET <cluster-ip>/dna/intent/api/v1/networkDeviceImages

  Get the list of network devices with image details.

• GET <cluster-ip>/dna/intent/api/v1/networkDeviceImages/count

  Count of network devices for the given status filters.

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

  Fetch network device with image details.

• POST <cluster-ip>/dna/intent/api/v1/networkDeviceImages/${id}/activate

  Update images on the network device.

• POST <cluster-ip>/dna/intent/api/v1/networkDeviceImages/${id}/distribute

  Distribute images on the network device.

• POST <cluster-ip>/dna/intent/api/v1/networkDeviceImages/activate/bulk

  Bulk update images on network devices.

• POST <cluster-ip>/dna/intent/api/v1/networkDeviceImages/distribute/bulk

  Bulk distribute images on network devices.

• POST <cluster-ip>/dna/intent/api/v1/networkDeviceImages/${id}/readinessChecks

  Trigger update readiness for network device.

• GET <cluster-ip>/dna/intent/api/v1/networkDeviceImages/validationResults

  Network device image update validation results.

• GET <cluster-ip>/dna/intent/api/v1/networkDeviceImages/validationResults/count

  Count of network device image update validation results.

• GET <cluster-ip>/dna/intent/api/v1/productSeries

  Retrieves the list of network device product series.

• GET <cluster-ip>/dna/intent/api/v1/productSeries/count

  Count of network product series.

• GET <cluster-ip>/dna/intent/api/v1/productSeries/${productSeriesOrdinal}

  Retrieve network device product series.

• GET <cluster-ip>/dna/intent/api/v1/networkDeviceImages/validations

  Create custom network device validation.

• PUT <cluster-ip>/dna/intent/api/v1/networkDeviceImages/validations/${id}

  Update custom network device validation.

• DELETE <cluster-ip>/dna/intent/api/v1/networkDeviceImages/validations/${id}

  Delete custom network device validation.

• GET <cluster-ip>/dna/intent/api/v1/networkDeviceImages/validations

  Get the list of custom network device validations.

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

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

Wireless API Operations

Catalyst Center platform supports these Wireless API operations:

• PUT <cluster-ip>/dna/intent/api/v1/systemSettings/apPnPLocation

  Update AP PnP Location Setting.

• GET <cluster-ip>/dna/intent/api/v1/systemSettings/apPnPLocation

  Get AP PnP Location Setting.

• DELETE <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/flexConnectNativeVlan

  Delete Native Vlan Settings By Site.

• PUT <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/flexConnectNativeVlan

  Update Native Vlan Settings By Site.

• GET <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/flexConnectNativeVlan

  Get Native Vlan Settings By Site.

• DELETE <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/flexConnectAaaOverride

  Delete AAA Override Vlan Settings By Site.

• PUT <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/flexConnectAaaOverride

  Update AAA Override Vlan Settings By Site.

• GET <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/flexConnectAaaOverride

  Get AAA Override Vlan Settings By Site.

• POST <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/eventDrivenRRMConfigurations

  Create Event Driven RRM Configuration Feature Template.

• GET <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/eventDrivenRRMConfigurations/${id}

  Get Event Driven RRM Configuration Feature Template.

• PUT <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/eventDrivenRRMConfigurations/${id}

  Update Event Driven RRM Configuration Feature Template.

• DELETE <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/eventDrivenRRMConfigurations/${id}

  Delete Event Driven RRM Configuration Feature Template.

• POST <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/multicastConfigurations

  Create Multicast Configuration Feature Template.

• GET <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/multicastConfigurations/${id}

  Get Multicast Configuration Feature Template.

• PUT <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/multicastConfigurations/${id}

  Update Multicast Configuration Feature Template.

• DELETE <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/multicastConfigurations/${id}

  Delete Multicast Configuration Feature Template.

• POST <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/dot11axConfigurations

  Create Dot11ax Configuration Feature Template.

• PUT <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/dot11axConfigurations/${id}

  Update Dot11ax Configuration Feature Template.

• GET <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/dot11axConfigurations/${id}

  Get Dot11ax Configuration Feature Template.

• DELETE <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/dot11axConfigurations/${id}

  Delete Dot11ax Configuration Feature Template.

• POST <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/aaaRadiusAttributesConfigurations}

  Create AAA Radius Attributes Configuration Feature Template

• GET <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/aaaRadiusAttributesConfigurations/${id}

  Get AAA Radius Attributes Configuration Feature Template.

• PUT <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/aaaRadiusAttributesConfigurations/${id}

  Update AAA Radius Attributes Configuration Feature Template.

• DELETE <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/aaaRadiusAttributesConfigurations/${id}

  Delete AAA Radius Attributes Configuration Feature Template.

• POST <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/cleanAirConfigurations

  Create CleanAir Configuration Feature Template.

• GET <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/cleanAirConfigurations/${id}

  Get CleanAir Configuration Feature Template.

• DELETE <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/cleanAirConfigurations/${id}

  Delete CleanAir Configuration Feature Template.

• PUT <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/cleanAirConfigurations/${id}

  Update CleanAir Configuration Feature Template.

• POST <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/advancedSSIDConfigurations

  Create Advanced SSID Configuration Feature Template.

• PUT <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/advancedSSIDConfigurations/${id}

  Update Advanced SSID Configuration Feature Template.

• GET <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/advancedSSIDConfigurations/${id}

  Get Advanced SSID Configuration Feature Template.

• DELETE <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/advancedSSIDConfigurations/${id}

  Delete Advanced SSID Configuration Feature Template.

• POST <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/flexConnectConfigurations

  Create Flex Connect Configuration Feature Template.

• GET <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/flexConnectConfigurations/${id}

  Get Flex Connect Configuration Feature Template.

• DELETE <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/flexConnectConfigurations/${id}

  Delete Flex Connect Configuration Feature Template.

• PUT <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/flexConnectConfigurations/${id}

  Update Flex Connect Configuration Feature Template.

• POST <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/rrmFraConfigurations}

  Create RRM FRA Configuration Feature Template.

• GET <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/rrmFraConfigurations/${id}

  Get RRM FRA Configuration Feature Template.

• DELETE <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/rrmFraConfigurations/${id}

  Delete RRM FRA Configuration Feature Template.

• PUT <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/rrmFraConfigurations/${id}

  Update RRM FRA Configuration Feature Template.

• POST <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/rrmGeneralConfigurations

  Create RRM General Configuration Feature Template.

• GET <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/rrmGeneralConfigurations/${id}

  Get RRM General Configuration Feature Template.

• DELETE <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/rrmGeneralConfigurations/${id}

  Delete RRM General Configuration Feature Template.

• PUT <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/rrmGeneralConfigurations/${id}

  Update RRM General Configuration Feature Template.

• POST <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/dot11beStatusConfigurations

  Create Dot11be Status Configuration Feature Template.

• GET <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/dot11beStatusConfigurations/${id}

  Get Dot11be Status Configuration Feature Template.

• DELETE <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/dot11beStatusConfigurations/${id}

  Delete Dot11be Status Configuration Feature Template.

• PUT <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/dot11beStatusConfigurations/${id}

  Update Dot11be Status Configuration Feature Template.

• GET <cluster-ip>/dna/intent/api/v1/featureTemplates/wireless/summary

  Get Feature Template Summary.

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

  Wireless Controller Provision Status.

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

Expand the Connectivity drop-down list and choose Wireless.

Beta API Operations

Licenses API Operation

With this release, Catalyst Center platform supports this API operation:

• GET <cluster-ip>/dna/intent/api/v1/networkDeviceLicenses/summary

  Retrieves summary of network device licenses.

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

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

API Operation Enhancements

SD-Access API operations

The layer2FloodingAddress, layer2FloodingAddressAssignment, isResourceGuardEnabled and isWirelessFloodingEnabled attributes are included as optional parameters in the response of these API operations:

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

  Get anycast gateways.

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

  Get layer 2 virtual networks.

The layer2FloodingAddress, layer2FloodingAddressAssignment, isResourceGuardEnabled and isWirelessFloodingEnabled attributes are included as the optional query parameters in these API operations:

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

  Add anycast gateways.

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

  Update anycast gateways.

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

  Add layer 2 virtual networks.

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

  Update layer 2 virtual networks.

The isVoiceVlanEnabled attribute is included as an optional parameter in the response of the API operation:

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

  Get authentication profiles.

The isVoiceVlanEnabled attribute is included as an optional query parameter in the API operation:

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

  Update authentication profile.

The siteId attribute is included as an optional parameter in the response of the API operation:

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

  Get Transit Networks.

The siteId attribute is included as an optional query parameter in these API operations:

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

  Create Transit Networks.

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

  Update Transit Networks.

When the connected device type is Trunking Device, nativeVlanId is included as an optional parameter in the query and response, and allowedVlanRanges is included as an optional parameter in the response of the Port Assignment API operation:

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

  Get port assignments.

When the connected device type is Trunking Device, nativeVlanId and allowedVlanRanges are included as optional query parameters in these Port Assignment API operations:

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

  Add port assignments.

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

  Update port assignments.

When the connected device type is Trunk, nativeVlanId is included as an optional parameter in the query and response, and allowedVlanRanges attribute is included as an optional parameter in the response of the Port Channel API operation:

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

  Get port channels.

When the connected device type is Trunk, the nativeVlanId and allowedVlanRanges attributes are included as optional query parameters in these Port Channel API operations:

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

  Create port channels.

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

  Update port channels.

Site Design API Operations

The siteHierarchyId attribute is included in the response of these API operations:

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

  Gets an area.

• GET <cluster-ip>/dna/intent/api/v2/buildings/${id}

  Gets a building.

• GET <cluster-ip>/dna/intent/api/v2/floors/${id}

  Gets a floor.

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

  Get sites.

Wireless API Operations

The featureTemplates attribute is included in the query of these API operations:

• POST <cluster-ip>/dna/intent/api/v1/wirelessProfiles

  Create Wireless Profile.

• PUT <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}

  Update Wireless Profile.

• POST <cluster-ip>/dna/intent/api/v1/wirelessControllers/${deviceId}/provision

  Wireless Controller Provision.

The featureTemplates attribute is included in the response of these API operations:

• 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.

The neighbourApName attribute is included in the response and two new filters meshRole and neighbourType are included in the API operation:

• GET <cluster-ip>/dna/intent/api/v1/wirelessControllers/meshApNeighbours

  Get Mesh Ap Neighbours.

The beamState attribute is included as a query parameter in the API operation:

• POST <cluster-ip>/dna/intent/api/v1/wirelessAccessPoints/provision

  AP Provision.

With this release, ssidRadioType, ghz24Policy, ghz6PolicyClientSteering and wlanBandSelectEnable are included in the list of overridable attributes.

The policyProfileName attribute is included as a query parameter in these API operations:

• 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.

• POST <cluster-ip>/dna/intent/api/v1/sites/${siteId}/wirelessSettings/ssids/${id}/update

  Update or Override SSID.

• POST <cluster-ip>/dna/intent/api/v1/wirelessProfiles

  Create Wireless Profile.

• PUT <cluster-ip>/dna/intent/api/v1/wirelessProfiles/${id}

  Update Wireless Profile.

Deprecated API Operations

A Sunset banner indicates that the particular API operation will be removed after the deprecation period has elapsed.

Configuration Archive

With this release, this Configuration Archive API operation is marked as Deprecated:

• GET <cluster-ip>/dna/intent/api/v1/network-device-config

  Get configuration archive details.

SWIM API Operations

With this release, these SWIM API operations are marked as Sunset:

• POST <cluster-ip>/dna/intent/api/v1/image/distribution

  Trigger software image distribution.

• POST <cluster-ip>/dna/intent/api/v1/image/activation/device

  Trigger software image activation.

API Operations Changes That Break Backward Compatibility

None