What's New for the API in Prime Infrastructure 3.10

• New API Resources!
  • The Telemetry Statistic generates Telemetry Statistic Report for Cisco Catalyst 9800 devices.
  • The Devices With Groups provides device information along with the list of groups the device is a member of.
• We've added 2.5 Gb/s, 5 Gb/s, 25 Gb/s, and 40 Gb/s port speeds support to Client Counts (ClientCounts), Client Details (ClientDetails), Client Sessions (ClientSessions), Client Traffic Information (ClientTraffics), Historical Client Counts (HistoricalClientCounts), and Historical Client Traffic Information (HistoricalClientTraffics) API resources.
• We've supported 6 GHz as 802.11ax wireless protocol band in Clients (Clients), Client Counts (ClientCounts), Client Details (ClientDetails), Client Sessions (ClientSessions), Client Traffic Information (ClientTraffics), Historical Client Counts (HistoricalClientCounts), and Historical Client Traffic Information (HistoricalClientTraffics) API resources.

What's New for the API in Prime Infrastructure 3.9

• We've removed Notifications API. NBI Server-Sent Events resources should be used instead.

What's New for the API in Prime Infrastructure 3.8

• We've added 802.11ax and XOR radio support to Radio Summary (Radios) and Lightweight AP Radio Details (RadioDetails).
  Note that radios will be reclassified:
  • 802.11b/g/n radios that support 802.11ax are now show as 802.11b/g/n/ax
  • 802.11a/n/ac radios that support 802.11ax are now show as 802.11a/n/ac/ax
  • 802.11ac are show either as 802.11a/n/ac or 802.11a/n/ac/ax
  • Radios that used to show as Unknown may show as XOR (Monitor Mode), XOR (2.4GHz), XOR (5GHz), 802.11a/b/g/n/ac, 802.11a/b/g/n/ac/ax, 802.11a/b/g/n, UWB, BLE, or Unknown
• We've supported dynamic enums in documentation and now you can see all available values. For example, look at alarms documentation.

What's New for the API in Prime Infrastructure 3.7

• We've deprecated Notifications API. NBI Server-Sent Events resources should be used instead.
• We've added ability to configure Prime Infrastructure to send job notifications mail for NBI API jobs. See Administrator Guide for details.
  Supported job types:
  • CliTemplateDeployIOSDevices
  • NBI_CreateApGroup
  • NBI_CreateInterface
  • NBI_CreateInterfaceGroup
  • NBI_DeleteApGroup
  • NBI_DeleteDevices
  • NBI_DeleteInterface
  • NBI_DeleteInterfaceGroup
  • NBI_DeleteWlanProfile
  • NBI_DeployMacFilter
  • NBI_DeployWlanTemplate
  • NBI_ModifyApGroup
  • NBI_ModifyInterface
  • NBI_ModifyInterfaceGroup
  • NBI_ModifyUnifiedAp
• New API Resources!
  • The Managed Servers Operations provides resources to get and manipulate servers managed by Operations Center.
  • The Site Map Service provides resources to manage site maps.
  • The Guest User Management Service was extended with resources to schedule and reschedule guest users.
  • The Wireless Access Points Stream provides notifications for access point events.
  • The Clients Stream and Client Sessions Stream provide notifications for client events.
  • The Devices Stream and Device Modules Stream provide notifications for events related to devices and their modules.

What's New for the API in Prime Infrastructure 3.6

• We've supported Single Sign-On Authentication. When the appliance uses Single Sign-On Authentication (SSO) for authentication the REST API requests can be consumed using basic authentication with SSO user credentials.
• Starting from API v4 the Client Details (ClientDetails) API resource reports all detected IPv6 addresses for dual-stack clients. The IPv4 address is returned in the ipAddress attribute; IPv6 addresses are returned in the clientAddresses attribute.
• We've added 10 Gb/s port speed support to Client Counts (ClientCounts), Client Details (ClientDetails), Client Sessions (ClientSessions), Client Traffic Information (ClientTraffics), Historical Client Counts (HistoricalClientCounts), and Historical Client Traffic Information (HistoricalClientTraffics) API resources.
• Starting from API v4 the Wireless Access Point Details (AccessPointDetails) API resource reports last association and disassociation time for unified access points.
• New API Resources!
  • The Meraki Access Points and Meraki Devices provide basic information about Meraki devices and access points.
  • The Rogue AP Detection History provides detailed historical Rogue AP detection data.

