Versioning
The Keyfactor Web APIs are versioned as a set and released in conjunction with Keyfactor Command at the same version level (e.g. version 10.5). In addition, the Keyfactor API
A set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. may have multiple versions of select endpoints.
The current strategy is to increment the version of an API when changes are made that might break backwards compatibility for existing clients. New endpoints are generally implemented in the most recent version of their API.
Generally, updates to an existing version of an endpoint An endpoint is a URL that enables the API to gain access to resources on a server. are restricted to updates that should not break existing clients. Updates may be made that add HTTP response headers or response body parameters, or that correct existing bugs, or must be made to conform to newer or more granular security constraints. When an update cannot be made without breaking existing clients, a new endpoint is added in a later API version.
Figure 431: Select a Version in the Keyfactor API Endpoint Utility
Most Keyfactor API endpoints have only one version, though a second version has been released for a select few endpoints. The Keyfactor API uses the x-keyfactor-api-version request header to differentiate between versions 1 and 2 of a given endpoint. If a version isn't specified, version 1 is assumed.
