Operations 13
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
Ask an LLM
“What pipelines exist in my Harness project?”
“Can I filter pipelines by service, environment or deployment type?”
Tell an agent
List the pipelines in project {project} of org {org}.
Find pipelines in {org}/{project} that deploy service {service_names}.
Ask an LLM
“How do I create a new pipeline from YAML?”
“Can I store a new pipeline in Git when I create it?”
Tell an agent
Create pipeline {name} with identifier {identifier} in {org}/{project} from YAML {pipeline_yaml}.
Add a new pipeline {identifier} to project {project} in org {org}.
Ask an LLM
“What does a specific pipeline's YAML look like?”
“Can I fetch a pipeline with its templates applied from a given Git branch?”
Tell an agent
Get pipeline {pipeline} in project {project} of org {org}.
Show pipeline {pipeline} in {org}/{project} from branch {branch_name}.
PUT
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}
Replace a pipeline's full definition · Update a Pipeline
#
Ask an LLM
“How do I overwrite a pipeline with a completely new YAML?”
“Does a full pipeline update require the name and identifier again?”
Tell an agent
Replace pipeline {pipeline} in {org}/{project} with YAML {pipeline_yaml}.
Fully update pipeline {pipeline} in project {project} of org {org}, keeping name {name}.
DELETE
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}
Delete a pipeline · Delete a Pipeline
#
Ask an LLM
“How do I delete a pipeline I no longer need?”
“Can a pipeline be removed from a project permanently?”
Tell an agent destructive · confirm first
Delete pipeline {pipeline} from project {project} in org {org}.
Remove the {pipeline} pipeline in {org}/{project}.
PATCH
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}
Partially update a pipeline · Patch API for pipeline
#
Ask an LLM
“Can I change just a pipeline's name or tags without resending all the YAML?”
“Is there a patch operation for pipelines?”
Tell an agent
Patch pipeline {pipeline} in {org}/{project} to rename it {name}.
Change only the tags of pipeline {pipeline} in project {project} of org {org} to {tags}.
POST
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/validate
Start validating a pipeline · Start a Pipeline Validation Event
#
Ask an LLM
“How do I kick off a validation check for a pipeline?”
“Can I validate the version of a pipeline stored on a specific Git branch?”
Tell an agent
Start a validation event for pipeline {pipeline} in {org}/{project}.
Validate pipeline {pipeline} in project {project} of org {org} on branch {branch_name}.
GET
/v1/orgs/{org}/projects/{project}/pipelines/validate/{uuid}
Get the result of a pipeline validation · Get Pipeline Validation Result
#
Ask an LLM
“Did my pipeline validation pass?”
“Where do I read the outcome of a validation event by its UUID?”
Tell an agent
Get the pipeline validation result for event {uuid} in {org}/{project}.
Check the outcome of validation {uuid} in project {project} of org {org}.
POST
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/move-config
Move a pipeline YAML from inline to Git · Move Pipeline YAML from inline to remote
#
Ask an LLM
“How do I move an inline pipeline into a Git repository?”
“Can I convert a pipeline stored in Harness into a remote one?”
Tell an agent
Move pipeline {pipeline} in {org}/{project} to Git using {git_details}.
Make inline pipeline {pipeline} in project {project} of org {org} a remote pipeline.
POST
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/import
Import a pipeline YAML from a Git repository · Get Pipeline YAML from Git Repository
#
Ask an LLM
“How do I import a pipeline that already lives in Git?”
“Can Harness create a pipeline record from a YAML file in my repo?”
Tell an agent
Import pipeline {pipeline} into {org}/{project} from Git with {git_import_info}.
Fetch pipeline {pipeline} YAML from the repo and save it in project {project} of org {org}.
PUT
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/git-metadata
Update Git metadata for a remote pipeline · Update GitMetadata for Remote Pipelines
#
Ask an LLM
“How do I repoint a remote pipeline to a different repo or file path?”
“Can I change the connector a Git-stored pipeline uses?”
Tell an agent
Point remote pipeline {pipeline} in {org}/{project} at file {file_path} in repo {repo_name}.
Set connector {connector_ref} on remote pipeline {pipeline} in project {project} of org {org}.
GET
/v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/inputs-schema
Get a pipeline's runtime inputs schema · Get inputs schema details
#
Ask an LLM
“What runtime inputs does a pipeline expect?”
“Can I see the input schema of a pipeline stored on a Git branch?”
Tell an agent
Get the inputs schema for pipeline {pipeline} in {org}/{project}.
Show runtime input details of pipeline {pipeline} in project {project} of org {org} on branch {branch_name}.
GET
/pipeline/api/pipelines
List pipelines via the pipeline service endpoint · Harness List Pipelines
#
Ask an LLM
“Is there a simple pipeline-service call that lists a project's pipelines by account, org and project IDs?”
“Which pipelines does the older /pipeline/api endpoint return for a project?”
Tell an agent
Using the pipeline service endpoint, list pipelines for account {accountIdentifier}, org {orgIdentifier}, project {projectIdentifier}.
Call the legacy pipeline list for project {projectIdentifier} in org {orgIdentifier}.