Skip to main content

Resume Pipeline Executions using API

You can use the resumeExecution API to resume Pipeline deployment executions that meet the following criteria:

  • Failed
  • Aborted
  • Expired
  • Rejected

You cannot resume Successful or Paused executions.This is similar to resuming Pipeline executions in the Harness Manager. See Resume Pipeline Deployments.

Before You Begin​

Supported Platforms and Technologies​

See Supported Platforms and Technologies.

Limitations​

You can't modify any of the below mentioned settings:

  • You cannot change mandatory settings when you resume: You cannot change Start New Deployment inputs, variables, and Artifacts that are passed when you started your deployment.
  • You can resume a Pipeline that failed, expired, aborted, or was rejected.
  • The Pipeline and the Workflows used in the Pipeline can't be changed.
  • The templatization can't be changed.
  • You cannot add any new stage or change any of the existing stages.

Review: Permissions​

To resume a Pipeline using resumeExecution, a Harness User must belong to a User Group that has the following Application Permissions:

  • Permission Type: Deployments, Action: Execute Pipeline
  • Permission Type: Deployments, Action: Execute Pipeline, Application: <Application>
  • Permission Type: Deployments, Action: Execute Pipeline, Environment:<Environment Type>, Application: <Application>, but only to <Environment Type>

Review: What Can Be Resumed​

You can resume Pipeline executions that meet the following criteria:

  • Failed
  • Aborted
  • Expired
  • Rejected

You cannot resume Successful or Paused executions.This includes Pipelines with different configurations, such as:

Step: Resume Pipeline​

Here's an example of the resumeExecution API mutation:

mutation{  
  resumeExecution(input:{  
    applicationId:"LzcrN4VLTAW-dqZAtnsc_g"  
    pipelineExecutionId:"hUtAJdKOSxKWaTSkFlciyg"  
    pipelineStageName:"STAGE 3"  
  }){  
    execution{  
      status  
      id  
    }  
  }  
}

You simply need to provide the Application ID, Pipeline execution ID, and the name of the stage where you want to resume the execution.

To see the status of a Pipeline execution and see if it can be resumed:

{  
  execution(executionId: "<pipelineExecutionId>") {  
    id  
    ... on PipelineExecution {  
      status  
      pipelineStageExecutions {  
        pipelineStageElementId  
        pipelineStageName  
        pipelineStepName  
        ... on ApprovalStageExecution {  
          approvalStepType  
          status  
        }  
        ... on WorkflowStageExecution {  
          runtimeInputVariables {  
            allowedValues  
            defaultValue  
            allowMultipleValues  
            fixed  
            name  
            required  
            type  
          }  
          status  
          workflowExecutionId  
        }  
      }  
    }  
  }  
}

Note that pipelineExecutionId is the execution ID for a Pipeline's deployment. It is not the Pipeline ID.This will give you output with the stage names and statuses for the Pipeline, which you can use with resumeExecution:

{  
  "data": {  
    "execution": {  
      "id": "ddUCod0mT5ykAxOHjSvabg",  
      "status": "FAILED",  
      "pipelineStageExecutions": [  
        {  
          "pipelineStageElementId": "quPSKqBNQQ270Oao83d-hA",  
          "pipelineStageName": "STAGE 1",  
          "pipelineStepName": "Mongo",  
          "runtimeInputVariables": null,  
          "status": "FAILED",  
          "workflowExecutionId": "DQd-S3YER1S9cn7i6e68FQ"  
        },  
        {  
          "pipelineStageElementId": "Ohb83Po3Tz-zwslDp-QAMA",  
          "pipelineStageName": "STAGE 1",  
          "pipelineStepName": "Redis",  
          "runtimeInputVariables": null,  
          "status": "FAILED",  
          "workflowExecutionId": "FhdCOPbPTimmCyZJZhh4Tg"  
        },  
...

See Also​