The POST /Agents/Approve method is used to approve one or more orchestrators (a.k.a. agents). An orchestrator
Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. must be approved before jobs for it can be scheduled or carried out. This endpoint An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/agents/management/read/
/agents/management/modify/
Table 107: POST Agents Approve Input Parameters
| Name | In | Description |
|---|---|---|
| agentIds | Body | Required. An array of strings indicating the GUIDs of the orchestrators to approve. Use the GET Agents method (see GET Agents) to retrieve a list of all the orchestrators to determine the orchestrator GUIDs and current status of the orchestrators. |
Tip: See the Keyfactor API Reference and Utility which provides a utility through which 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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow 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.
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 workflow 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.