What's New for the API in Prime Infrastructure 3.5

• We've introduced the NBI Server-Sent Events feature. Also, a few SSE resources were provided.
• DevNet integration was removed from NBI. Now NBI documentation doesn't contain links to the DevNet forum.
• New API Resources!
  • Rx Neighbors API (GET op/apService/rxNeighbors) returns Rx Neighbors of an access point.
  • We introduced rate limiting for operational resources. Rate limiting is applied only to particular resources and so far the only resource that supports it is Rx Neighbors API (GET op/apService/rxNeighbors). See Rate Limiting for details.
  • And many more!

What's New for the API in Prime Infrastructure 3.4

• We've introduced a new API version, version 4. It brings with it some changes to particular API resources and to the behavior of the API as a whole.
  • Since version 4, the Prime Infrastructure API returns an error with status code 400 for invalid parameter values for operational requests.
  • Since version 4, the Prime Infrastructure API returns a 400 Bad Request when an empty content is passed to a resource which requires a request payload.
  • Until version 4, the API used "false" as default value for Boolean query parameters of operational requests. Starting from version 4, there is no default value for Boolean query parameters; you must specify Boolean parameters when the parameter is marked as required.
  • Since version 4, the Prime Infrastructure API returns the virtual domain which was active to the request. Please, look at response formats for more details.
• Some API resources have been changed in v4
  • The Third Party Access Point Summary (GET data/ThirdpartyAccessPoints) resource does not contain the bootVersion attribute since the boot version is not collected for Thirdparty APs.
• New API Resources!
  • The Rate Limits Management Service provides resources to get and update current rate limits.
  • The Maintenance Mode API offers resources to enable and disable maintenance mode for devices and access points.
  • The Rogue AP Classification API offers resources to set a classification type and a state for rogue access points.
  • The AP Onboarding Profile Management Service offers resources to manage AP Onboarding Profiles.
  • And many more!

What's New for the API in Prime Infrastructure 3.3

• Aggregation framework in 3.3 works for all API resources version: v1, v2, v3.
• New API Resources!
  • The Alarms Management Service provides operations for marking alarms as acknowledged/unacknowledged, annotating, clearing alarms and clearing all alarms with provided event type.

What's New for the API in Prime Infrastructure 3.2

• We've introduced a new API version, version 3. It brings with it some changes to particular API resources and to the behavior of the API as a whole. For more about our approach to versioning, how we present versions, and what to expect in future API versions, please consult our API versioning page.
  • Since version 3, the query parameter .strict has a default value of 'true'. This means the query parameters you send to the v3 (or later) API will be validated to ensure that they refer to valid query parameters. We believe this will help API users more quickly identify typos and errors in their clients.
  • Since version 3, paging via the Range HTTP header is not supported.
• Some API resources have been changed in v3
  • Inventory Details (GET data/InventoryDetails)
    • The field summary.upTime has a new format in milliseconds.
    • The new nested field chassis was added. It provides information about the chassis associated with the device.
    • The nested field udiDetail was removed. The unique device identifiers (productId, versionId, serialNumber) have been moved into other nested fields: module, fan, powerSupply and the newly introduced chassis.
  • The ClientSessions (GET data/ClientSessions) resource does not contain the associated AP name and IP address in v3 to improve performance.
  • The Devices (GET data/Devices) resource does not contain alarm counts in v3 to improve performance.
  • The Radio Interface Statistics (GET data/RFStats) and Historical Radio Interface Statistics (GET data/HistoricalRFStats) resources have been changed in v3 to improve performance. The v1 and v2 versions of this resource have been deprecated. Load statistics have been moved to new API resources: Radio Interface Load Statistics (GET data/RFLoadStats) and Historical Radio Interface Load Statistics (GET data/HistoricalRFLoadStats).
  • The Syslogs (GET data/Syslogs) resource in v3 has permanent IDs. The v1 and v2 versions of this resource have been deprecated.
  • This is not an exhaustive list. Please see the detailed list of API resources for an exhaustive reference of which resources have changes in v3.
