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 Pipelines API

Manage pipelines

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

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

This API exposes 13 operations across 9 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

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

13 operations 9 paths 42 schemas 1 DELETE5 GET1 PATCH4 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/gateway
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Harness Pipelines API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). An API key is passed in the header as x-api-key (apiKeyAuth).

  • 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.
  • apiKeyAuth — Harness API key.

Paths & Operations 13

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

Pipelines 13

This contains APIs for performing CRUD operations on Pipelines.

GET
/v1/orgs/{org}/projects/{project}/pipelines
List Pipelines
list-pipelines 18 params → 200
POST
/v1/orgs/{org}/projects/{project}/pipelines
Create a Pipeline
create-pipeline 3 params body → 201
GET
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}
Retrieve a Pipeline
get-pipeline 11 params → 200
PUT
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}
Update a Pipeline
update-pipeline 4 params body → 200
DELETE
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}
Delete a Pipeline
delete-pipeline 4 params → 204400
PATCH
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}
Patch API for pipeline
patch-pipeline 4 params body → 200
POST
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/validate
Start a Pipeline Validation Event
start-pipeline-validation-event 9 params → 200
GET
/v1/orgs/{org}/projects/{project}/pipelines/validate/{uuid}
Get Pipeline Validation Result
get-pipeline-validate-result 4 params → 200
POST
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/move-config
Move Pipeline YAML from inline to remote
moveConfig 4 params body → 200
POST
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/import
Get Pipeline YAML from Git Repository
importPipelineFromGit 4 params body → 200
PUT
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/git-metadata
Update GitMetadata for Remote Pipelines
update-pipeline-git-metadata 4 params body → 200
GET
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/inputs-schema
Get inputs schema details
get-inputs-schema-details 7 params → 200
GET
/pipeline/api/pipelines
Harness List Pipelines
listPipelines 3 params → 200

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are PipelineGetResponseBody (16 properties), GovernanceMetadata1 (13 properties), PipelineListResponseBody (13 properties), PolicyMetadata (12 properties). Each schema is shown below with its type and property counts.

GitMoveDetails
object
Parameters related to moving an entity for Git Experience.
6 properties
GovernanceMetadata1
object
Information about the governance metadata
13 properties
YamlInputDependencyDetailsDTO
object
2 properties
PipelineYamlInputDetailsDTO
object
2 properties
PipelineImportRequestBody
object
Pipeline import request body
2 properties
PipelineYamlInputDTO
object
8 properties
PipelineValidationUUIDResponseBody
object
Contains the UUID of the Pipeline Validation Event that's started
1 property
InputDetailsPerFieldDTO
object
2 properties
PipelineMoveConfigResponseBody
object
Response body for configuration to move a pipeline
1 property
PolicyMetadata
object
Information about the policy metadata
12 properties
PipelineCreateResponseBody
object
Pipeline response body
1 property
ExecutorInfo
object
Information regarding Executor of Pipeline.
3 properties
CacheResponseMetadataDTO
object
4 properties
PipelineGetResponseBody
object
Pipeline response body.
16 properties
RecentExecutionInfo
object
Recent Execution information of the Pipeline.
7 properties
PipelineImportRequestDTO
object
Information of Pipeline import request DTO
2 properties
ParentStageInfo
object
Information about parent pipeline
7 properties
PipelineSaveResponseBody
object
Response body for pipeline save.
2 properties
TemplateValidationResponseBody
object
Has Template Resolution Response.
2 properties
MoveConfigOperationType
string
Operation type to move the configuration
YAMLSchemaErrorWrapper
object
YAML schema error.
6 properties
PipelineMoveConfigRequestBody
object
Request body for moving a pipeline configuration
3 properties
YamlInputType
PipelinePatchRequestBody
object
Pipeline Patch Request body (All the non empty values in this request body will be updated).
6 properties
PipelineCreateRequestBody
object
Pipeline request body object
6 properties 3 required
PolicySetMetadata
object
Information about the policy set metadata
10 properties
GitDetails
object
Git Experience related details of the Entity.
7 properties
PipelineUpdateRequestBody
object
Pipeline request body object
6 properties 3 required
PipelineValidationResponseBody
object
Pipeline Validation Response Body
5 properties
GitUpdateDetails
object
Contains parameters related to updating an Entity for Git Experience.
9 properties
PipelineInputSchemaDetailsResponseBody
object
1 property
GitMetadataUpdateResponseBody
object
1 property
GitMetadataUpdateRequestBody
object
3 properties
NodeInfo
object
Entity details
4 properties
GitCreateDetails
object
Contains parameters related to creating an Entity for Git Experience.
7 properties
PipelineListResponseBody
object
Pipeline List response body
13 properties
FixedValueFieldDependencyDetailsDTO
object
3 properties
GitImportInfo
object
Parameters related to importing an entity for Git.
5 properties
PipelineYamlInputMetadataDTO
object
2 properties
RuntimeInputDependencyDetailsDTO
object
2 properties
PipelineList
object
2 properties
Pipeline
object
A Harness pipeline.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-pipelines-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 Pipelines 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.