GET Agents ID
The GET /Agents/{id} method is used to retrieve a single orchestrator Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. or agent registered in Keyfactor Command. This method returns HTTP 200 OK on a success with a list of all orchestrator details.
Table 103: GET Agents{id} Input Parameters
Name | In | Description |
---|---|---|
id | Path | Required. The GUID of the orchestrator to retrieve. Use the GET /Agents method (see GET Agents) to retrieve a list of all the orchestrators to determine the orchestrator GUID. |
Table 104: GET Agent {id} 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. |
||||||||||
Version | A string indicating the version of the orchestrator. | ||||||||||
Status | An integer indicating the orchestrator status. ![]() |
||||||||||
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. ![]() |
||||||||||
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. |
||||||||||
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. | ||||||||||
JobTypes |
An array of strings indicating the job types correlated with the orchestrator with the following attributes:
|


