Keyfactor Command Keyfactor API

The KeyfactorAPI appsettings.json configuration file allows you to view or change the Keyfactor Command Keyfactor APIClosed 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. installation configuration settings.

To update the appsettings.json file:

  1. Navigate to the KeyfactorAPI\Configuration folder on your server, located by default at:

    C:\Program Files\Keyfactor\Keyfactor Platform\KeyfactorAPI\Configuration
  2. Browse to open the appsettings.json file in a text editor (e.g. Notepad) and adjust the values as needed.
  3. Save the files.

Table 82: Appsetting.json File Parameters - KeyfactorAPI

Setting Description
NLog Config File

Enter the file path to the Nlog_KeyfactorAPI.config file. The default is:

C:\Program Files\Keyfactor\Keyfactor Platform\KeyfactorAPI\Configuration
Extensions Directory

Enter the file path to the extensions to be loaded by the extension loader (for registration handler, workflow step, etc... support). The default value is Extensions, for example:

C:\Program Files\Keyfactor\Keyfactor Platform\KeyfactorAPI\Extensions
Active Directory Enforced This should be set to false if you are not using Active Directory. An IIS reset will be required to apply this setting if you change it.
Sql Retry Configuration SQL retry settings (seeKeyfactor Command Changing SQL Retry Settings for more information).
Setting Description
Number Of Tries The number of times it will try the connection before an exception is thrown
Delta TimeThe preferred gap time (in seconds) to delay before retry
Max Time IntervalThe maximum gap time (in seconds) for each delay time before retry

Figure 407: Sample KeyfactorAPI Appsettings.json File