Execution Details

This contains APIs for fetching Pipeline Execution details.

Gets list of Executions of Pipelines for specific filters.

Request
Security:
ApiKey (readwrite)
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

The number of the page to fetch

size
integer <int32>
Default: 10

The number of the elements to fetch

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" "NOT_STARTED" "INTERVENTION_WAITING" "APPROVAL_WAITING" "APPROVAL_REJECTED" "WAITING"
myDeployments
boolean
branch
string

Branch Name

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": [
    ]
}

Get the Pipeline Execution details for given PlanExecution Id

Request
Security:
ApiKey (readwrite)
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 to get execution stats.

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' \
  -H 'x-api-key: YOUR_API_KEY_HERE'
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get the Input Set YAML used for given Plan Execution

Request
Security:
ApiKey (readwrite)
path Parameters
planExecutionId
required
string

Plan Execution Id for which we want to get the Input Set YAML

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.

resolveExpressions
boolean
Default: false
Responses
400

Bad Request

500

Internal server error

default

Return the Input Set YAML used for given Plan Execution

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

Get the Input Set YAML used for given Plan Execution

Request
Security:
ApiKey (readwrite)
path Parameters
planExecutionId
required
string

Plan Execution Id for which we want to get the Input Set YAML

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.

resolveExpressions
boolean
Default: false
Responses
400

Bad Request

500

Internal server error

default

Return the Input Set YAML used for given Plan Execution

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