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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Harness

Harness Pipeline Execute API

This contains APIs for Executing a Pipeline

Documentation Provider Profile APIs.io OpenAPI GitHub

Harness Pipeline Execute 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 Execute. 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 9 operations across 9 paths, and defines 253 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}.

9 operations 9 paths 253 schemas 1 GET6 POST2 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
Contact
API Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Harness Pipeline Execute 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 9

Across 9 paths, the API surfaces 9 operations — 1 GET, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Pipeline Execute 9

This contains APIs for Executing a Pipeline

GET
/pipeline/api/pipeline/execute/retryHistory/{planExecutionId}
Retry History for a given execution
retryHistory 5 params → 400500default
PUT
/pipeline/api/pipeline/execute/interrupt/{planExecutionId}
Execute an Interrupt
putHandleInterrupt 5 params → 400500default
POST
/pipeline/api/pipeline/execute/manual-execution/{nodeExecutionId}
Marks the Manual Execution as fail or resume
markManualExecution 4 params body → 400500default
PUT
/pipeline/api/pipeline/execute/interrupt/{planExecutionId}/{nodeExecutionId}
Handles the interrupt for a given stage in a pipeline
handleStageInterrupt 6 params → 400500default
POST
/pipeline/api/pipeline/execute/retry/{identifier}
Retry a executed pipeline with inputSet pipeline yaml
retryPipeline 10 params body → 400500default
POST
/pipeline/api/pipeline/execute/retry/v2/{identifier}
Retry a executed pipeline with Runtime Input YAML V2
retryPipelineV2 10 params body → 400500default
POST
/pipeline/api/pipeline/execute/{identifier}/inputSetList
Execute a Pipeline with Input Set References
postPipelineExecuteWithInputSetList 11 params body → 400500default
POST
/pipeline/api/pipeline/execute/{identifier}
Execute a Pipeline with Runtime Input YAML
postPipelineExecuteWithInputSetYaml 14 params body → 400500default
POST
/pipeline/api/pipeline/execute/{identifier}/stages
Execute given Stages of a Pipeline
postExecuteStages 12 params body → 400500default

Schemas 253

The contract defines 253 schemas that model the data the API accepts and returns. The most detailed are ExecutionMetadata (53 properties), ExecutionMetadataOrBuilder (50 properties), PullRequest (46 properties), FileOptions (44 properties). Each schema is shown below with its type and property counts.

