DELETE Agents ID

The DELETE /Agents/{id} method is used to delete a single orchestratorClosed Keyfactor orchestrators perform a variety of functions, including managing certificate stores and SSH key stores. or agent registered in Keyfactor Command. If desired, data associated with the orchestrator such as jobs for this orchestrator or agent, any certificate stores configured for this orchestrator or agent, and any SSHClosed The SSH (secure shell) protocol provides for secure connections between computers. It provides several options for authentication, including public key, and protects the communications with strong encryption. servers associated with this orchestrator may also be deleted using the force option. The orchestrator must be in a disapprvoed state in order to be deleted. This endpointClosed 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/modify/

Table 105: DELETE Agents{id} Input Parameters

Name In Description
id Path Required. The GUID of the orchestrator to delete.

Use the GET /Agents method (see GET Agents) to retrieve a list of all the orchestrators to determine the orchestrator GUID.
force Query A Boolean indicating whether to force deletion of the orchestrator (true) in the case where dependent data exists for it such as orchestrator jobs, certificate stores associated with the orchestrator, or SSH servers associated with the orchestrator. The default is false.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed 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 workflowClosed 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.