2025-03-03
New APIs
Beta APIs
With this release, Catalyst Center platform includes the following Campus Automation Beta APIs:
Feature |
Description |
Wired APIs |
- POST dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/configurationModels : Create a configuration model for the intended configs for a wired device.
- PUT /dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2/${feature} : Update configurations for an intended layer 2 feature on a wired device.
- GET /dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/deployed/layer2/${feature} : Get configurations for a deployed layer 2 feature on a wired device.
- GET /dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/deployed/layer2/${feature}/count : Get number of configurations for a deployed layer 2 feature on a wired device.
- POST /dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/deploy : Deploy the intended configuration features on a wired device.
- PUT /dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2 : Update configurations for intended layer 2 features on a wired device.
- GET /dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/supported/layer2 : Get the supported layer 2 features on a wired device.
- GET /dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/serviceDeployments : Get service deployment status.
- POST /dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/configurationModels/${previewActivityId}/config : Generate the device config for the configuration model.
- POST /dna/intent/api/v1/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/configurationModels/${previewActivityId}/deploy : Deploys the configuration model on the network device.
- DELETE /dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2/${feature} : Delete configurations for an intended layer 2 feature on a wired device.
- GET /dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2/${feature} : Get configurations for an intended layer 2 feature on a wired device.
- DELETE /dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/configurationModels/${previewActivityId} : Delete the configuration model.
- POST /dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2/${feature} : Create configurations for an intended layer 2 feature on a wired device.
- GET /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 /dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/configurationModels/${previewActivityId}/config : Gets the device config for the configuration model.
- POST /dna/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2 : Create configurations for intended layer 2 features on a wired device.
- GET /dna/intent/api/v1/wired/networkDevices/${networkDeviceId}/configFeatures/intended/deviceDeployments : Get device deployment status.
- GET /dna/intent/api/v1/intent/api/v1/wired/networkDevices/${id}/configFeatures/intended/layer2 : Get configurations for intended layer 2 features on a wired device.
|
API Enhancements
Feature |
Description |
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.
|
SDA 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. If there is an alternative API, the details are given under the respective deprecated API's Features tab.
Feature |
Description |
Discovery API |
- POST /dna/intent/api/v1/discovery : Delete all discovery.
|
Event Management APIs |
- POST /dna/intent/api/v1/event/subscription : Create Event Subscriptions.
- PUT /dna/intent/api/v1/event/subscription : Update Event Subscriptions.
- GET /dna/intent/api/v1/event/subscription : Get Event Subscriptions.
|
Network Settings APIs |
- POST /dna/intent/api/v1/global-pool : Create Global Pool.
- GET /dna/intent/api/v1/global-pool : Get Global Pool.
- PUT /dna/intent/api/v1/global-pool : Update Global Pool.
- DELETE /dna/intent/api/v1/global-pool/${id} : Delete Global IP Pool.
- POST /dna/intent/api/v1/reserve-ip-subpool/${siteId} : Reserve IP Subpool.
- GET /dna/intent/api/v1/reserve-ip-subpool : Get Reserve IP Subpool.
- PUT /dna/intent/api/v1/reserve-ip-subpool/${siteId} : Update Reserve IP Subpool.
- DELETE /dna/intent/api/v1/reserve-ip-subpool/${id} : Release Reserve IP Subpool.
|
SDA APIs |
Fabric Creation APIs- POST /dna/intent/api/v1/business/sda/fabric : Add Fabric Site.
- GET /dna/intent/api/v1/business/sda/fabric : Get SDA Fabric Info.
- DELETE /dna/intent/api/v1/business/sda/fabric : Delete SDA Fabric.
Fabric Site in SDA Fabric APIs- POST /dna/intent/api/v1/business/sda/fabric-site : Add Site in SDA Fabric.
- GET /dna/intent/api/v1/business/sda/fabric-site : Get Site from SDA Fabric.
- DELETE /dna/intent/api/v1/business/sda/fabric-site : Delete Site from SDA Fabric.
Fabric Zone in SDA fabric APIs- POST /dna/intent/api/v1/business/sda/fabric-zone : Add fabric zone in SDA Fabric.
- GET /dna/intent/api/v1/business/sda/fabric-zone : Get fabric zone from SDA Fabric.
- DELETE /dna/intent/api/v1/business/sda/fabric-zone : Delete fabric zone from SDA Fabric.
Control Plane Device APIs- POST /dna/intent/api/v1/business/sda/control-plane-device : Add control plane device.
- GET /dna/intent/api/v1/business/sda/control-plane-device : Get control plane device.
- DELETE /dna/intent/api/v1/business/sda/control-plane-device : Delete control plane device in SDA Fabric.
Edge-Device Role Assignment APIs- POST /dna/intent/api/v1/business/sda/edge-device : Add edge device.
- GET /dna/intent/api/v1/business/sda/edge-device : Get edge device.
- DELETE /dna/intent/api/v1/business/sda/edge-device : Delete edge device.
Border Device Role Assignment APIs- POST /dna/intent/api/v1/business/sda/border-device : Adds border device in SDA Fabric.
- GET /dna/intent/api/v1/business/sda/border-device : Gets border device detail from SDA Fabric.
- DELETE /dna/intent/api/v1/business/sda/border-device : Deletes border device from SDA Fabric.
Default Authentication Template (Profile) APIs- PUT /dna/intent/api/v1/business/sda/authentication-profile : Update default authentication profile.
- POST /dna/intent/api/v1/business/sda/authentication-profile : Add default authentication profile.
- GET /dna/intent/api/v1/business/sda/authentication-profile : Get default authentication profile.
- DELETE /dna/intent/api/v1/business/sda/authentication-profile : Delete default authentication profile.
Virtual Network Creation APIs- POST /dna/intent/api/v1/business/sda/virtual-network : Add VN in SDA Fabric.
- GET /dna/intent/api/v1/business/sda/virtual-network : Get VN from SDA Fabric.
- DELETE /dna/intent/api/v1/business/sda/virtual-network : Delete VN from SDA Fabric.
- GET /dna/intent/api/v1/business/sda/virtual-network/summary : Get Virtual Network Summary.
SDA Segment APIs- POST /dna/intent/api/v1/business/sda/virtualnetwork/ippool : Add IP Pool in SDA Virtual Network.
- GET /dna/intent/api/v1/business/sda/virtualnetwork/ippool : Get IP Pool in SDA Virtual Network.
- DELETE /dna/intent/api/v1/business/sda/virtualnetwork/ippool : Delete IP Pool in SDA Virtual Network.
Port Assignment for User Devices APIs- POST /dna/intent/api/v1/business/sda/hostonboarding/user-device : Add Port assignment for user device.
- GET /dna/intent/api/v1/business/sda/hostonboarding/user-device : Get Port assignment for user device.
- DELETE /dna/intent/api/v1/business/sda/hostonboarding/user-device : Delete Port assignment for user device.
Port Assignment to Access Points APIs- POST /dna/intent/api/v1/business/sda/hostonboarding/access-point : Add Port assignment for access point.
- GET /dna/intent/api/v1/business/sda/hostonboarding/access-point : Get Port assignment for access point.
- DELETE /dna/intent/api/v1/business/sda/hostonboarding/access-point : Delete Port assignment for access point.
SDA Multicast APIs- POST /dna/intent/api/v1/business/sda/multicast : Add multicast.
- GET /dna/intent/api/v1/business/sda/multicast : Get multicast.
- DELETE /dna/intent/api/v1/business/sda/multicast : Delete multicast.
Wired Device Provisioning APIs- POST /dna/intent/api/v1/business/sda/provision-device : Provision Wired Device.
- GET /dna/intent/api/v1/business/sda/provision-device : Get Provision Wired Device.
- DELETE /dna/intent/api/v1/business/sda/provision-device : Delete Provision Wired Device.
- PUT /dna/intent/api/v1/business/sda/provision-device : Re-Provision Wired Device.
Virtual Network APIs- POST /dna/intent/api/v1/virtual-network : Add virtual network with scalable groups.
- GET /dna/intent/api/v1/virtual-network : Get virtual network with scalable groups.
- DELETE /dna/intent/api/v1/virtual-network : Delete virtual network with scalable groups.
- PUT /dna/intent/api/v1/virtual-network : Update virtual network with scalable groups.
Transit and Peer Networks APIs- POST /dna/intent/api/v1/business/sda/transit-peer-network : Add Transit Peer Network.
- GET /dna/intent/api/v1/business/sda/transit-peer-network : Get Transit Peer Network.
- DELETE /dna/intent/api/v1/business/sda/transit-peer-network : Delete Transit Peer Network.
Retrieve Device Information from SDA fabric API- GET /dna/intent/api/v1/business/sda/device : Get device info from SDA Fabric.
Get SDA Device Role for a given device API- GET /dna/intent/api/v1/business/sda/device/role : Get device role in SDA Fabric.
Get Number of Fabric - Cyclops API- GET /dna/intent/api/v1/business/sda/fabric/count : Get SDA Fabric Count.
|
Security Advisories APIs |
- GET /dna/intent/api/v1/security-advisory/advisory/aggregate : Get Advisories Summary.
- GET /dna/intent/api/v1/security-advisory/device/${deviceId} : Get Advisory Device Detail.
- GET /dna/intent/api/v1/security-advisory/advisory : Get Advisories List.
- GET /dna/intent/api/v1/security-advisory/device/${deviceId}/advisory : Get Advisories Per Device.
- GET /dna/intent/api/v1/security-advisory/advisory/${advisoryId}/device : Get Devices Per Advisory.
|
SWIM APIs |
- GET /dna/intent/api/v1/image/importation : Get software image details.
- GET /dna/intent/api/v1/image/importation/device-family-identifiers : Get Device Family Identifiers.
- POST /dna/intent/api/v1/image/importation/golden : Tag as Golden Image.
- GET /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 /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
Feature |
Description |
None |
- |
For more information, see the Release Notes for Cisco Catalyst Center, Release 2.3.7.x.
2024-08-02
New APIs
API Enhancements
Feature |
Description |
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
Feature |
Description |
Fabric Wireless APIs |
- DELETE /dna/intent/api/v1/business/sda/wireless-controller : Remove WLC from Fabric Domain.
- PUT /dna/intent/api/v1/business/sda/hostonboarding/ssid-ippool : Update SSID to IP Pool Mapping.
- POST /dna/intent/api/v1/business/sda/hostonboarding/ssid-ippool : Add SSID to IP Pool Mapping.
- GET /dna/intent/api/v1/business/sda/hostonboarding/ssid-ippool : Get SSID to IP Pool Mapping.
- POST /dna/intent/api/v1/business/sda/wireless-controller : Add WLC to Fabric Domain.
|
Network Settings APIs |
- POST /dna/intent/api/v1/network/${siteId} : Create Network.
- POST /dna/intent/api/v2/network/${siteId} : Create Network V2.
- PUT /dna/intent/api/v1/network/${siteId} : Update Network.
- PUT /dna/intent/api/v2/network/${siteId} : Update Network V2.
- GET /dna/intent/api/v1/network : Get Network.
- GET /dna/intent/api/v2/network : Get Network V2.
- POST /dna/intent/api/v1/credential-to-site/${siteId} : Assign Device Credential To Site.
- POST /dna/intent/api/v2/credential-to-site/${siteId} : Assign Device Credential To Site V2.
|
Site Design APIs |
- GET /dna/intent/api/v1/site-member/${id}/member : Get devices that are assigned to a site.
- POST /dna/intent/api/v1/assign-device-to-site/${siteId}/device : Assign Devices To Site.
- POST /dna/intent/api/v1/site : Create Site.
- DELETE /dna/intent/api/v1/site/${siteId} : Delete Site.
- PUT /dna/intent/api/v1/site/${siteId} : Update Site.
- GET /dna/intent/api/v1/site : Get Site.
- GET /dna/intent/api/v2/site : Get Site V2.
- GET /dna/intent/api/v1/site/count : Get Site Count.
- GET /dna/intent/api/v1/membership/${siteId} : Get Membership.
- GET /dna/intent/api/v2/site/count : Get Site Count V2.
|
Task APIs |
- GET /dna/intent/api/v1/task : Get tasks.
- GET /dna/intent/api/v1/task/${taskId} : Get task by ID.
- GET /dna/intent/api/v1/task/operation/${operationId}/${offset}/${limit} : Get task by OperationId.
- GET /dna/intent/api/v1/task/${taskId}/tree : Get task tree.
- GET /dna/intent/api/v1/task/count : Get task count.
|
Wireless APIs |
- POST /dna/intent/api/v1/wireless/profile : Create Wireless Profile.
- GET /dna/intent/api/v1/wireless/profile : Get Wireless Profile.
- DELETE /dna/intent/api/v1/wireless-profile/${wirelessProfileName} : Delete Wireless Profile.
- UT /dna/intent/api/v1/wireless/profile : Update Wireless Profile.
- GET /dna/intent/api/v1/wireless/rf-profile : Retrieve RF profiles.
- DELETE /dna/intent/api/v1/wireless/rf-profile/${rfProfileName} : Delete RF profiles.
- POST /dna/intent/api/v1/wireless/rf-profile : Create or Update RF profile.
- GET /dna/intent/api/v1/wireless/dynamic-interface : Get dynamic interface.
- PUT /dna/intent/api/v1/wireless/dynamic-interface : Create Update Dynamic interface.
- DELETE /dna/intent/api/v1/wireless/dynamic-interface : Delete dynamic interface.
- POST /dna/intent/api/v1/enterprise-ssid : Create Enterprise SSID.
- PUT /dna/intent/api/v1/enterprise-ssid : Update Enterprise SSID.
- Delete /dna/intent/api/v1/enterprise-ssid/${ssidName} : Delete Enterprise SSID.
- GET /dna/intent/api/v1/enterprise-ssid : Get Enterprise SSID.
- DELETE /dna/intent/api/v1/business/ssid/${ssidName}/${managedAPLocations} : Delete SSID and provision it to devices.
- POST /dna/intent/api/v1/business/ssid : Create and Provision SSID.
- GET /dna/intent/api/v1/task/count : AP Provision.
- POST /dna/intent/api/v1/wireless/ap-provision : Provision update.
- POST /dna/intent/api/v1/wireless/provision : Provision.
|
API Changes That Break Backward Compatibility
Feature |
Description |
None |
- |
For more information, see the Release Notes for Cisco Catalyst Center, Release 2.3.7.x.
2024-04-08
New APIs
Feature |
Description |
LAN Automation APIs |
- POST /dna/intent/api/v2/lan-automation : LAN Automation Start V2.
- PUT /dna/intent/api/v2/lan-automation/${id} : LAN Automation Stop and Update Devices V2.
|
Reports APIs |
- GET /dna/data/api/v1/flexible-report/schedule/${reportId} : Get Flexible report schedule by report ID.
- GET /dna/data/api/v1/flexible-report/report/${reportId}/executions : Get Execution ID by report ID.
- POST /dna/data/api/v1/flexible-report/report/${reportId}/execute : Executing the Flexible report.
- PUT /dna/data/api/v1/flexible-report/schedule/${reportId} : Update schedule of Flexible report.
- GET /dna/data/api/v1/flexible-report/schedules : Get all Flexible report schedules.
- GET /dna/data/api/v1/flexible-report/report/content/${reportId}/${executionId} : Download Flexible report.
|
SDA APIs |
Extranet Policy APIs- GET /dna/intent/api/v1/sda/extranetPolicies : Get extranet policies.
- PUT /dna/intent/api/v1/sda/extranetPolicies : Update extranet policy.
- POST /dna/intent/api/v1/sda/extranetPolicies : Add extranet policy.
- GET /dna/intent/api/v1/sda/extranetPolicies/count : Get extranet policy count.
- DELETE /dna/intent/api/v1/sda/extranetPolicies/${id} : Delete extranet policy by ID.
Port Assignment APIs- POST /dna/intent/api/v1/sda/portAssignments : Add port assignments.
- GET /dna/intent/api/v1/sda/portAssignments : Get port assignments.
- PUT /dna/intent/api/v1/sda/portAssignments : Update port assignments.
- GET /dna/intent/api/v1/sda/portAssignments/count : Get port assignment count.
- DELETE /dna/intent/api/v1/sda/portAssignments/${id} : Delete port assignment by ID.
- DELETE /dna/intent/api/v1/sda/portAssignments : Delete port assignments.
Fabric Site APIs- POST /dna/intent/api/v1/sda/fabricSites : Add fabric site.
- PUT /dna/intent/api/v1/sda/fabricSites : Update fabric site.
- DELETE /dna/intent/api/v1/sda/fabricSites/${id} : Delete fabric site by ID.
- GET /dna/intent/api/v1/sda/fabricSites : Get fabric sites.
- GET /dna/intent/api/v1/sda/fabricSites/count : Get fabric site count.
Fabric Zone APIs- POST /dna/intent/api/v1/sda/fabricZones : Add fabric zone.
- PUT /dna/intent/api/v1/sda/fabricZones : Update fabric zone.
- DELETE /dna/intent/api/v1/sda/fabricZones/${id} : Delete fabric zone by ID.
- GET /dna/intent/api/v1/sda/fabricZones : Get fabric zones.
- GET /dna/intent/api/v1/sda/fabricZones/count : Get fabric zone count.
Authentication Profile APIs- PUT /dna/intent/api/v1/sda/authenticationProfiles : Update authentication profile.
- GET /dna/intent/api/v1/sda/authenticationProfiles : Get authentication profiles.
Bulk Device Provisioning APIs- GET /dna/intent/api/v1/sda/provisionDevices : Get provisioned devices.
- POST /dna/intent/api/v1/sda/provisionDevices : Provision devices.
- GET /dna/intent/api/v1/sda/provisionDevices/count : Get provisioned devices count.
- DELETE /dna/intent/api/v1/sda/provisionDevices : Delete provisioned devices.
- PUT /dna/intent/api/v1/sda/provisionDevices : Reprovision devices.
- DELETE /dna/intent/api/v1/ sda/provisionDevices/${id} : Delete provisioned device by ID.
Fabric Device APIs- POST /dna/intent/api/v1/sda/fabricDevices : Add fabric devices.
- GET /dna/intent/api/v1/sda/fabricDevices : Get fabric devices.
- GET /dna/intent/api/v1/sda/fabricDevices/count : Get fabric devices count.
- DELETE /dna/intent/api/v1/sda/fabricDevices : Delete fabric devices.
- DELETE /dna/intent/api/v1/sda/fabricDevices/${id} : Delete a fabric device by ID.
- PUT /dna/intent/api/v1/sda/fabricDevices : Update fabric devices.
Fabric Device Layer 2 Handoff APIs- POST /dna/intent/api/v1/sda/fabricDevices/ layer2Handoffs : Add fabric devices Layer 2 handoffs.
- GET /dna/intent/api/v1/sda/fabricDevices/ layer2Handoffs : Get fabric devices Layer 2 handoffs.
- GET / dna/intent/api/v1/sda/fabricDevices/layer2Handoffs/count : Get fabric devices Layer 2 handoffs count.
- DELETE /dna/intent/api/v1/sda/fabricDevices/ layer2Handoffs : Delete fabric devices Layer 2 handoffs.
- DELETE /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 /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits : Add fabric devices Layer 3 handoffs with IP transit.
- GET /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits : Get fabric devices Layer 3 handoffs with IP transit.
- GET /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits/count : Get fabric devices Layer 3 handoffs with IP transit count.
- DELETE /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits : Delete fabric devices Layer 3 handoffs with IP transit.
- DELETE /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/ipTransits/${id} : Delete fabric device Layer 3 handoff with IP transit by ID.
- PUT /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 /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/sdaTransits : Add fabric devices Layer 3 handoffs with SDA transit.
- GET /dna/intent/api/v1/sda/fabricDevices/ layer3Handoffs/sdaTransits : Get fabric devices Layer 3 handoffs with SDA transit.
- GET /dna/intent/api/v1/sda/fabricDevices/ layer3Handoffs/sdaTransits/count : Get fabric devices Layer 3 handoffs with SDA transit count.
- DELETE /dna/intent/api/v1/sda/fabricDevices/ layer3Handoffs/sdaTransits : Delete fabric devices Layer 3 handoffs with SDA transit.
- PUT /dna/intent/api/v1/sda/fabricDevices/layer3Handoffs/sdaTransits : Update fabric devices Layer 3 handoffs with SDA transit.
Anycast Gateways APIs- DELETE /dna/intent/api/v1/sda/anycastGateways/${id} : Delete anycast gateway by ID.
- PUT /dna/intent/api/v1/sda/anycastGateways : Update anycast gateways.
- GET /dna/intent/api/v1/sda/anycastGateways : Get anycast gateways.
- POST /dna/intent/api/v1/sda/anycastGateways : Add anycast gateways.
- GET /dna/intent/api/v1/sda/anycastGateways/count : Get anycast gateway count.
|
API Enhancements
Feature |
Description |
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
Feature |
Description |
None |
- |
API Changes That Break Backward Compatibility
Feature |
Description |
None |
- |
For more information, see the Release Notes for Cisco Catalyst Center, Release 2.3.7.x.
2023-12-20
New APIs
Feature |
Description |
User and Roles APIs |
- POST /dna/system/api/v1/users/external-servers/aaa-attribute : Add and update AAA Attribute API.
- GET /dna/system/api/v1/users/external-servers/aaa-attribute : Get AAA Attribute API.
- DELETE /dna/system/api/v1/users/external-servers/aaa-attribute : Delete AAA Attribute API.
- POST /dna/system/api/v1/users/external-authentication : Manage External Authentication Setting API.
- GET /dna/system/api/v1/users/external-authentication : Get External Authentication Setting API.
|
ITSM Integration API |
GET /dna/intent/api/v1/integration-settings/status : Fetches the ITSM integration status. |
API Enhancements
Feature |
Description |
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
Feature |
Description |
Devices API |
The Get Device Config for all devices API is deprecated. |
API Changes That Break Backward Compatibility
Feature |
Description |
None |
- |
For more information, see the Release Notes for Cisco Catalyst Center, Release 2.3.7.x.
2023-08-11
Compliance APIs:
Support is extended for the following:
- Get config task details.
- Commit device configuration.
Configuration Archive API:
Support is extended for the following:
- Get configuration archive details.
Devices APIs:
Support is extended for the following:
- Get Device Interface Stats Info.
LAN Automation APIs:
Support is extended for the following:
- LAN Automation Stop and Update Devices.
- LAN Automation Device Update.
Sites APIs:
Support is extended for the following:
- Get Site V2.
- Get Site Count V2.
- Get devices that are assigned to a site.
System Settings APIs:
Support is extended for the following:
- Delete Authentication and Policy Server Access Configuration.
- Add Authentication and Policy Server Access Configuration.
- Cisco ISE Server Integration Status.
- Accept Cisco ISE Server Certificate for Cisco ISE Server Integration.
- Edit Authentication and Policy Server Access Configuration.
User and Roles APIs:
Support is extended for the following:
- Update role API.
- Delete user API.
- Add role API.
- Delete role API.
With this release, the following APIs are deprecated:
- Get Sync Result for Virtual Account.
- Sync Virtual Account Devices.
With this release, email authentication support is extended for primary and secondary SMTP servers while configuring an email destination to receive notifications.
For more information, see the Release Notes for Cisco DNA Center, Release 2.3.7.0 and 2.3.7.3.
2022-12-21
Devices APIs:
Support is extended for the following:
- Rogue additional detail count.
- Rogue additional details.
End of Life (EoX) APIs:
Support is extended for the following:
- Get EoX status for all devices.
- Get EoX details per device.
- Get EoX summary.
Policy APIs:
Support is extended for the following:
- Apply ANC policy.
- Get ANC policies.
- Revoke ANC policy.
- Update a registered endpoint.
- Get the count of endpoints and task details.
- Get AI endpoint analytics attribute dictionaries.
- Get endpoint details.
- Delete an endpoint
- Query the endpoints.
- Register an endpoint.
- Process CMDB endpoints.
Discovery API:
Support is extended for the following:
- Get, Create, Update, and Delete Global Credential V2.
LAN Automation API:
Support is extended for the following:
- LAN automation logs for individual devices.
- LAN automation active sessions.
System Settings API:
Support is extended for the following:
- Get authentication and policy servers.
2022-09-21
Cisco Software-Defined Access APIs:
Support is extended for the following:
- Get Cisco SD-Access transit network detail.
- Create and delete Cisco SD-Access transit network.
Cisco Wireless APIs:
Support is extended for new options in the Wireless API for access point configuration and reboot access point:
- Get access point configuration task result.
- Get access point configuration.
- Configure access points.
Support is extended for new options in the Wireless API for reboot access point:
- Get a reboot access point.
- Add the threat MAC address to the allowed list.
Cisco DNA Center System Platform API:
Support is extended for new options in the Platform API for reboot access point:
- Get the Cisco DNA Center release summary.
- Get the Cisco DNA Center nodes configuration summary.
- Get the Cisco DNA Center packages summary.
Cisco DNA Center System User and Roles API:
Support is extended for new options in the User and Roles API for reboot access point:
- Add a new user for Cisco DNA Center system.
- Get all users and roles for the Cisco DNA Center system.
- Get permissions for a role from Cisco DNA Center system.
- Get external users authentication servers.
- Update a user for Cisco DNA Center system.
Issues API:
Support is extended for a new option in the Issues API for reboot access point:
- Execute suggested actions command.
Event Management API:
Support is extended for new options in the Event Management API for reboot access point:
- Get webhook destination, syslog destination, Email destination, and SNMP destination.
Network Settings API:
Support is extended for new options in the Network Settings API for reboot access point:
- Get device credential and service provider details.
- Get SNMP, NTP, Network AAA, Client and Endpoint AAA, and/or DNS center server settings.
- Create device credentials.
- Assign device credential to site.
- Create network settings for DHCP, Syslog, SNMP, NTP, Network AAA, Client and Endpoint AAA, and/or DNS center server settings.
- Create, update, and delete service provider profile (QoS).
- Update network settings for DHCP, Syslog, SNMP, NTP, Network AAA, Client and Endpoint AAA, and/or DNS center server settings.
- Update and delete device credentials.
2022-04-26
Cisco SD-Access API: Support is extended for the following:
- Get a virtual network summary.
- Get a transit peer network information from Cisco SD-Access.
- Add a transit peer network in Cisco SD-Access.
- Delete a transit peer network from Cisco SD-Access.
Note: All the Cisco SD-Access platform APIs are Beta.
With this release, the following Cisco SD-Access APIs are deprecated from Cisco DNA Center platform:
- Get Cisco SD-Access fabric information.
- Get Cisco SD-Access fabric count.
- Add a Cisco SD-Access fabric.
- Delete a Cisco SD-Access fabric.
Devices API: Support is extended for the following:
- Add or update voice VLAN to perform devices operations.
- Get all the defined threat types.
- Get all the allowed MAC addresses in the system.
- Remove the threat MAC address from the allowed list.
- Get all the defined threat levels.
- Add the threat MAC address to the allowed list.
- Get the count of allowed MAC addresses in the system.
Cisco DNA Center System API: Support is extended for the following:
- Authorize one or more devices. Cisco DNA Center platform allows you to authorize a device only if the authorization is configured in device settings.
2021-08-04
Application Policies:
Support is extended for the following:
- Application Policy Queuing Profile APIs:
- Get all the existing application policy queuing profiles.
- Get all the existing application policy queuing profiles by name.
- Get the number of all existing application policy queuing profiles.
- Create, update, and delete custom application queuing profiles.
- Quality of Service (QoS) Device Interface Information APIs
- Get all the existing QoS device interface information.
- Get all the existing QoS device interface information by network device ID.
- Get the number of all existing QoS device interface information groups by network device ID.
- Create, update, and delete QoS device interface information associated with network device ID.
- Application Policy APIs
- Get the default application policy.
- Get all existing application policies.
- Create, update, and delete application policies.
- AI Endpoint Analytics APIs to manage profiling rules for the endpoint.
Application:
This Cisco DNA Center platform release supports a new Application API that allows you to get a list of issues, devices, and endpoints for a combination of a specific application with a site or device.
Configuration Templates:
Support is extended for Get project(s) and Get template(s) details with more input filter parameters.
Device Onboarding (PnP):
In the PnP workflow, the Cisco DNA Center platform now allows you to bypass the provisioning workflow and provision multiple access point devices by using an API.
Site Design:
The Cisco DNA Center platform now allows you to support associate and disassociate a site to a network profile.
Task:
The Cisco DNA Center platform now allows you to retrieve the execution details of a business API.
SWIM:
Support is extended for the following:
- Device family identifiers for all device families that can be used for tagging an image as a golden image.
- Tag a golden image. Set siteId as -1 for a global site.
- Remove a golden tag. Set siteId as -1 for a global site.
- Get the golden tag status of an image. Set siteId as -1 for a global site.
2021-04-23
Cisco Software-Defined Access APIs:
Support is extended for the following:
- Get virtual network with scalable groups.
- Update virtual network with scalable groups.
- Add virtual network with scalable groups at the global level.
- Get multicast details from the SD-Access fabric.
- Delete virtual network with scalable groups.
SD-Access APIs (Beta):
- Provision wired and wireless device.
- Add multicast in SD-Access fabric.
- Add, update, and get the SSID-to-IP pool mapping.
- Add and remove wireless controllers in the fabric domain.
Reports APIs:
Support is extended for the following:
- Retrieve a list of summaries of all views for a given view group.
- Retrieve the complete information of the view that is required to configure a report.
- Retrieve the list of scheduled report configurations.
- Retrieve a list of summaries of all view groups.
- Retrieve the details of all executions for a given report.
- Retrieve the scheduled report configuration using report ID.
- Retrieve the report content.
- Create and schedule a report configuration.
- Delete a scheduled report configuration and report executions.
License Manager APIs:
Support is extended for the following:
- Retrieve a list of smart and virtual accounts.
- Retrieve license information details.
- Retrieve license details by device ID.
IPAM APIs:
- Retrieve a list of smart accounts.
- Post a list of virtual accounts and licenses.
- Delete license information details.
PnP APIs:
This Cisco DNA Center platform release supports a new option in the PnP claim API that indicates if user authorization is needed for the claim to complete.
SWIM Automation APIs:
- Create and update a SWIM upgrade request.
- Create and update a SWIM upgrade request - ServiceNow Connector
- Update ITSM details
New Supervisor and Line Card API Detail:
This release supports updated APIs that provide additional information about Cisco supervisor and line cards.
New Device Link Mismatch API Support:
This release supports updated APIs that provide additional information about device link mismatches.
New Display PoE Interface API:
This release supports updated APIs that display device interface PoE data.
Audit Log API Updates:
The following updates have been made in the Audit Log API for this release.
- Different descriptions for Get Audit Log Records and Get Audit Log parent records. They are no longer the same.
- New descriptions and default values for attributes.
- For the map data types, only details and additional details are the map type attributes. Others are strings and the schema has been updated.
- The feature section of Get Audit Log Summary has been updated to state that it returns a summary and also briefly mention the purging mechanism set up for audit logs (1 million records or 1 year, whichever is earlier).
- The Sort, Order, Limit, and Offset parameters have been removed from the Summary API.
2020-08-31
Clients APIs:
Support is extended for the following:
- New client proximity API to support client tracing.
- Updated the wireless API to support client tracing.
Application API:
The Cisco DNA Center platform now returns a list of applications for a specific site, a device, or a client device MAC address.
Assurance APIs:
Support is extended for the following:
- Return overall health information for all sites.
- Return a list of global issues, issues for a specific device, or issues for a specific client device's MAC address.
- Access Assurance device objects for generating reports, creating dashboards, or creating additional value-added services.
Assurance Sensor APIs:
Support is extended for the following:
- Create a sensor test template.
- Delete an existing sensor test.
- Duplicate an existing sensor test template.
- Return a list of sensor devices.
- Deploy, schedule, or edit a sensor test.
- Run a sensor test.
Configuration Archive API:
The Cisco DNA Center platform now supports the export of device configurations to an encrypted zip file.
Device Replacement APIs:
Support is extended for the following:
- Unmark the device for replacement.
- Mark the device for replacement.
- Trigger an RMA workflow that replaces the faulty device with a replacement device with the same configuration and images.
- Retrieve the replacement device count.
- Retrieve the replacement list of devices with details and filter the results based on Faulty Device Name, Faulty Device Platform, and Replacement.
Event Retry APIs:
This release supports new retry (resend and reprocess) APIs for an ITSM (ServiceNow) event.
IP Pool APIs:
The Cisco DNA Center platform supports new bulk functionality for IP and global pools.
NFV Profile APIs:
Support is extended for the following:
- Create a network profile for different Network Functions Visualization (NFV) topologies.
- Update an existing NFV profile. To update the NFV profile, you must provide either the site profile ID as a mandatory path parameter or the site profile name as a query parameter.
- Retrieve the NFV network profile details. The ID of the profile to be retrieved is provided as the path parameter. If the ID is not provided, you can provide the site profile name to retrieve the details.
- Delete the NFV network profile. You must provide either the ID or the site profile name.
Rogue Management Threat APIs:
Support is extended for the following:
- The threat summary for the rogues and aWIPS.
- The detail counts for the rogue and aWIPS threats.
- The details for the rogue and aWIPS threats.
SD-Access APIs:
Support is extended for the following:
- Retrieve the number of fabrics.
- Retrieve the SD-Access role of a device.
2020-01-17
Cisco Software-Defined Access APIs (Beta):
Support is extended for the following:
- Fabric creation.
- Fabric site in the SD-Access fabric.
- Control plane device APIs.
- Edge device lifecycle management in the SD-Access fabric.
- Border device business APIs.
- Default Authentication Template (Profile) selection for host onboarding in the SD-Access fabric.
- Virtual network creation in the SD-Access fabric.
- Add IP pools to virtual networks (SD-Access segment life management).
- Port assignment for user devices.
- Port assignment to APs.
Network Settings API:
Support is extended for the following:
- Create, update, and retrieve a network.
- Create and update device credentials.
- Create and update a service provider profile.
- Create, update, and retrieve a global IP address pool.
- Retrieve device details by IP address.