ResponseDTOPlanExecutionResponse
object
4 properties
ParserMessageLite
object
UninterpretedOption
object
20 properties
Timestamp
object
11 properties
FieldDescriptor
object
26 properties
ParserBuildInfo
object
ParserLocation
object
BuildInfoOrBuilder
object
10 properties
FieldOptionsOrBuilder
object
27 properties
EnumValueDescriptorProtoOrBuilder
object
11 properties
ParserEnumValueDescriptorProto
object
BuildInfo
object
13 properties
PipelineEntityGitDetails
object
This contains Validity Details of the Entity
2 properties
DescriptorProtoOrBuilder
object
31 properties
ParserFieldDescriptorProto
object
ParserMergeQueueHook
object
CvDescriptorProto
object
36 properties
Location
object
19 properties
FailureTypeInfoOrBuilder
object
10 properties
Release
object
23 properties
FeatureSupport
object
14 properties
ReleaseOrBuilder
object
20 properties
ParserPolicyMetadata
object
ParserUser
object
ParserFeatureSupport
object
ExtensionRangeOrBuilder
object
10 properties
FailureInfo
object
17 properties
MessageOptionsOrBuilder
object
16 properties
TemplateDescriptorProtoOrBuilder
object
32 properties
OneofOptionsOrBuilder
object
11 properties
StagesExecutionMetadata
object
6 properties
FieldDescriptorProtoOrBuilder
object
23 properties
PullRequest
object
46 properties
Label
object
13 properties
PipelinePolicyMetadata
object
31 properties
RepositoryOrBuilder
object
27 properties
ReservedRangeOrBuilder
object
8 properties
Repository
object
30 properties
CvDescriptor
object
14 properties
ExtensionRange
object
13 properties
RetryExecutionInfo
object
14 properties
Level
object
30 properties
ParserManifestData
object
ExecutionPrincipalInfoOrBuilder
object
11 properties
ParserFileDescriptorProto
object
ForMetadataOrBuilder
object
10 properties
StepTypeOrBuilder
object
12 properties
Commit
object
19 properties
FileOptions
object
44 properties
ParserForMetadata
object
ParserFailureData
object
FailureTypeInfo
object
13 properties
ExecutionPrincipalInfo
object
14 properties
ParserReleaseHook
object
ResponseDTOManualExecutionResponse
object
4 properties
StepType
object
15 properties
OneofDescriptor
object
9 properties
PermOrBuilder
object
9 properties
RunStageRequest
object
Request Parameters needed to run specific Stages of a Pipeline
3 properties
ParserFailureInfo
object
ParserPolicySetMetadata
object
NamePart
object
12 properties
ManifestDataOrBuilder
object
8 properties
PipelineGovernanceMetadata
object
Full governance metadata including policy set details
33 properties
ParserReservedRange
object
PullRequestHook
object
17 properties
ParserEnumOptions
object
HarnessIdApiConfig
object
11 properties
ExecutionMetadataOrBuilder
object
50 properties
ParserLevel
object
ParserEditionDefault
object
ParserTriggeredBy
object
ServiceOptionsOrBuilder
object
12 properties
ServiceDescriptorProto
object
16 properties
ParserMatrixMetadata
object
ParserPerm
object
PullRequestHookOrBuilder
object
14 properties
ParsedPayloadOrBuilder
object
19 properties
RetryStagesMetadata
object
This has lists of retried and skipped stage identifiers
2 properties
ResponseDTORetryHistoryResponse
object
4 properties
FailureDataOrBuilder
object
22 properties
ParserMethodDescriptorProto
object
ParserOneofDescriptorProto
object
ParserMessageOptions
object
RetryExecutionInfoOrBuilder
object
11 properties
ParserTriggerPayload
object
DeclarationOrBuilder
object
13 properties
ServiceOptions
object
16 properties
PushHook
object
26 properties
UninterpretedOptionOrBuilder
object
17 properties
ArtifactDataOrBuilder
object
11 properties
ParserExecutionTriggerInfo
object
OneofOptions
object
15 properties
UserOrBuilder
object
20 properties
ServiceDescriptor
object
7 properties
MatrixMetadataOrBuilder
object
17 properties
BranchHook
object
17 properties
StrategyInfoOrBuilder
object
13 properties
ExecutionMetadata
object
53 properties
ParserRetryExecutionInfo
object
ParserExecutionPrincipalInfo
object
ExecutionTriggerInfo
object
18 properties
MergeQueueHook
object
19 properties
ParserExtensionRange
object
Perm
object
12 properties
TagHookOrBuilder
object
14 properties
ParserUninterpretedOption
object
ParserFieldOptions
object
ParserBranchHook
object
PushHookOrBuilder
object
23 properties
ResponseMessage
object
7 properties
StrategyMetadataOrBuilder
object
15 properties
FeatureSetOrBuilder
object
12 properties
ParserServiceOptions
object
Descriptor
object
14 properties
MethodDescriptor
object
11 properties
TagHook
object
17 properties
ParserOneofOptions
object
SourceCodeInfo
object
13 properties
LocationOrBuilder
object
16 properties
ManualExecutionRequest
object
Request for marking manual execution as fail or resume
1 property 1 required
FieldDescriptorProto
object
26 properties
ParserDescriptorProto
object
OneofDescriptorProto
object
13 properties
HeaderConfig
object
2 properties
EditionDefaultOrBuilder
object
9 properties
ParsedPayload
object
22 properties
Signature
object
19 properties
EnumReservedRangeOrBuilder
object
8 properties
CommitOrBuilder
object
16 properties
FileDescriptorProto
object
38 properties
PipelineErrorMetadata
object
This implements different error meta data objects
1 property
PostExecutionRollbackInfo
object
15 properties
IdentityExecutionContextOrBuilder
object
11 properties
ParserMethodOptions
object
MergeQueueHookOrBuilder
object
16 properties
ReleaseHook
object
17 properties
ParserExtensionRangeOptions
object
StrategyMetadata
object
18 properties
ParserServiceDescriptorProto
object
ReferenceOrBuilder
object
12 properties
ServiceDescriptorProtoOrBuilder
object
13 properties
StrategyInfo
object
16 properties
PipelineError
object
This is Error entity as defined in Harness
7 properties
ParserRerunInfo
object
Message
object
8 properties
ParserFeatureSet
object
MethodDescriptorProtoOrBuilder
object
16 properties
IdentityExecutionContext
object
14 properties
RerunInfoOrBuilder
object
14 properties
PipelineStageInfo
object
23 properties
ByteString
object
2 properties
TriggerPayload
object
30 properties
ParserMessage
object
ParserPostExecutionRollbackInfo
object
TriggeredByOrBuilder
object
21 properties
EnumOptionsOrBuilder
object
14 properties
RetryHistoryResponse
object
This is the view of the history of Retry Failed Pipelines.
4 properties
EnumDescriptorProto
object
21 properties
PullRequestOrBuilder
object
43 properties
ParserSourceCodeInfo
object
InterruptResponse
object
Contains the ID and type of the interrupt issued along with the execution id.
3 properties
MethodOptionsOrBuilder
object
13 properties
PlanExecution
object
26 properties
TriggeredBy
object
24 properties
RerunInfo
object
17 properties
EnumValueDescriptorProto
object
14 properties
ParserCommit
object
LabelOrBuilder
object
10 properties
ParserEnumValueOptions
object
ParserEnumDescriptorProto
object
ParserHarnessIdApiConfig
object
SignatureOrBuilder
object
16 properties
MatrixMetadata
object
20 properties
RetryPipelineRequest
object
Request Parameters for retrying a Pipeline execution
2 properties
UnknownFieldSet
object
6 properties
ParserPipelineStageInfo
object
EnumValueOptions
object
19 properties
MethodDescriptorProto
object
19 properties
TemplateDescriptorProto
object
36 properties
ParserParsedPayload
object
FeatureSet
object
16 properties
EnumValueDescriptor
object
8 properties
ExtensionRangeOptions
object
19 properties
PlanExecutionResponse
object
This contains info about the Pipeline Execution
2 properties
ParserDeclaration
object
MergeInputSetRequest
object
Contains list of Input Set references and Stage Ids
5 properties
ParserGovernanceMetadata
object
EnumDescriptorProtoOrBuilder
object
18 properties
ParserLabel
object
FeatureSupportOrBuilder
object
11 properties
ParserRepository
object
ParserSignature
object
EnumOptions
object
18 properties
EnumValueOptionsOrBuilder
object
15 properties
Ambiance
object
29 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
ParserExecutionMetadata
object
ParserFailureTypeInfo
object
IdentityEntry
object
25 properties
PipelinePolicySetMetadataOrBuilder
object
27 properties
ParserStrategyMetadata
object
ParserIdentityEntry
object
ParserEnumReservedRange
object
ParserNamePart
object
ParserTimestamp
object
ParserRelease
object
ManualExecutionResponse
object
This contains response for the API to mark the manual execution as fail or resume
1 property
NamePartOrBuilder
object
9 properties
CvDeclaration
object
16 properties
ParserPullRequestHook
object
ExtensionRangeOptionsOrBuilder
object
15 properties
FailureData
object
25 properties
PipelineStageInfoOrBuilder
object
20 properties
ResponseDTOInterruptResponse
object
4 properties
ParserStepType
object
Reference
object
15 properties
Failure
object
This is Failure entity as defied in Harness
5 properties
MethodOptions
object
17 properties
ParserStrategyInfo
object
ParserAmbiance
object
ParserReference
object
ReleaseHookOrBuilder
object
14 properties
BranchHookOrBuilder
object
14 properties
TimestampOrBuilder
object
8 properties
ExecutionInfo
object
This is the view for a particular Execution in Retry History
5 properties
ExecutionTriggerInfoOrBuilder
object
15 properties
ParserPullRequest
object
MessageLite
object
4 properties
HarnessIdApiConfigOrBuilder
object
8 properties
FieldOptions
object
31 properties
LevelOrBuilder
object
27 properties
PipelineUser
object
23 properties
EnumReservedRange
object
11 properties
ArtifactData
object
14 properties
ParserArtifactData
object
ForMetadata
object
13 properties
ManifestData
object
11 properties
ParserPushHook
object
ReservedRange
object
11 properties
EnumDescriptor
object
9 properties
SourceCodeInfoOrBuilder
object
9 properties
PipelinePolicySetMetadata
object
30 properties
ParserTagHook
object
ParserIdentityExecutionContext
object
Parser
object
PolicyMetadataOrBuilder
object
28 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-pipeline-execute-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
AE Profile APIs.io
Harness Continuous Delivery and GitOps API
AE Profile APIs.io
Harness Feature Management and Experimentation API
AE Profile APIs.io
Harness Cloud Cost Management API
AE Profile APIs.io
Harness Chaos Engineering API
AE Profile APIs.io
Harness Security Testing Orchestration API
AE Profile APIs.io
Harness Internal Developer Portal API
AE Profile APIs.io
Harness Code Repository API
AE Profile APIs.io
Harness Service Reliability Management API
AE Profile APIs.io
Harness Infrastructure as Code Management API
AE Profile APIs.io
Harness Supply Chain Security API
AE Profile APIs.io
Harness Software Engineering Insights API
AE Profile APIs.io
#Pipeline Execute
← Back to H APIs
API Details
ID
harness:harness-pipeline-execute-api
Base URL
https://app.harness.io
Docs
https://apidocs.harness.io
Provider
Harness
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=harness-pipeline-execute-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/harness-pipeline-execute-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Harness Pipeline Execute 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.