How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Harness Pipeline Execution Details API

This contains APIs for fetching Pipeline Execution Details

Harness Pipeline Execution Details API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pipeline Execution Details. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This API exposes 17 operations across 16 paths, and defines 267 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

17 operations 16 paths 267 schemas 12 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Pipeline Execution Details API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 17

Across 16 paths, the API surfaces 17 operations — 12 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Pipeline Execution Details 17

This contains APIs for fetching Pipeline Execution Details

GET
/pipeline/api/pipelines/execution/canRetry/{planExecutionId}
Validate if Execution can be retried
canRetryExecution 4 params → 400500default
GET
/pipeline/api/pipelines/execution/{planExecutionId}/annotations/{contextId}/content
Fetch Full Annotation Content
getAnnotationFullContent 6 params → 400500default
GET
/pipeline/api/pipelines/execution/{planExecutionId}deprecated
Fetch Execution Details
getExecutionDetail 6 params → 400500default
GET
/pipeline/api/pipelines/execution/v2/{planExecutionId}
Fetch Execution Details
getExecutionDetailV2 9 params → 400500default
GET
/pipeline/api/pipelines/execution/getExecutionGraph/{planExecutionId}
Fetch Execution Graph
getExecutionGraph 4 params → 400500default
GET
/pipeline/api/pipelines/execution/subGraph/{planExecutionId}/{nodeExecutionId}
Fetch Execution SubGraph for a Given Retried StepGroup NodeExecution ID
getExecutionSubGraphForNodeExecution 5 params → 400500default
POST
/pipeline/api/pipelines/execution/url
Fetch Execution Url
getExecutionURL 6 params → 400500default
GET
/pipeline/api/pipelines/execution/{planExecutionId}/metadata
Get execution metadata of a pipeline execution
getExecutionData 2 params → 400500default
GET
/pipeline/api/pipelines/execution/{planExecutionId}/inputsetV2
Get the Input Set YAML used for given Plan Execution
getInputsetYamlV2 6 params → 400500default
GET
/pipeline/api/pipelines/execution/{planExecutionId}/policy-evaluation
Gets the policy evaluated used for given Plan Execution
getPpolicyEvaluation 6 params → 400500default
POST
/pipeline/api/pipelines/execution/executionSummary
List Execution Identifier
getListOfExecutionIdentifier 10 params body → 400500default
POST
/pipeline/api/pipelines/execution/summary
List Executions
getListOfExecutions 16 params body → 400500default
POST
/pipeline/api/pipelines/execution/summary/outline
List Executions Outline
getListOfExecutionsOutline 6 params body → 400500default
GET
/pipeline/api/pipelines/execution/{planExecutionId}/notes
Get Notes for a pipelineExecution
getNotesForExecution 2 params → 400500default
PUT
/pipeline/api/pipelines/execution/{planExecutionId}/notes
Updates Notes for a pipelineExecution
updateNotesForExecution 5 params → 400500default
GET
/pipeline/api/pipelines/execution/{planExecutionId}/annotations
Fetch Pipeline Execution Annotations
getPipelineExecutionAnnotations 5 params → 400500default
GET
/pipeline/api/pipelines/execution/{planExecutionId}/workflow-graph
Get workflow graph for visualization
getWorkflowGraph 4 params → 400500default

Schemas 267

The contract defines 267 schemas that model the data the API accepts and returns. The most detailed are PipelineExecutionSummary (58 properties), FileOptions (44 properties), FileOptionsOrBuilder (40 properties), FileDescriptorProto (38 properties). Each schema is shown below with its type and property counts.

