ON THIS PAGE
 

Change Log (API)

This reference demonstrates the change log API usage with parity to the UI. For full API documentation, view the REST Platform API reference under the Apstra GUI.

The API Change Log is designed to help you track and manage API lifecycle changes across software versions. It ensures you remain informed about deprecated, and removed endpoints, as well as new and modified existing API endpoints.

Deprecation HTTP Header Field

When an API endpoint is marked as "DEPRECATED", the system uses a Deprecation HTTP Header Field to notify you of its impending removal, allowing you to plan for necessary adjustments. These endpoints are displayed with a strikethrough in the API Explorer, visually indicating their status. Once an endpoint is fully removed, it is no longer visible in the API Explorer but remains documented within the Change Log, preserving a historical record for your reference.

HTTP response details with request URL https://10.28.252.3/api/product-usage-nightly, method GET, status 200 OK, and highlighted Deprecation header set to True.

The Change Log stacks the subsequent changes for the different releases with the most important or recent information at the top. The order from top to bottom is REMOVED, DEPRECATED, CHANGED, NEW:

API endpoint documentation for api/product-usage marked as DEPRECATED, detailing its purpose of returning product usage reports on Apstra features. Includes changelog summarizing updates in versions 6.1.0, 6.0.0, and 5.1.0, highlighting field additions, updates, and endpoint evolution.
Note:

To get access to changes prior to installation of a new version, use Changelog.md to reflect the Change log in the public product documentation page.

Change Log Filter

Advanced search and filter capabilities empower you to efficiently locate specific changes, allowing you to search by key word parameters such as Path, Summary, Method, and Change Type. This functionality facilitates quick access to relevant information, enabling you to focus on modifications that impact your operations the most.

API Changelog interface with version 6.1.0; categories NEW 18, CHANGED 95, DEPRECATED 6, REMOVED 1; search bar with filter applied; showing 6 filtered changes including HTTP methods, endpoints, and descriptions.
Query filter interface with fields for Path set to rack, Method unselected, Summary empty, Changes unselected, and buttons Apply and Clear. One filter applied.

To select a specific release and request to view only new changes, display the total count of changes by type: REMOVED, DEPRECATED, CHANGED, NEW that act as hyperlinks to update the page with that filter.

API Changelog with versions 6.1.0, 6.0.0, 5.1.0, and 5.0.0, showing categories NEW, CHANGED, DEPRECATED, and REMOVED. Arrow points to DEPRECATED badge with note to filter the list.

The system also provides a summary count of changes categorized by type, with each category hyperlinked for easy navigation. Prioritization of critical changes ensures you are well-informed about the most impactful updates, aiding in effective change management and adaptation.