• New API Resources!
  • The User Management Service offers resources to create, retrieve, update and delete Prime Infrastructure users.
  • Credential Profile Management Service provides resources to manage credential profiles and to get a list of devices configured by a certain profile.
  • The Guest User Management Service supports operations to manage guest users on WLAN controllers. It serves as a replacement for the Guest User Access API.
  • The MAC Filters Management Service offers services to create, retrieve, update, delete and deploy MAC Filtering templates.
  • The Virtual Domains Management Service provides resources to create, retrieve, update, and delete virtual domains.
  • And many more!
• New Aggregation framework allows a REST resource to be aggregated on a Prime Operations Center server from multiple managed Prime Infrastructure instances! In 3.2 Aggregation works only for API resources version 1.

What's New for the API in Prime Infrastructure 3.1

• We've updated the FAQ page. We've removed the item about persistent connections and 401 errors (because the issue has been resolved) and added a new item about ACS unresponsiveness causing 401 errors.
• New API Resources!
  • The Configuration Archive Service has been enhanced with new resources that allow for exporting multiple configuration archives in one request.
  • The Device Operations service has been enhanced with a new resource that removes devices from Prime Infrastructure via a job. If you were experiencing timeouts before (which were caused by cascading record deletions for some devices), give this new resource a whirl.
  • In Wireless Device Details, we've deprecated the Wireless Controller Utilization resources and implemented separate resources for CPU and memory utilization. These new services provide more detailed utilization information, breaking down CPU utilization for each device CPU, and memory utilization by each memory pool.
  • Plus many more, take a look!

What's New for the API in Prime Infrastructure 3.0

• We're on DevNet!
• We've updated the FAQ page.
• JSON Changes and API version 2
  • We've introduced a new API version, version 2. This version brings with it changes to our JSON payloads as well as performance enhanced versions of a few of our API resources.
  • The Client Summary (Clients) and Client Details (ClientDetails) API resources have been changed in v2 to improve performance. To see the new structure, click on the v2 tab after bringing up the documentation page. The v1 versions of these resources have been deprecated.
  • The JSON changes are focused on having more consistent serialization of the data. Previously, in API v1, users would see certain parameters be serialized as a string for some entities and as a number for others. In other cases, users would see a sub document serialized as a JSON object in one response and as a JSON array.
    • Please note, that the sample payloads in the documentation still show output based on the v1 JSON serializer.
  • To get output from the new JSON serializer, replace the "v1" in your URL with "v2" (for instance, "webacs/api/v2/data/Devices.json"). Note that if you access the Client Summary or Client Details in this fashion you will be accessing the modified v2 versions of those resources.
  • JSON output from the v1 API remains unchanged.
• New API Resources!
  • We've introduced the AAA/TACACS+ Servers Operation Service which allows you to get, create, update, and remove TACACS+ servers used by the appliance.
  • The CLI Template Configuration group has a few new resources in it to manage template folders. Some of the existing resources in that group have been accessed to allow users to work with template folders.
  • Next is a highly requested feature, the ability to fetch configuration archives of your devices via the API with the new Configuration Archive Service.
  • Another highly requested feature, the Group Management Service allows you to interact with location and network device groups via the API. The current features include the ability to manually assign devices, and create and modify rules for automatic device assignment.
  • Last but not least, we've added support to configure Notification Receivers via the new Trap Receivers resource group. With these resources, you can configure receivers to receive SNMP traps from the appliance based on the categories and severities you have configured.

What's New for the API in Prime Infrastructure 2.2

• New API Resources!
  • API Health Service Provides services to monitor and diagnose API performance and usage.
  • Device Operations Operations to add, update credentials, and remove managed devices.
  • Job Operations Operations to check job status, suspend, cancel and resume jobs.
  • User Defined Field Management Provides operations to query, create, update and delete user tag definitions.
  • WLAN Provisioning and Access Point Operations Provides operations to retrieve, create, modify, and delete WLAN interfaces, WLAN template, WLAN profiles, AP groups and the ability to modify some access point fields.
• We've added new user groups and changed how we authorize access to the API. These changes give you more control over how each user can use the API.
• We've added a newly improved step-by-step tutorial.
• Because many of our API resources that return client information do so for both wired and wireless we've created a new Clients group. Resources that fetch both wired and wireless client information have been moved to the Clients group; resources that only return information about wireless clients have been left in the Wireless Device Details group.