POST Workflow Instances Instance Id Restart

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}/Restart operation restarts 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 (for example, a CAClosed A certificate authority (CA) is an entity that issues digital certificates. Within Keyfactor Command, a CA may be a Microsoft CA or a Keyfactor gateway to a cloud-based or remote CA. was not responding when an enrollmentClosed Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA). 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. On success, the operation returns 204 with no content.

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 1187: 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 operation 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 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.