POST Workflow Instances Instance Id Restart

The POST /WorkflowClosed/Instances/{instanceId}/Restart method is used to restart the workflow instance with the specified GUID. This can be used either after it has reached a failed state and the failure has been corrected (e.g. a CAClosed was not responding when an enrollmentClosed was attempted or a PowerShell script failed to run to completion) or midstream while it's still active but in a suspended state waiting for signals to introduce a new version of the workflow definition. The workflow instance will restart from the beginning. This endpointClosed returns 204 with no content upon success.

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

/workflows/instances/manage/
/workflows/instances/read/

Table 835: POST Workflow Instances {instanceid} Restart Input Parameters

Name In Description
instanceId Path

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

Use the GET /Workflow/Instances method (see GET Workflow Instances) to retrieve a list of all the workflow instances to determine the GUID.

Note:  When you restart an instance, it will be issued a new instance ID.
version Body

An integer indicating the version number of the workflow definition. If no version is specified, the workflow will be restarted using the most recently published version.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor APIClosed 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.