Pipeline Execution Details

This contains APIs for fetching Pipeline Execution Details

Fetch Pipeline Execution Details

Returns the Pipeline Execution Details for a Given PlanExecution ID

SecurityApiKey
Request
path Parameters
planExecutionId
required
string

Plan Execution Id for which we want to get the Execution details

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.

stageNodeId
string

Stage Node Identifier for which Stage Graph needs to be Rendered

stageNodeExecutionId
string

Stage Node Execution ID for which Stage Graph needs to be Rendered. (Needed only when there are Multiple Runs for a Given Stage. It can be Extracted from LayoutNodeMap Field)

renderFullBottomGraph
boolean

Generate Graph for all the Stages including Steps in each Stage

Responses
400

Bad Request

500

Internal server error

default

Return the Pipeline Execution details for given PlanExecution Id without full graph if stageNodeId is null

get/pipeline/api/pipelines/execution/v2/{planExecutionId}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/pipelines/execution/v2/{planExecutionId}?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&stageNodeId=string&stageNodeExecutionId=string&renderFullBottomGraph=true' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Fetch Pipeline Execution DetailsDeprecated

Returns the Pipeline Execution Details for a Given PlanExecution ID

SecurityApiKey
Request
path Parameters
planExecutionId
required
string

Plan Execution Id for which we want to get the Execution details

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.

stageNodeId
string

Stage Node Identifier for which Stage Graph needs to be Rendered

stageNodeExecutionId
string

Stage Node Execution ID for which Stage Graph needs to be Rendered. (Needed only when there are Multiple Runs for a Given Stage. It can be Extracted from LayoutNodeMap Field)

Responses
400

Bad Request

500

Internal server error

default

Return the Pipeline Execution details for given PlanExecution Id

get/pipeline/api/pipelines/execution/{planExecutionId}
Request samples
curl -i -X GET \
  'https://app.harness.io/gateway/pipeline/api/pipelines/execution/{planExecutionId}?accountIdentifier=string&orgIdentifier=string&projectIdentifier=string&stageNodeId=string&stageNodeExecutionId=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

List Executions

Returns a List of Pipeline Executions with Specific Filters

SecurityApiKey
Request
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.

searchTerm
string

Search term to filter out pipelines based on pipeline name, identifier, tags.

pipelineIdentifier
string

Pipeline Identifier filter if exact pipelines needs to be filtered.

page
integer <int32>
Default: 0

Page Index of the results to fetch.Default Value: 0

size
integer <int32>
Default: 10

Results per page

sort
Array of strings

Sort criteria for the elements.

filterIdentifier
string
module
string
status
Array of strings
Items Enum: "RUNNING" "ASYNCWAITING" "TASKWAITING" "TIMEDWAITING" "FAILED" "ERRORED" "IGNOREFAILED" "NOTSTARTED" "EXPIRED" "ABORTED" "DISCONTINUING" "QUEUED" "PAUSED" "RESOURCEWAITING" "INTERVENTIONWAITING" "APPROVALWAITING" "SUCCESS" "SUSPENDED" "SKIPPED" "PAUSING" "APPROVALREJECTED" "INPUTWAITING" "NOT_STARTED" "INTERVENTION_WAITING" "APPROVAL_WAITING" "APPROVAL_REJECTED" "WAITING"
myDeployments
boolean
branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Request Body schema:
Responses
400

Bad Request

500

Internal server error

default

Returns all the Executions of pipelines for given filters

post/pipeline/api/pipelines/execution/summary
Request samples
No sample
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}