The Agents component of the Keyfactor API
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. includes methods necessary to list orchestrators and agents and schedule jobs to retrieve log files for orchestrators and agents that support that functionality.
Tip: The Keyfactor Bash Orchestrator The Bash Orchestrator, one of Keyfactor's suite of orchestrators, is used to discover and manage SSH keys across an enterprise. and the Keyfactor Universal Orchestrator The Keyfactor Universal Orchestrator, one of Keyfactor's suite of orchestrators, is used to interact with servers and devices for certificate management, run SSL discovery and management tasks, and manage synchronization of certificate authorities in remote forests. With the addition of custom extensions, it can provide certificate management capabilities on a variety of platforms and devices (e.g. Amazon Web Services (AWS) resources, Citrix\NetScaler devices, F5 devices, IIS stores, JKS keystores, PEM stores, and PKCS#12 stores) and execute tasks outside the standard list of certificate management functions. It runs on either Windows or Linux servers or Linux containers. will include its unique ID as part of the API request header.
The Bash Orchestrator, one of Keyfactor's suite of orchestrators, is used to discover and manage SSH keys across an enterprise. and the Keyfactor Universal Orchestrator The Keyfactor Universal Orchestrator, one of Keyfactor's suite of orchestrators, is used to interact with servers and devices for certificate management, run SSL discovery and management tasks, and manage synchronization of certificate authorities in remote forests. With the addition of custom extensions, it can provide certificate management capabilities on a variety of platforms and devices (e.g. Amazon Web Services (AWS) resources, Citrix\NetScaler devices, F5 devices, IIS stores, JKS keystores, PEM stores, and PKCS#12 stores) and execute tasks outside the standard list of certificate management functions. It runs on either Windows or Linux servers or Linux containers. will include its unique ID as part of the API request header.Note: The Keyfactor Mac Auto-Enroll Agent was deprecated as of Keyfactor Command version 11. Any Mac Auto-Enrollment Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA). tools and configurations in the product should not be used.
Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA). tools and configurations in the product should not be used. Table 148: 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 |
Was this page helpful? Provide Feedback