Harness

Harness Pipeline Execution Details API

This contains APIs for fetching Pipeline Execution Details

GitHub OpenAPI

Operations 17

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/pipelines/execution/canRetry/{planExecutionId} Check whether a pipeline execution can be retried · Validate if Execution can be retried #
Ask an LLM
“Can this failed pipeline run be retried, or do I have to start a fresh execution?”
“Is there a way to validate retry eligibility before I hit retry on a Harness execution?”
Tell an agent
Check if execution {execution} in project {project} can be retried.
Validate retry eligibility for run {execution} in org {org}, project {project}, account {account}.
GET /pipeline/api/pipelines/execution/{planExecutionId}/annotations/{contextId}/content Fetch the full content of an execution annotation · Fetch Full Annotation Content #
Ask an LLM
“How do I read the complete text of an annotation that was truncated in the execution view?”
“Can I pull one annotation's full content by its context ID?”
Tell an agent
Get the full annotation content for context {context} on execution {execution} of pipeline {pipeline}.
Read the complete annotation {context} from run {execution}.
GET /pipeline/api/pipelines/execution/{planExecutionId} Get details of a pipeline execution · Fetch Execution Details #
Ask an LLM
“What happened in a given pipeline run — status, stages and timings?”
“Can I narrow execution details down to a single stage node?”
Tell an agent
Show the execution details for pipeline run {execution}.
Get details for run {execution} focused on stage node {stage}.
GET /pipeline/api/pipelines/execution/v2/{planExecutionId} Get execution details with child stage graph (v2) · Fetch Execution Details #
Ask an LLM
“How do I get execution details that include child stages of a chained pipeline?”
“Can the v2 execution details endpoint render the full bottom graph?”
Tell an agent
Get v2 execution details for run {execution} with the full bottom graph rendered.
Show v2 details of run {execution} for child stage node {child_stage}.
GET /pipeline/api/pipelines/execution/getExecutionGraph/{planExecutionId} Get the node graph of a pipeline execution · Fetch Execution Graph #
Ask an LLM
“Where can I get the full node-by-node execution graph for a pipeline run?”
“Can I retrieve the execution graph on its own without the rest of the summary?”
Tell an agent
Fetch the execution graph for plan execution {execution}.
Return the graph of nodes for run {execution} in project {project}.
GET /pipeline/api/pipelines/execution/subGraph/{planExecutionId}/{nodeExecutionId} Get the subgraph of a retried step group · Fetch Execution SubGraph for a Given Retried StepGroup NodeExecution ID #
Ask an LLM
“How do I see what ran inside a step group that was retried?”
“Can I fetch the subgraph for one retried step group node execution?”
Tell an agent
Get the subgraph for retried step group node {node} in execution {execution}.
Show the retried step group {node} breakdown for run {execution}.
POST /pipeline/api/pipelines/execution/url Get the UI link to a pipeline execution · Fetch Execution Url #
Ask an LLM
“How can I get a shareable link to a pipeline execution in the Harness UI?”
“What URL should I post in chat so teammates can open a specific run?”
Tell an agent
Get the execution URL for run {execution} of pipeline {pipeline}.
Give me a link to open execution {execution} of {pipeline} in project {project}.
GET /pipeline/api/pipelines/execution/{planExecutionId}/metadata Get metadata of a pipeline execution · Get execution metadata of a pipeline execution #
Ask an LLM
“What metadata is stored for a pipeline execution, like who triggered it?”
“Can I get just the execution metadata with only my account ID and the run ID?”
Tell an agent
Get the metadata for execution {execution} in account {account}.
Show the execution metadata record for run {execution}.
GET /pipeline/api/pipelines/execution/{planExecutionId}/inputsetV2 Get the input set YAML used by an execution · Get the Input Set YAML used for given Plan Execution #
Ask an LLM
“Which runtime inputs were used when this pipeline ran?”
“Can I see the input set YAML for a run with expressions resolved?”
Tell an agent
Show the input set YAML used for execution {execution}.
Get run {execution}'s inputs with expressions resolved in project {project}.
GET /pipeline/api/pipelines/execution/{planExecutionId}/policy-evaluation Get policy evaluations for a pipeline execution · Gets the policy evaluated used for given Plan Execution #
Ask an LLM
“Which OPA policies were evaluated against this pipeline run, and did they pass?”
“Can I page through the policy evaluation results for one execution?”
Tell an agent
Show the policy evaluations for execution {execution}.
List page {page} of the policy results from run {execution}.
POST /pipeline/api/pipelines/execution/executionSummary List pipeline execution identifiers · List Execution Identifier #
Ask an LLM
“How do I get just the IDs of executions for a pipeline, without the full summaries?”
“Can I pull execution identifiers filtered by a branch or repo?”
Tell an agent
List the execution identifiers for pipeline {pipeline} using filter type {filter_type}.
Get execution IDs on branch {branch} with filter type {filter_type}.
POST /pipeline/api/pipelines/execution/summary Search and list pipeline executions · List Executions #
Ask an LLM
“Which pipeline runs failed in a project this week?”
“Can I filter execution history by status, trigger type or pipeline tags?”
Tell an agent
List executions of pipeline {pipeline} with status {status}, filter type {filter_type}.
Search execution summaries for {term} using filter type {filter_type}.
POST /pipeline/api/pipelines/execution/summary/outline List a lightweight outline of executions · List Executions Outline #
Ask an LLM
“Is there a lighter-weight list of runs I can page through by last seen start time?”
“Can I get an outline of executions for a set of execution IDs?”
Tell an agent
Get the execution outline for pipeline {pipeline}.
Continue the execution outline after execution {last_seen}.
GET /pipeline/api/pipelines/execution/{planExecutionId}/notes Read the notes on a pipeline execution · Get Notes for a pipelineExecution #
Ask an LLM
“What notes did someone leave on this pipeline run?”
“Can I read execution notes with only the account and run ID?”
Tell an agent
Show the notes on execution {execution}.
Read the notes left on run {execution} in account {account}.
PUT /pipeline/api/pipelines/execution/{planExecutionId}/notes Update the notes on a pipeline execution · Updates Notes for a pipelineExecution #
Ask an LLM
“How do I add or change a note on a pipeline execution?”
“Can I record why a deployment was rolled back as a note on the run?”
Tell an agent
Set the notes on execution {execution} to {notes}.
Replace run {execution}'s note with {notes} in project {project}.
GET /pipeline/api/pipelines/execution/{planExecutionId}/annotations List annotations on a pipeline execution · Fetch Pipeline Execution Annotations #
Ask an LLM
“Which annotations were attached to steps during this pipeline run?”
“Can I list all annotations for an execution before opening one in full?”
Tell an agent
List the annotations on execution {execution} of pipeline {pipeline}.
Show every annotation summary for run {execution}.
GET /pipeline/api/pipelines/execution/{planExecutionId}/workflow-graph Get a workflow graph for visualizing an execution · Get workflow graph for visualization #
Ask an LLM
“How do I get a graph of an execution suitable for drawing a visualization?”
“Can I limit the workflow graph to a certain depth under one node?”
Tell an agent
Get the workflow visualization graph for execution {execution}.
Build the workflow graph for run {execution} from node {node} to depth {depth}.

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-execution-details-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-execution-details-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-execution-details-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Pipeline Execution Details 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 (339 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-pipeline-execution-details-api-openapi.yml