Restarting workflows

Restart a previously executed workflow whose status is failed, stopped, or timeout.

Before you begin

  • You need execute permission.
  • The workflow execution must be in one of the following statuses:
    • failed
    • stopped
    • timeout
  • Ensure that the Restart capability was enabled on the Execution Settings page at the time of workflow execution.

Procedure

  1. In a REST client platform, add authentication details of the tenant. 
    
//In case of Instance API key 
Headers:
{
"x-instance-api-key": "instance_api_key"
}
 
// In case of MCSP or ISV token
Headers:
{
"Authorization": "mcsp_or_isv_token"
}
  2. Optional: Add payload

    If no payload is provided, the original payload from the initial execution will be reused.

    {
    "payload": {
        "data": {},
        "query": {},
        "headers": {},
        "type": "manual-request"
    }}
  3. Make a POST request at the URL of the workflow.
    URL Syntax - /apis/v2/rest/execute/workflow/:execution_id/restart
    If the request is successful, you receive the response code for success.
    {
  "message": "Workflow enqueued successfully.",
  "status": "queued",
  "bill_uid": "<bill_uid>",
  "flow_uid": "<flow_uid>",
  "project_uid": "<project_uid>",
  "tenant_uid": "<tenant_uid>",
  "code": 158
}