Harness

Harness Triggers API

This contains APIs for performing CRUD operations on Triggers.

Documentation GitHub OpenAPI

Operations 14

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/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers Create a pipeline trigger (v1 API) · Create a Trigger #

Ask an LLM

“How do I add a trigger to a pipeline using the v1 org/project API?”

“Can a new trigger run only selected stages or use input sets?”

Tell an agent

Using the v1 API, create trigger {name} with identifier {identifier} on pipeline {pipeline} in project {project} of org {org}.

Add a v1 trigger {name} on pipeline {pipeline} that runs only stages {stages_to_execute}.

GET /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers/{trigger} Retrieve a pipeline trigger (v1 API) · Retrieve a Trigger #

Ask an LLM

“How do I read a trigger's definition through the v1 org/project path?”

“What does the v1 API return for a single pipeline trigger?”

Tell an agent

Using the v1 API, get trigger {trigger} on pipeline {pipeline} in project {project} of org {org}.

Show me v1 trigger {trigger} for pipeline {pipeline}.

PUT /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers/{trigger} Update a pipeline trigger (v1 API) · Update a Trigger #

Ask an LLM

“How do I edit a trigger through the v1 org/project API?”

“Can I disable a trigger by updating it through the v1 endpoint?”

Tell an agent

Using the v1 API, update trigger {trigger} on pipeline {pipeline} in project {project} of org {org}.

Set v1 trigger {trigger} on pipeline {pipeline} to enabled={enabled}.

DELETE /v1/orgs/{org}/projects/{project}/pipelines/{pipeline}/triggers/{trigger} Delete a pipeline trigger (v1 API) · Delete a Trigger #

Ask an LLM

“How do I remove a trigger using the v1 org/project path?”

“Can I delete a pipeline trigger with the v1 API?”

Tell an agent destructive · confirm first

Using the v1 API, delete trigger {trigger} from pipeline {pipeline} in project {project} of org {org}.

Remove v1 trigger {trigger} from pipeline {pipeline}.

GET /pipeline/api/triggers List triggers for a target pipeline · Gets the paginated list of triggers for accountIdentifier, orgIdentifier… #

Ask an LLM

“What triggers are set up on a pipeline, with paging and search?”

“Can I filter a pipeline's triggers by type, name or tag?”

Tell an agent

List triggers for pipeline {targetIdentifier} in project {projectIdentifier} of org {orgIdentifier}.

Search triggers on pipeline {targetIdentifier} matching {searchTerm}.

POST /pipeline/api/triggers Create a trigger with the pipeline service endpoint · Creates Trigger for triggering target pipeline identifier #

Ask an LLM

“How do I create a trigger for a target pipeline with the classic pipeline service API?”

“Is there a way to create a trigger even if its YAML has validation errors?”

Tell an agent

Create a trigger with the classic endpoint for pipeline {targetIdentifier} in project {projectIdentifier} of org {orgIdentifier}.

Create a classic trigger on pipeline {targetIdentifier} with ignoreError set to {ignoreError}.

POST /pipeline/api/triggers/v2 Create a trigger with an executor identity (v2) · Creates Trigger with executor identity in request body (v2 API) #

Ask an LLM

“Can I create a trigger that runs as a specific executor identity?”

“How do I send trigger YAML together with executor info when creating it?”

Tell an agent

Create a v2 trigger from YAML {yaml} on pipeline {targetIdentifier} in project {projectIdentifier} of org {orgIdentifier}.

Create a trigger on pipeline {targetIdentifier} that executes as {executorInfo}.

GET /pipeline/api/triggers/{triggerIdentifier} Get a trigger via the pipeline service · Gets the trigger by accountIdentifier, orgIdentifier, projectIdentifier… #

Ask an LLM

“How do I fetch a trigger by identifier from the classic pipeline service API?”

“What is stored in a trigger's record for a given target pipeline?”

Tell an agent

Get trigger {triggerIdentifier} on pipeline {targetIdentifier} in project {projectIdentifier} of org {orgIdentifier}.

Fetch the classic trigger record {triggerIdentifier}.

PUT /pipeline/api/triggers/{triggerIdentifier} Update a trigger via the pipeline service · Updates trigger for pipeline with target pipeline identifier #

Ask an LLM

“How do I update a trigger through the classic pipeline service endpoint?”

“Can I guard a trigger update with an If-Match version check?”

Tell an agent

Update classic trigger {triggerIdentifier} on pipeline {targetIdentifier} in project {projectIdentifier} of org {orgIdentifier}.

Update trigger {triggerIdentifier} only if its version matches {If-Match}.

DELETE /pipeline/api/triggers/{triggerIdentifier} Delete a trigger via the pipeline service · Deletes Trigger by identifier #

Ask an LLM

“How do I delete a trigger with the classic pipeline service API?”

“Can I delete a trigger only when it matches a known version?”

Tell an agent destructive · confirm first

Delete classic trigger {triggerIdentifier} from pipeline {targetIdentifier} in project {projectIdentifier} of org {orgIdentifier}.

Delete trigger {triggerIdentifier} if its version is {If-Match}.

GET /pipeline/api/triggers/catalog List the trigger types available in an account · Lists all Triggers #

Ask an LLM

“What kinds of triggers can I use in my Harness account?”

“Is there a catalog of supported trigger types, like webhook, artifact or cron?”

Tell an agent

Show the trigger catalog for account {accountIdentifier}.

List the trigger types my account supports.

GET /pipeline/api/triggers/{triggerIdentifier}/details Get a trigger's details and status · Fetches Trigger details for a specific accountIdentifier, orgIdentifier… #

Ask an LLM

“How can I see the details and last activity of a trigger beyond its YAML?”

“Where do I find the webhook details for a specific trigger?”

Tell an agent

Get details for trigger {triggerIdentifier} on pipeline {targetIdentifier} in project {projectIdentifier} of org {orgIdentifier}.

Show the full trigger details for {triggerIdentifier}.

GET /pipeline/api/triggers/{triggerIdentifier}/eventHistory Show the event history of a trigger · Get event history for a trigger #

Ask an LLM

“Why didn't my trigger fire? Can I see the events it received?”

“Can I search and page through a trigger's past events?”

Tell an agent

Show the event history for trigger {triggerIdentifier} on pipeline {targetIdentifier} in project {projectIdentifier} of org {orgIdentifier}.

Search trigger {triggerIdentifier}'s event history for {searchTerm}.

PUT /pipeline/api/triggers/{triggerIdentifier}/v2 Update a trigger with an executor identity (v2) · Updates trigger with executor identity in request body (v2 API) #

Ask an LLM

“How do I change which executor identity an existing trigger runs as?”

“Can I update trigger YAML and executor info together in one call?”

Tell an agent

Update trigger {triggerIdentifier} on pipeline {targetIdentifier} in project {projectIdentifier} of org {orgIdentifier} with v2 YAML {yaml}.

Make existing trigger {triggerIdentifier} execute as {executorInfo}.

Harness Triggers API

Operations 14

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification