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 Pipeline Step API

This contains APIs for Pipeline Plugin Inputs

Harness Pipeline Step 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 Step. 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 12 operations across 12 paths, and defines 22 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}.

12 operations 12 paths 22 schemas 2 GET10 POST

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
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Pipeline Step 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 12

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

Pipeline Step 12

This contains APIs for Pipeline Plugin Inputs

POST
/v1/dbops/custom-operations
CustomOperations
GetV1CustomOperations 1 param body → 200400403500
POST
/v1/dbops/failure-interrupt
Consume Failure Interrupt
ConsumeFailureInterrupt 1 param body → 204400403500
POST
/v1/dbops/flyway/custom-operations
FlywayCustomOperations
GetV1FlywayCustomOperations 2 params body → 200400403404500
POST
/v1/dbops/flyway/failure-interrupt
Consume Flyway Failure Interrupt
ConsumeFlywayFailureInterrupt 1 param body → 204400403500
POST
/v1/dbops/flyway/plugin-output-response
Consume Flyway Plugin Output Response
ConsumeV1FlywayStepPluginOutputResponse 1 param body → 204400403500
GET
/v1/dbops/plugin-capability
GetPluginCapability
GetV1PluginCapability 1 param → 200400500
POST
/v1/dbops/plugin-output-response
Consume Plugin Output Response
ConsumeV1StepPluginOutputResponse 1 param body → 204400403500
POST
/v1/dbops/schema-instance-metadata
GetSchemaInstanceMetadata
GetV1SchemaInstanceMetadata 1 param body → 200400403500
GET
/v1/orgs/{org}/projects/{project}/pipeline/{pipelineIdentifier}/status
Get pipeline status
V1GetPipelineExecutionStatus 6 params → 200400403404500
POST
/v1/step/flyway/plugin-inputs
CreateFlywayPluginInputs
CreateV1FlywayPluginInputs 1 param body → 200400403404500
POST
/v1/step/plugin-inputs
CreatePluginInputs
CreateV1StepPluginInputs 1 param body → 200400403404500
POST
/v1/step/plugin-response
ConsumePluginResponse
ConsumeV1StepPluginResponse 1 param body → 204400403500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are DBInstanceOut (16 properties), DBSchemaOut (15 properties), CustomOperationInput (7 properties), SchemaInstanceMetadataOutput (6 properties). Each schema is shown below with its type and property counts.

FlywayCommand
string
Type of the plugin command to run
MigrationType
string
DB Migration tool type
FlywayCustomOperations
string
Enum for custom operations supported
CustomOperationOutput
object
Output for custom property result
4 properties
DbOpsError
object
Error Response
1 property 1 required
SchemaInstanceMetadataOutput
object
output of schema-instance metadata
6 properties 6 required
FlywayCustomOperationOutput
object
Output for custom property result
2 properties
DBSchemaType
string
db schema type
DeployedChangeSets
object
1 property 1 required
ChangeLogScript
object
if schemaType is Script location of the changelog file after using a custom script to download
5 properties 4 required
CustomOperations
string
Enum for custom operations supported
PipelineExecutionMetadata
object
Pipeline execution details
3 properties 3 required
FlywayCustomOperationInput
object
Input for getting custom property result
5 properties 5 required
CommandExecutionStatus
string
PluginCapabilityOutput
object
Plugin capability check result
1 property 1 required
Command
string
Type of the plugin command to run
SchemaInstanceMetadataInput
object
Input for getting schema-instance metadata
4 properties 4 required
CustomOperationInput
object
Input for getting custom property result
7 properties 7 required
PipelineStatusOutput
object
Response body for Pipeline execution status
3 properties 3 required
DBSchemaOut
object
Database Schema Response
15 properties 8 required
Changelog
object
if schemaType is Repository location of the changelog file containing schema changes in a git repository. Provide connector for third-party git connectors, or…
5 properties 1 required
DBInstanceOut
object
Database Instance Response
16 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-pipeline-step-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 Pipeline Step 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.