Harness

Harness Pipeline Step API

This contains APIs for Pipeline Plugin Inputs

Documentation GitHub OpenAPI

Operations 12

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

POST /v1/dbops/custom-operations Run a custom operation for a database step · CustomOperations #

Ask an LLM

“How does a database DevOps step run a custom command against a schema?”

“What does a db step need to execute a custom operation on a database instance?”

Tell an agent

Run custom command {command} on schema {schema} for instance {instance}.

Execute custom db operation {command} for schema {schema} in project {project}.

POST /v1/dbops/failure-interrupt Report a failure interrupt for a DB step · Consume Failure Interrupt #

Ask an LLM

“How does a failed database step tell the pipeline which failure strategy to apply?”

“What gets sent when a db schema step hits a failure interrupt?”

Tell an agent

Record a {type} failure interrupt for schema {schema} in execution {execution}.

Send the failure interrupt for instance {instance} in stage execution {stage}.

POST /v1/dbops/flyway/custom-operations Run a custom Flyway operation for a DB step · FlywayCustomOperations #

Ask an LLM

“Can a Flyway database step run a custom command?”

“What does a Flyway step need to execute a custom operation on a schema?”

Tell an agent

Run Flyway command {command} on schema {schema} for instance {instance}.

Execute a custom Flyway operation {command} against database schema {schema}.

POST /v1/dbops/flyway/failure-interrupt Report a failure interrupt for a Flyway step · Consume Flyway Failure Interrupt #

Ask an LLM

“How does a failed Flyway step report a failure interrupt back to the pipeline?”

“Which identifiers does a Flyway failure interrupt require?”

Tell an agent

Tell the pipeline a Flyway migration on {schema} failed with interrupt {type} during run {execution}.

Send the Flyway failure interrupt for instance {instance} under parent {parent}.

POST /v1/dbops/flyway/plugin-output-response Submit Flyway plugin output for a step · Consume Flyway Plugin Output Response #

Ask an LLM

“How does the Flyway plugin send its step output back in chunks?”

“What marks the final chunk of Flyway plugin output?”

Tell an agent

Submit Flyway plugin output for schema {schema} in execution {execution}.

Post the last Flyway output chunk for stage execution {stage}.

GET /v1/dbops/plugin-capability Check DB plugin consolidated-execution support · GetPluginCapability #

Ask an LLM

“Does the database DevOps plugin support consolidated execution?”

“Which plugin capability is available for db step execution?”

Tell an agent

Check the DB plugin's capability for consolidated execution.

Tell me whether db steps can run in consolidated mode.

POST /v1/dbops/plugin-output-response Submit database plugin output for a step · Consume Plugin Output Response #

Ask an LLM

“How does a database step plugin page its output back to the pipeline?”

“What's the difference between the first and last page of plugin output?”

Tell an agent

Submit plugin output for schema {schema} in pipeline execution {execution}.

Post a page of db step output for instance {instance} in project {project}.

POST /v1/dbops/schema-instance-metadata Get metadata and images for a DB schema instance · GetSchemaInstanceMetadata #

Ask an LLM

“Which container images and metadata apply to a database schema instance?”

“What does a db step look up about a schema before running?”

Tell an agent

Get metadata for schema {schema} on instance {instance}.

Look up the images for db schema {schema} in project {project}.

GET /v1/orgs/{org}/projects/{project}/pipeline/{pipelineIdentifier}/status Get a pipeline execution's status · Get pipeline status #

Ask an LLM

“Is my pipeline run still going, or did it succeed or fail?”

“Can I check the status of one stage in a pipeline execution?”

Tell an agent

Get the status of execution {execution} of pipeline {pipeline} in {org}/{project}.

Check stage {stage} in run {execution} of pipeline {pipeline} in org {org}, project {project}.

POST /v1/step/flyway/plugin-inputs Build Flyway plugin inputs from step inputs · CreateFlywayPluginInputs #

Ask an LLM

“How are a Flyway step's inputs turned into plugin inputs?”

“Can Flyway plugin inputs include JWT auth?”

Tell an agent

Create Flyway plugin inputs for command {command} on schema {schema}.

Generate Flyway inputs for instance {instance} under parent {parent}.

POST /v1/step/plugin-inputs Build DB step plugin inputs from step inputs · CreatePluginInputs #

Ask an LLM

“How are a database step's inputs converted into plugin inputs?”

“Can I exclude the changelog file when generating db plugin inputs?”

Tell an agent

Convert step inputs into standard (non-Flyway) plugin inputs to run {command} against {schema}.

Generate db step plugin inputs for instance {instance} with directory {directory}.

POST /v1/step/plugin-response Submit a DB plugin's execution result · ConsumePluginResponse #

Ask an LLM

“How does a database plugin report its final execution status and logs?”

“What does a db step plugin send when it finishes running?”

Tell an agent

Submit the plugin result with status {status} for plan execution {plan}.

Report execution logs for schema {schema} in pipeline {pipeline}.

Harness Pipeline Step API

Operations 12

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification