POST Workflow Instances Instance Id Stop

The POST /WorkflowClosed A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store./Instances/{instanceId}/Stop operation stops the workflow instance with the specified GUID, preventing it from continuing. On success, the operation returns 204 with no content.

Note:  Only workflow instances with a Status of Suspended can be stopped.
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:

/workflows/instances/manage/

Table 1185: POST Workflow Instances {instanceid} Stop Input Parameters

Name In Description
instanceId Path

Required. A string indicating the Keyfactor Command reference GUID of the workflow instance to stop.

Use the GET Workflow Instances operation to retrieve a list of all the workflow instances to determine the GUID.

Tip:  See the Keyfactor APIClosed 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended for validation, testing, and workflow development, and also serves as an interactive supplement to this API documentation. You can access it from the help menu () in the Management Portal.