GET Agents

The GET /Agents method is used to retrieve a list of orchestrators and agents registered in Keyfactor Command. This method returns HTTP 200 OK on a success with a list of all orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. details.

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

/agents/management/read/

Table 99: GET Agents 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: Using the Orchestrator Management Search Feature. The query fields supported for this endpoint are:

  • Identity (Username)
  • LastSeen (DateTime)
  • Platform (Platform types: 0-Unknown, 1-.NET, 2-Java, 3-Mac, 4-Android, 5-Native, 6-Bash, 7-Universal Orchestrator)
  • Status (1-New, 2-Approved, 3-Disapproved)
  • Version
Tip:  Use the following query to return only approved orchestrators:
Status -eq "2"

A value of 1 will return orchestrators with a status of New and a value of 3 will return orchestrators with a status of Disapproved.
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.
SkipCount Query An integer indicating the number of records that should be skipped in providing results, starting from the beginning of the records (for pagination). This field is optional and no records will be skipped if not provided.
ReturnLimit Query An integer that specifies how many results to return per page. The default is 50.
SortField Query A string containing the property by which the results should be sorted. Fields available for sorting through the API for the most part match those that appear as sortable columns in the Keyfactor Command Management Portal. The default sort field is AgentId.
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 100: GET Agent Response Data

Name Description
AgentId A string indicating the GUID of the orchestrator.
ClientMachine A string indicating the client machine on which the orchestrator is installed.
Username A string indicating the Active Directory user or service account the orchestrator is using to connect to Keyfactor Command.
AgentPlatform

An integer indicating the platform for the orchestrator. ClosedShow agent platform values.
Version A string indicating the version of the orchestrator.
Status An integer indicating the orchestrator status. ClosedShow status values.
LastSeen The time, in UTC, at which the orchestrator last contacted Keyfactor Command.
Capabilities An array of strings indicating the capabilities reported by the orchestrator. These may be built-in or custom capabilities. ClosedShow built-in capability values for common orchestrators.
Blueprint

A string indicating the name of the blueprint associated with the orchestrator.
Thumbprint A string indicating the thumbprint of the certificate that Keyfactor Command is expecting the orchestrator to use for client certificate authentication.
LegacyThumbprint A string indicating the thumbprint of the certificate previously used by the orchestrator for client certificate authentication before a certificate renewal operation took place (rotating the current thumbprint into the legacy thumbprint). The legacy thumbprint is cleared once the orchestrator successfully registers with the new thumbprint.
AuthCertificateReenrollment

An integer indicating the value of the orchestrator certificate reenrollment request or require status. ClosedShow values.
LastThumbprintUsed A string indicating the thumbprint of the certificate that the orchestrator most recently used for client certificate authentication. In most cases, this will match the Thumbprint.
LastErrorCode An integer indicating the last error code, if any, reported from the orchestrator when trying to register a session. This code is cleared on successful session registration.
LastErrorMessage A string indicating the last error message, if any, reported from the orchestrator when trying to register a session. This message is cleared on successful session registration.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the 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. 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 the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked. 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.