What's New for the API in Prime Infrastructure 3.3
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
- New API Resources!
- 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.