Endpoint Definition Versioning

The Keyfactor APIClosed An API is 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. supports multiple versions of individual endpoints. A new version is released when a code change would break backward compatibility with an existing endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server..

To switch between versions:

  1. Select from the Select a definition dropdown at the top of the Keyfactor API Reference and Utility page.

  2. All endpoints of the selected version will then display on the page.

Tip:  Most Keyfactor API endpoints can be found on the V1 definition page. When an endpoint has additional versions, each available version is noted in the endpoint's documentation.

Figure 638: Select a Version in the Keyfactor API Reference and Utility

Important:  The Classic API, also known as the CMS API, was removed in Keyfactor Command version 11. All uses of the Classic API should be migrated to the Keyfactor API prior to upgrading to Keyfactor Command version 11 or later.