Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Harness Pipeline Execution API

Execute pipelines

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

Tagged areas include Pipeline Execution. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://app.harness.io/gateway.

1 operations 1 paths 2 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Server
https://app.harness.io/gateway
Authentication
API Key
Resource Areas
1

Authentication & Security 1

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

  • apiKeyAuth — Harness API key.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Pipeline Execution 1

Execute pipelines

POST
/pipeline/api/pipelines/execute/{pipelineIdentifier}
Harness Execute Pipeline
executePipeline 4 params body → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are PipelineExecution (2 properties), PipelineExecutionRequest (1 property). Each schema is shown below with its type and property counts.

PipelineExecution
object
A pipeline execution.
2 properties
PipelineExecutionRequest
object
Request to execute a pipeline.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Harness publishes across the network.

Harness Platform API
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