POST Workflow Instances Instance Id Stop
The POST /Workflow
/Instances/{instanceId}/Stop method is used to stop the workflow instance with the specified GUID, preventing it from continuing. This endpoint 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 Roles and Claims) are required to use this feature:
/workflows/instances/manage/
Table 833: 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: See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor API endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow 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.
endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow 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.