The POST /Agents/Reset method is used to reset one or more orchestrators, including:
- Remove all current orchestrator
Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. jobs for the selected orchestrator(s). - Delete all associated certificate stores.
- Set the orchestrator status to new.
- For orchestrators configured to use client certificate authentication, clear the certificate thumbprints stored for the orchestrator(s) to allow them to be reconfigured with a new certificate.
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. On a failure, a 400 is returned with an error message.
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/agents/management/read/
/agents/management/modify/
Table 110: POST Agents Reset Input Parameters
| Name | In | Description |
|---|---|---|
| agentIds | Body | Required. An array of strings indicating the Keyfactor Command reference GUIDs of the orchestrators to reset. Use the GET /Agents method (see GET Agents) to retrieve a list of all the orchestrators to determine the orchestrator GUIDs. |
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.