POST Workflow Instances Instance Id Stop

The POST /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./Instances/{instanceId}/Stop method is used to stop the workflow instance with the specified GUID, preventing it from continuing. 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.

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

WorkflowInstances: Manage

Table 666: 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 method (see GET Workflow Instances) to retrieve a list of all the workflow instances to determine the GUID.

Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.