GET Component Installation

The GET /ComponentInstallation method is used to return a list of all the Keyfactor Command components installed for the current implementation. Query parameters enable filtering using defined criteria, control over pagination by specifying the page number and return limit, and customization of sorting based on specified fields and order. This method returns HTTP 200 OK on a success with details about the installed components on each server.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/system_settings/read/

Table 439: GET Component Installation Input Parameters

Name In Description
QueryString Query

A string containing a query to limit the results (e.g. field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to: Certificate Search Page. The query fields supported for this endpoint are:

  • Machine
  • Version
PageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
ReturnLimit Query An integer that specifies how many results to return per page. The default is 50. Very large values can result in long processing time.
SortField Query

A string containing the property by which the results should be sorted. Fields available for sorting through the API include:

  • Machine

  • Version

Available sort fields are affected by the query provided in QueryString. The default sort field is Machine.
SortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 440: GET Component Installation Response Data

Name Description
ID An integer indicating the Keyfactor Command reference ID for the server installation.
Machine A string containing the FQDN of the server.
Version A string containing the version of Keyfactor Command installed on the server.
Components

A string containing a comma-separated list of the components installed on the server. Possible components include:

  • Console

    The server with this role provides the web-based administration interface (the Management Portal) that is used to view and report on certificates issued in the environment and enroll for certificates. This role is required on all Keyfactor Command servers.

  • Logi

    The server with this role hosts the Logi Analytics Platform for reporting. This role is required on all Keyfactor Command servers.

  • Agents

    The server with this role hosts the back-end service for receiving requests from and sending requests to Keyfactor agents and orchestrators. This role is optional.

  • KeyfactorAPI

    The server with this role hosts the newer Keyfactor API. This role is required on all Keyfactor Command servers.

  • Service

    The server with this role hosts back-end services required to support Keyfactor Command. This includes the Keyfactor Command Service, which is used for all periodic tasks throughout Keyfactor Command, including CA synchronization, monitoring alerts, and report automation. This role is required on all Keyfactor Command servers.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which 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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.