Pipeline retry API

Using API to retry pipeline with input set YAML

This knowledge base article provides step-by-step guidance on how to retry a pipeline based on the latest ExecutionId using Harness APIs.

Problem Statement

Retrying a pipeline based on the latest ExecutionId can be a challenging task, especially when dealing with complex deployment scenarios. Retrying a pipeline with an input set requires two API's :

1. API to get input set YAML from execution ID to get the inputset YAML used in the execution

2. API to rerty pipeline with input set YAML to retry the pipeline with input set YAML fetched from first API

Solution

1. Use the API Endpoint to get the input set YAML from pipeline execution id

2. Use the pipeline retry API Endpoint to retry the pipeline by passing the fetched input set YAML.

For example, the following Shell script uses Harness API endpoints to retrieve the input set YAML and retry the pipeline with the extracted input set YAML.To use this Shell script, replace placeholders, like ExecutionId, YOUR_API_TOKEN, YOUR_APPLICATION_ID, and YOUR_PIPELINE_ID with actual values relevant to your Harness account.

Problem

Retrying a pipeline based on the latest ExecutionId can be a challenging task, especially when dealing with complex deployment scenarios. Retrying a pipeline with an input set requires two endpoints:

• Pipeline Execution Details API - Get the inputSet YAML used for a given Plan Execution endpoint

• Pipeline Execute API - Retry an executed pipeline with inputSet pipeline YAML endpoint

Solution

1. Use the Pipeline Execution Details API to get the inputSet YAML used for the Plan Execution that you want to retry.

2. Use the Pipeline Execute API to retry the pipeline with the inputSet pipeline YAML.

Here is a Shell script that uses these two endpoints. To use this Shell script for yourself, replace placeholders, like ExecutionId, YOUR_API_TOKEN, YOUR_APPLICATION_ID, and YOUR_PIPELINE_ID, with actual values relevant to your Harness account.

microdnf install jq
API_KEY=""
PLAN_EXECUTION_ID=""
ACCOUNT_IDENTIFIER=""
ORG_IDENTIFIER=""
PROJECT_IDENTIFIER=""
PipelineIdentifier=""
Retrystages=""

# API endpoint URL <a href="#api-endpoint-url" id="api-endpoint-url"></a>
URL="https://app.harness.io/pipeline/api/pipelines/execution/${PLAN_EXECUTION_ID}/inputsetV2?accountIdentifier=${ACCOUNT_IDENTIFIER}&orgIdentifier=${ORG_IDENTIFIER}&projectIdentifier=${PROJECT_IDENTIFIER}&resolveExpressions=false&resolveExpressionsType=RESOLVE_ALL_EXPRESSIONS"

# Capture the output of the curl command into the output variable <a href="#capture-the-output-of-the-curl-command-into-the-output-variable" id="capture-the-output-of-the-curl-command-into-the-output-variable"></a>
output=$(curl -s -X GET "$URL" -H "x-api-key: $API_KEY" -H 'Content-Type: application/yaml')

# Extract inputSetTemplateYaml using jq <a href="#extract-inputsettemplateyaml-using-jq" id="extract-inputsettemplateyaml-using-jq"></a>
inputSetYaml=$(echo "$output" | jq -r '.data.inputSetYaml')

# Store the inputSetTemplateYaml in a variable <a href="#store-the-inputsettemplateyaml-in-a-variable" id="store-the-inputsettemplateyaml-in-a-variable"></a>
inputSetYaml1=$(echo "$inputSetYaml" | sed 's/\\n/\n/g')

echo "$inputSetYaml1"

curl -i -X POST \
  'https://app.harness.io/pipeline/api/pipeline/execute/retry/${PipelineIdentifier}?accountIdentifier=${ACCOUNT_IDENTIFIER}&orgIdentifier=${ORG_IDENTIFIER}&projectIdentifier=${PROJECT_IDENTIFIER}&moduleType=string&planExecutionId=${PLAN_EXECUTION_ID}&retryStages=${Retrystages}&runAllStages=true&notesForPipelineExecution=' \
  -H 'Content-Type: application/yaml' \
  -H 'x-api-key: pat.' \
  --data-binary @- <<EOF
$inputSetYaml1
EOF