ParserMessageLite
object
UninterpretedOption
object
20 properties
ExecutableResponse
object
32 properties
ChildChainExecutableResponse
object
16 properties
RetryInterruptConfig
object
1 property 1 required
ParserTemplateReferenceSummary
object
DelegateInfo
object
4 properties
ParserSyncExecutableResponse
object
ResponseDTOPipelineExecutionDetail
object
4 properties
FieldDescriptor
object
26 properties
ParserBuildInfo
object
ParserLocation
object
ParserChildExecutableResponse
object
PipelineExecutionOutlineFilterDTO
object
4 properties
BuildInfoOrBuilder
object
10 properties
FieldOptionsOrBuilder
object
27 properties
PageGovernanceMetadata
object
11 properties
UnitProgress
object
15 properties
EnumValueDescriptorProtoOrBuilder
object
11 properties
ParserFacilitatorExecutableResponse
object
ParserEnumValueDescriptorProto
object
BuildInfo
object
13 properties
PipelineEntityGitDetails
object
This contains Validity Details of the Entity
2 properties
ParserIdentityContextUpdateResponse
object
DescriptorProtoOrBuilder
object
31 properties
ExecutionNode
object
27 properties
ParserFieldDescriptorProto
object
AbortedBy
object
This contains info of the user who aborted the pipeline
3 properties
ManualIssuer
object
4 properties 4 required
FacilitatorExecutableResponse
object
17 properties
CvDescriptorProto
object
36 properties
Location
object
19 properties
ParserSkipTaskExecutableResponse
object
ResponseDTOPagePipelineExecutionIdentifierSummary
object
4 properties
FeatureSupport
object
14 properties
ResponseDTOWorkflowGraph
object
4 properties
ParserPolicyMetadata
object
TaskChainExecutableResponseOrBuilder
object
18 properties
ParserFeatureSupport
object
ExtensionRangeOrBuilder
object
10 properties
ParserSkipInfo
object
Pageable
object
6 properties
NGLabel
object
Pipeline labels
2 properties
ParserChildChainExecutableResponse
object
InputSetTemplateResponse
object
This contains the Runtime Input YAML used during a Pipeline Execution.
5 properties
MessageOptionsOrBuilder
object
16 properties
SystemIssuer
object
1 property
TemplateDescriptorProtoOrBuilder
object
32 properties
OneofOptionsOrBuilder
object
11 properties
FieldDescriptorProtoOrBuilder
object
23 properties
PipelinePolicyMetadata
object
31 properties
PagePipelineExecutionIdentifierSummary
object
11 properties
ReservedRangeOrBuilder
object
8 properties
NodeRunInfo
object
16 properties
NodeExecutionDetails
object
This contains the Node Execution Graph details.
1 property
ParserChild
object
TaskExecutableResponseOrBuilder
object
16 properties
CvDescriptor
object
14 properties
ExtensionRange
object
13 properties
RetryNodeMetadata
object
5 properties
ResponseDTOAnnotationContentResponse
object
4 properties
TimeRange
object
Filter by queued time window
4 properties
ResponseDTOPipelineAnnotationsResponseDTO
object
4 properties
FacilitatorExecutableResponseOrBuilder
object
14 properties
AsyncExecutableResponse
object
19 properties
PipelineExecutionFilterProperties
object
Filter properties for listing pipeline executions. The filterType field (inherited) is required and must be set to PipelineExecution.
19 properties 1 required
ResponseDTOPageGovernanceMetadata
object
4 properties
ParserFileDescriptorProto
object
ForMetadataOrBuilder
object
10 properties
ExecutionDataResponse
object
This contains Execution metadata details.
2 properties
CustomPagePipelineExecutionOutline
object
This is the custom page implementation
5 properties
FileOptions
object
44 properties
ParserForMetadata
object
ChildrenExecutableResponseOrBuilder
object
15 properties
ResponseDTOString
object
4 properties
OneofDescriptor
object
9 properties
ResponseDTOPipelineExecutionNotes
object
4 properties
ParserPolicySetMetadata
object
NamePart
object
12 properties
TaskChainExecutableResponse
object
21 properties
PipelineGovernanceMetadata
object
Full governance metadata including policy set details
33 properties
ParserReservedRange
object
ParserEnumOptions
object
ResponseDTONodeExecutionDetails
object
4 properties
WorkflowGraphNode
object
6 properties
HarnessIdApiConfig
object
11 properties
ParserEditionDefault
object
ParserTriggeredBy
object
ServiceOptionsOrBuilder
object
12 properties
ServiceDescriptorProto
object
16 properties
ParserMatrixMetadata
object
Sort
object
3 properties
TimeoutIssuer
object
1 property 1 required
SyncExecutableResponseOrBuilder
object
10 properties
ParserMethodDescriptorProto
object
ParserOneofDescriptorProto
object
ParserMessageOptions
object
AsyncExecutableResponseOrBuilder
object
16 properties
AsyncChainExecutableResponseOrBuilder
object
19 properties
DeclarationOrBuilder
object
13 properties
ServiceOptions
object
16 properties
UninterpretedOptionOrBuilder
object
17 properties
ParserExecutionTriggerInfo
object
OneofOptions
object
15 properties
ServiceDescriptor
object
7 properties
MatrixMetadataOrBuilder
object
17 properties
PipelineExecutionSummary
object
This is the view of the Pipeline Execution Summary
58 properties 2 required
CIPullRequestDTO
object
2 properties
PipelineExecutionOutline
object
This is the view of the Pipeline Execution Outline
20 properties 3 required
ExecutionTriggerInfo
object
18 properties
ExpressionBlockOrBuilder
object
11 properties
ExecutionGraph
object
5 properties
ResponseDTOExecutionGraph
object
4 properties
PipelineExecutionNotes
object
Notes of a pipeline execution
1 property
ParserExtensionRange
object
NodeExecutionOutline
object
This is the view of the Node Execution Outline
11 properties
IdentityContextUpdateResponseOrBuilder
object
8 properties
ParserUninterpretedOption
object
ParserFieldOptions
object
ResponseMessage
object
7 properties
ParserUnitProgress
object
StrategyMetadataOrBuilder
object
15 properties
FeatureSetOrBuilder
object
12 properties
ParserServiceOptions
object
Descriptor
object
14 properties
MethodDescriptor
object
11 properties
ParserOneofOptions
object
WorkflowGraph
object
2 properties
SourceCodeInfo
object
13 properties
ChildExecutionDetail
object
This contains the Pipeline Execution details of Child Pipeline
2 properties
LocationOrBuilder
object
16 properties
EdgeLayoutList
object
This contains info about the Layout of the Graph
2 properties
FieldDescriptorProto
object
26 properties
ParserDescriptorProto
object
OneofDescriptorProto
object
13 properties
ChildExecutableResponseOrBuilder
object
13 properties
EditionDefaultOrBuilder
object
9 properties
EnumReservedRangeOrBuilder
object
8 properties
CDModulePropertiesDTO
object
6 properties
NGTag
object
This is the view of the tags of the entity.
2 properties 1 required
InputSetDetails
object
Details of an inputset used in a pipeline execution
2 properties
FileDescriptorProto
object
38 properties
ParserAsyncChainExecutableResponse
object
PipelineErrorMetadata
object
This implements different error meta data objects
1 property
SkipTaskExecutableResponse
object
11 properties
OrchestrationMap
object
SkipTaskExecutableResponseOrBuilder
object
8 properties
PipelineExecutionIdentifierSummary
object
This is the view of the Pipeline Execution Identifier Summary
6 properties 2 required
IdentityExecutionContextOrBuilder
object
11 properties
ParserMethodOptions
object
ParserChildrenExecutableResponse
object
ParserExpressionBlock
object
ParserHarnessIdApiConfig
object
CIModulePropertiesDTO
object
5 properties
ParserExtensionRangeOptions
object
StrategyMetadata
object
18 properties
ParserServiceDescriptorProto
object
ServiceDescriptorProtoOrBuilder
object
13 properties
PipelineError
object
This is Error entity as defined in Harness
7 properties
PipelineAnnotation
object
5 properties 5 required
ParserRerunInfo
object
Message
object
8 properties
ParserFeatureSet
object
MethodDescriptorProtoOrBuilder
object
16 properties
RerunInfoOrBuilder
object
14 properties
IdentityExecutionContext
object
14 properties
ParserTaskChainExecutableResponse
object
PipelineStageInfo
object
23 properties
ByteString
object
2 properties
WorkflowGraphRelation
object
4 properties
ParserMessage
object
SkipInfo
object
12 properties
IssuedBy
object
6 properties 1 required
ResponseDTOBoolean
object
4 properties
TriggeredByOrBuilder
object
21 properties
EnumOptionsOrBuilder
object
14 properties
EnumDescriptorProto
object
21 properties
ParserSourceCodeInfo
object
PipelineExecutionDetail
object
This contains the Pipeline Execution details.
3 properties
MethodOptionsOrBuilder
object
13 properties
TriggeredBy
object
24 properties
PipelineAnnotationsResponseDTO
object
8 properties 8 required
ExpressionBlock
object
14 properties
RerunInfo
object
17 properties
EnumValueDescriptorProto
object
14 properties
ParserEnumValueOptions
object
ParserEnumDescriptorProto
object
GraphLayoutNode
object
This is the view of the Graph for execution of the Pipeline.
25 properties
ResponseDTOExecutionDataResponse
object
4 properties
MatrixMetadata
object
20 properties
ResponseDTOCustomPagePipelineExecutionOutline
object
4 properties
UnknownFieldSet
object
6 properties
ParserPipelineStageInfo
object
FilterWithOperatorNGTag
object
Generic filter with a list of items and an operator to combine them (AND or OR).
2 properties 2 required
EnumValueOptions
object
19 properties
ParserExecutableResponse
object
MethodDescriptorProto
object
19 properties
TemplateDescriptorProto
object
36 properties
FeatureSet
object
16 properties
InterruptConfig
object
2 properties 1 required
EnumValueDescriptor
object
8 properties
ExtensionRangeOptions
object
19 properties
ParserDeclaration
object
AdviserIssuer
object
1 property 1 required
ResponseDTOPagePipelineExecutionSummary
object
4 properties
InterruptEffectDTO
object
4 properties 4 required
ModulePropertiesDTO
object
Module-specific filter properties (e.g. CD service/environment filters, CI build event filters).
2 properties
ParserGovernanceMetadata
object
TriggerIssuer
object
2 properties 2 required
ParserAsyncExecutableResponse
object
Child
object
13 properties
EnumDescriptorProtoOrBuilder
object
18 properties
FeatureSupportOrBuilder
object
11 properties
CIExecutionInfoDTO
object
2 properties
EnumOptions
object
18 properties
EnumValueOptionsOrBuilder
object
15 properties
IdentityContextUpdateResponse
object
11 properties
EditionDefault
object
12 properties
FileDescriptor
object
12 properties
ValidationError
object
2 properties
OneofDescriptorProtoOrBuilder
object
10 properties
MessageOptions
object
20 properties
FileOptionsOrBuilder
object
40 properties
ParserFileOptions
object
ParserNodeRunInfo
object
ExecutionErrorInfo
object
11 properties
TaskExecutableResponse
object
19 properties
ChildChainExecutableResponseOrBuilder
object
13 properties
SyncExecutableResponse
object
13 properties
IdentityEntry
object
25 properties
PipelinePolicySetMetadataOrBuilder
object
27 properties
ParserStrategyMetadata
object
ParserIdentityEntry
object
ParserEnumReservedRange
object
ParserNamePart
object
ChildOrBuilder
object
10 properties
PagePipelineExecutionSummary
object
11 properties
NamePartOrBuilder
object
9 properties
AsyncChainExecutableResponse
object
22 properties
CvDeclaration
object
16 properties
ParserTaskExecutableResponse
object
AnnotationContentResponse
object
Full annotation content response
2 properties 2 required
ExtensionRangeOptionsOrBuilder
object
15 properties
ParserExecutionErrorInfo
object
ResponseDTOInputSetTemplateResponse
object
4 properties
Failure
object
This is Failure entity as defied in Harness
5 properties
MethodOptions
object
17 properties
ChildExecutableResponse
object
16 properties
FilterProperties
object
Properties of the Filter entity defined in Harness.
2 properties 1 required
PmsStepDetails
object
MessageLite
object
4 properties
HarnessIdApiConfigOrBuilder
object
8 properties
FieldOptions
object
31 properties
EnumReservedRange
object
11 properties
RetryExecutionMetadata
object
This gives the Parent and Root execution id of the Execution part of Retried Execution
6 properties
ExecutionNodeAdjacencyList
object
2 properties
ForMetadata
object
13 properties
ReservedRange
object
11 properties
EnumDescriptor
object
9 properties
TemplateReferenceSummary
object
23 properties
SourceCodeInfoOrBuilder
object
9 properties
PipelinePolicySetMetadata
object
30 properties
ChildrenExecutableResponse
object
18 properties
ParserIdentityExecutionContext
object
Parser
object
PolicyMetadataOrBuilder
object
28 properties
FailureInfoDTO
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-pipeline-execution-details-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness Pipeline Execution Details API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.