Pipeline Execution

This contains APIs for Executing a Pipeline

Execute a Pipeline with Input Set References

Execute a Pipeline with Input Set References

SecurityApiKey
Request
path Parameters
identifier
required
string

Pipeline identifier for the entity. Identifier of the Pipeline to be executed

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

moduleType
required
string

Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

getDefaultFromOtherRepo
boolean

if true, return all the default entities

useFQNIfError
boolean
Default: false
Request Body schema:
inputSetReferences
Array of strings

List of Input Set References to be merged

withMergedPipelineYaml
boolean

This is a boolean value that indicates if the response must contain the YAML for the merged Pipeline. The default value is False.

stageIdentifiers
Array of strings

List of Stage Ids. Input Sets corresponding to these Ids will be merged.

Responses
400

Bad Request

500

Internal server error

default

Returns pipeline execution details V2

post/pipeline/api/pipeline/execute/{identifier}/inputSetList
Request samples
{
  • "inputSetReferences": [
    ],
  • "withMergedPipelineYaml": true,
  • "stageIdentifiers": [
    ]
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Execute a Pipeline with Runtime Input YAML

Execute a Pipeline with Runtime Input YAML

SecurityApiKey
Request
path Parameters
identifier
required
string

Pipeline identifier for the entity. Identifier of the Pipeline to be executed

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

moduleType
required
string

Module type for the entity. If its from deployments,type will be CD , if its from build type will be CI

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

getDefaultFromOtherRepo
boolean

if true, return all the default entities

useFQNIfError
boolean
Default: false
Request Body schema:

Enter Runtime Input YAML if the Pipeline contains Runtime Inputs. Please refer to https://ngdocs.harness.io/article/f6yobn7iq0 and https://ngdocs.harness.io/article/1eishcolt3 to see how to generate Runtime Input YAML for a Pipeline.

string
Responses
400

Bad Request

500

Internal server error

default

Returns pipeline execution details

post/pipeline/api/pipeline/execute/{identifier}
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Execute an Interrupt

Executes an Interrupt on a Given Execution

SecurityApiKey
Request
path Parameters
planExecutionId
required
string

The Pipeline Execution Id on which the Interrupt needs to be applied.

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

interruptType
required
string

The Interrupt type needed to be applied to the execution. Choose a value from the enum list.

Enum: "ABORTALL" "ABORT" "PAUSE" "RESUME" "IGNORE" "STAGEROLLBACK" "STEPGROUPROLLBACK" "MARKASSUCCESS" "EXPIREALL" "RETRY"
Responses
400

Bad Request

500

Internal server error

default

Takes a possible Interrupt value and applies it onto the execution referred by the planExecutionId

put/pipeline/api/pipeline/execute/interrupt/{planExecutionId}
Request samples
curl -i -X PUT \
  'https://app.harness.io/gateway/pipeline/api/pipeline/execute/interrupt/{planExecutionId}?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&interruptType=ABORTALL' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}