DELETE Agents ID
The DELETE /Agents/{id} method is used to delete a single orchestrator 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 SSH
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 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.
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. |


