The Agents component of the Keyfactor API
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. includes methods necessary to list orchestrators and agents and schedule jobs to retrieve log files for orchestrators and agents that support that functionality.
Table 100: Agents Endpoints
| Endpoint | Method | Description | Link |
|---|---|---|---|
| / | GET | Returns a list of all orchestrators and agents according to the provided filters and input parameters. | GET Agents |
| /{id} | GET | Returns details for a single orchestrator or agent. | GET Agents ID |
| /{id} | DELETE | Deletes an orchestrator and optionally associated data such as certificate stores, jobs and SSH servers. | DELETE Agents ID |
| /{id}/FetchLogs | POST | Schedules a job on the orchestrator or agent to retrieve log files. | POST Agents ID FetchLogs |
| /Approve | POST | Approves an orchestrator. | POST Agents Approve |
| /Disapprove | POST | Disapproves an orchestrator. | POST Agents Disapprove |
| /{id}/Reset | POST | Resets a single orchestrator or agent to a new state and clears jobs. | POST Agents ID Reset |
| /Reset | POST | Resets one or more orchestrators or agents to a new state and clears jobs. | POST Agents Reset |
| /SetAuthCertificateReenrollment | POST | Configures an orchestrator or agent to either request or require a new client authentication certificate on its next session registration. | POST Agents Set Auth Certificate Reenrollment |