Harness

Harness Pipeline Execute API

This contains APIs for Executing a Pipeline

GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /pipeline/api/pipeline/execute/retryHistory/{planExecutionId} Get the retry history of an execution · Retry History for a given execution #
Ask an LLM
“How many times has a pipeline execution been retried?”
“Where can I see the earlier attempts of a retried run?”
Tell an agent
Show the retry history for execution {planExecutionId} of pipeline {pipelineIdentifier}.
List previous retry attempts of run {planExecutionId}.
PUT /pipeline/api/pipeline/execute/interrupt/{planExecutionId} Abort, pause or resume a pipeline run · Execute an Interrupt #
Ask an LLM
“How do I abort a running pipeline execution?”
“Can I pause and later resume a whole pipeline run?”
Tell an agent destructive · confirm first
Send interrupt {interruptType} to pipeline execution {planExecutionId}.
Abort the whole run {planExecutionId} with interrupt {interruptType}.
POST /pipeline/api/pipeline/execute/manual-execution/{nodeExecutionId} Fail or resume a manual intervention step · Marks the Manual Execution as fail or resume #
Ask an LLM
“What do I do when a step is waiting on manual intervention?”
“Can I mark a paused manual step as failed instead of resuming it?”
Tell an agent
Mark manual step {nodeExecutionId} as {action}.
Resume the manual intervention on node {nodeExecutionId} with action {action}.
PUT /pipeline/api/pipeline/execute/interrupt/{planExecutionId}/{nodeExecutionId} Interrupt a single stage of a run · Handles the interrupt for a given stage in a pipeline #
Ask an LLM
“Can I abort just one stage without stopping the rest of the pipeline?”
“Which interrupt types can be applied to an individual stage?”
Tell an agent destructive · confirm first
Send {interruptType} to stage {nodeExecutionId} in run {planExecutionId}.
Abort only stage node {nodeExecutionId} of execution {planExecutionId} using {interruptType}.
POST /pipeline/api/pipeline/execute/retry/{identifier} Retry a failed pipeline run · Retry a executed pipeline with inputSet pipeline yaml #
Ask an LLM
“How do I rerun a failed pipeline from the stages that failed?”
“Can I retry every stage instead of just the failed ones?”
Tell an agent
Retry pipeline {identifier} execution {planExecutionId} from stages {retryStages}.
Rerun execution {planExecutionId} of {identifier} starting at {retryStages}, with note {notesForPipelineExecution}.
POST /pipeline/api/pipeline/execute/retry/v2/{identifier} Retry a run with new runtime inputs (V2) · Retry a executed pipeline with Runtime Input YAML V2 #
Ask an LLM
“Can I change the runtime inputs when retrying a failed execution?”
“Is there a retry that also takes expression values?”
Tell an agent
Retry run {planExecutionId} of pipeline {identifier} at stages {retryStages} with runtime YAML {runtimeInputYaml}.
Use the V2 retry on {identifier} execution {planExecutionId} from {retryStages}, passing expression values {expressionValues}.
POST /pipeline/api/pipeline/execute/{identifier}/inputSetList Run a pipeline using saved input sets · Execute a Pipeline with Input Set References #
Ask an LLM
“Can I start a pipeline by referencing input sets I already saved?”
“What happens when several saved input sets are passed to one run?”
Tell an agent
Run pipeline {identifier} with input sets {inputSetReferences}.
Execute {identifier} on branch {branch} using saved input sets {inputSetReferences}.
POST /pipeline/api/pipeline/execute/{identifier} Run a pipeline with runtime input YAML · Execute a Pipeline with Runtime Input YAML #
Ask an LLM
“How do I trigger a pipeline run through the Harness API?”
“Can I add a note to a pipeline run when I start it?”
Tell an agent
Run pipeline {identifier} in project {projectIdentifier}.
Execute {identifier} from branch {branch} with note {notesForPipelineExecution}.
POST /pipeline/api/pipeline/execute/{identifier}/stages Run selected stages of a pipeline · Execute given Stages of a Pipeline #
Ask an LLM
“Can I run only some stages of a pipeline instead of the whole thing?”
“Is it possible to pass runtime inputs when running selected stages?”
Tell an agent
Run only stages {stageIdentifiers} of pipeline {identifier}.
Execute stages {stageIdentifiers} of {identifier} with runtime inputs {runtimeInputYaml}.

Documentation

📖
Documentation
https://apidocs.harness.io
📖
APIReference
https://apidocs.harness.io
📖
GettingStarted
https://developer.harness.io/docs/platform/automation/api/api-quickstart/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/authentication/harness-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/rate-limits/harness-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-pipeline-execute-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/scopes/harness-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/errors/harness-error-codes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/harness:harness-pipeline-execute-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

harness-pipeline-execute-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Pipeline Execute API
  version: '1.0'
  description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0.
  contact:
    name: API Support
    email: contact@harness.io
    url: https://harness.io/
  x-logo:
    url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook
    altText: Harness
  termsOfService: https://harness.io/terms-of-use/
servers:
- url: https://app.harness.io
  description: Harness host URL
- url: https://{vanity}
  description: Vanity URL
  variables:
    vanity:
      default: app.harness.io
security:
- x-api-key: []
tags:


# --- truncated at 32 KB (332 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-pipeline-execute-api-openapi.yml