Harness

Harness Experiments API

The Experiments API from Harness — 28 operation(s) for experiments.

GitHub OpenAPI

Operations 34

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

GET /gateway/chaos/manager/api/rest/chaos-experiment-run/report/{experimentRunId}/{notifyId} Get the report for a Kubernetes chaos experiment run · Generate and return kubernetesV1 chaos experiment run report #
Ask an LLM
“Can I pull a generated report for a finished kubernetesV1 chaos experiment run?”
“What does the run report for a Kubernetes chaos experiment contain once it completes?”
Tell an agent
Generate the Kubernetes chaos run report for run {run_id} with notify id {notify_id}.
Fetch the kubernetesV1 experiment run report for run {run_id} and notify id {notify_id} in project {project}.
GET /gateway/chaos/manager/api/rest/overview/experiment-stats Get chaos experiment run overview statistics · Get chaos experiment run overview stats #
Ask an LLM
“How many chaos experiment runs passed or failed over the last month?”
“Can I group chaos experiment run statistics over a time window?”
Tell an agent
Show chaos experiment run stats for project {project} between {start} and {end}.
Summarize experiment run counts grouped by {group_by}.
POST /gateway/chaos/manager/api/rest/v2/bulkaction/bulkexperimentdelete Delete several chaos experiments at once · Delete given experiments #
Ask an LLM
“Can I remove a batch of chaos experiments in one call instead of one by one?”
“Is there a bulk action to clean out old chaos experiments from a project?”
Tell an agent destructive · confirm first
Bulk delete chaos experiments {experiment_ids} from project {project}.
Remove all of these experiments in one go: {experiment_ids}.
POST /gateway/chaos/manager/api/rest/v2/bulkaction/bulkexperimenttagsadd Add tags to several chaos experiments · Add tags in given experiments #
Ask an LLM
“How do I tag many chaos experiments at the same time?”
“Can tags be applied to a batch of experiments in a single request?”
Tell an agent
Add tags {tags} to experiments {experiment_ids}.
Bulk tag the chaos experiments {experiment_ids} in project {project} with {tags}.
GET /gateway/chaos/manager/api/rest/v2/chaos-pipeline/step/{experimentId}/{experimentRunId}/{stepName} Get one step of a chaos pipeline execution · Get a chaos pipeline step execution #
Ask an LLM
“What happened in a specific step of a chaos pipeline run?”
“Can I inspect a single named step inside a chaos experiment's pipeline execution?”
Tell an agent
Show step {step} of run {run_id} for chaos experiment {experiment_id}.
Get the execution details of pipeline step {step} in experiment {experiment_id}, run {run_id}, project {project}.
GET /gateway/chaos/manager/api/rest/v2/chaos-pipeline/{experimentId} Get the pipeline execution of a chaos experiment run · Get a chaos pipeline execution #
Ask an LLM
“Where can I see the whole pipeline execution behind a chaos experiment run?”
“Which steps ran in the chaos pipeline for a given experiment run?”
Tell an agent
Get the chaos pipeline execution for experiment {experiment_id}, run {run_id}, notify id {notify_id}.
Show the full pipeline for run {run_id} of chaos experiment {experiment_id}.
GET /gateway/chaos/manager/api/rest/v2/experiment List chaos experiments in a project · List chaos v2 experiments #
Ask an LLM
“Which chaos experiments exist in my project?”
“Can I list chaos experiments targeting a particular infrastructure or with a given status?”
Tell an agent
List the chaos experiments in project {project}, page {page}, {limit} per page.
List chaos experiments on infrastructure {infra_id} with status {status}.
POST /gateway/chaos/manager/api/rest/v2/experiment Create or save a chaos experiment · Save a chaos v2 experiment #
Ask an LLM
“How do I create a new chaos experiment from a manifest?”
“Can I save a chaos experiment with a cron schedule so it runs automatically?”
Tell an agent
Save a chaos experiment named {name} on infrastructure {infra_id} using manifest {manifest}.
Create chaos experiment {name} scheduled with cron {cron}.
POST /gateway/chaos/manager/api/rest/v2/experiment-runs/csv Export chaos experiment runs as CSV · Download experiment runs as CSV #
Ask an LLM
“Can I download my chaos experiment run history as a spreadsheet?”
“Is there a CSV export of experiment runs for a time range?”
Tell an agent
Download experiment runs from {start} to {end} as CSV for account {account}.
Export a CSV of chaos runs matching {search}.
POST /gateway/chaos/manager/api/rest/v2/experiment/bulk/run Create a pipeline that runs experiments in bulk · Create pipeline to run experiments in bulk #
Ask an LLM
“Can I run several chaos experiments together through one generated pipeline?”
“What do I need to set up a bulk-run pipeline for chaos experiments?”
Tell an agent
Create a bulk-run pipeline named {name} with identifier {identifier} for experiments {spec}.
Build a pipeline in project {project} that runs these chaos experiments in bulk: {spec}.
POST /gateway/chaos/manager/api/rest/v2/experiment/cron Change the cron schedule of chaos experiments · Update a chaos v2 cron experiment #
Ask an LLM
“How do I change when a scheduled chaos experiment runs?”
“Can I enable or disable the cron schedule on several experiments at once?”
Tell an agent
Set the cron schedule of experiments {experiment_ids} to {cron}.
Apply cron action {action} to scheduled experiments {experiment_ids}.
DELETE /gateway/chaos/manager/api/rest/v2/experiment/{experimentId} Delete a chaos experiment · Delete a chaos v2 experiment #
Ask an LLM
“How do I permanently remove a single chaos experiment?”
“What happens to a chaos experiment when I delete it from the project?”
Tell an agent destructive · confirm first
Delete chaos experiment {experiment_id}.
Remove experiment {experiment_id} from project {project}.
POST /gateway/chaos/manager/api/rest/v2/experiment/{experimentId}/stop Stop a running chaos experiment · Stop a chaos v2 experiment #
Ask an LLM
“How do I halt a chaos experiment that is currently running?”
“Can I force-stop a chaos run that is stuck?”
Tell an agent destructive · confirm first
Stop run {run_id} of chaos experiment {experiment_id} with notify id {notify_id}.
Force stop experiment {experiment_id} run {run_id} (force={force}).
POST /gateway/chaos/manager/api/rest/v2/experiments Search experiments with filters and sorting · List experiments #
Ask an LLM
“Can I filter and sort experiments by workflow or identity in one query?”
“Which experiments match a set of identities I already have?”
Tell an agent
Search experiments in project {project} using filter {filter} sorted by {sort}.
Look up the experiments with identities {identities}.
GET /gateway/chaos/manager/api/rest/v2/experiments/timeline/run/{experimentId} Get the timeline of a chaos experiment run · Get a chaos v2 experiment timeline run #
Ask an LLM
“What is the step-by-step timeline of a chaos experiment run?”
“Can I see when each fault started and ended during a run?”
Tell an agent
Show the timeline for run {run_id} of experiment {experiment_id}.
Get the timeline view of the latest run of chaos experiment {experiment_id}.
GET /gateway/chaos/manager/api/rest/v2/experiments/{experimentId} Get a chaos experiment's definition · Get a chaos v2 experiment #
Ask an LLM
“What faults and infrastructure does a specific chaos experiment use?”
“Can I look up a chaos experiment by its ID?”
Tell an agent
Get chaos experiment {experiment_id}.
Show the definition of experiment {experiment_id} in project {project}.
GET /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets List input sets of a chaos experiment · Get the list of input sets in an experiment #
Ask an LLM
“Which input sets have been saved for a chaos experiment?”
“Can I page through all the input sets on one experiment?”
Tell an agent
List input sets for experiment {experiment_id}, page {page}, {limit} per page.
Show every saved input set on chaos experiment {experiment_id}.
POST /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets Create an input set for a chaos experiment · Create an input set #
Ask an LLM
“How do I save a reusable set of runtime inputs for a chaos experiment?”
“Can I store different input values to rerun an experiment with?”
Tell an agent
Create input set {name} on experiment {experiment_id} with spec {spec}.
Add a new input set with identity {identity} to chaos experiment {experiment_id}.
GET /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets/{inputsetId} Get one input set of a chaos experiment · Get the input set in an experiment #
Ask an LLM
“What values are stored in a particular input set of an experiment?”
“Can I view one experiment input set by its ID?”
Tell an agent
Get input set {inputset_id} of experiment {experiment_id}.
Show the spec saved in input set {inputset_id} for chaos experiment {experiment_id}.
PUT /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets/{inputsetId} Update an input set of a chaos experiment · Update an input set #
Ask an LLM
“How do I change the values in an existing experiment input set?”
“Can I rename an input set I already saved on an experiment?”
Tell an agent
Update input set {inputset_id} on experiment {experiment_id} with spec {spec}.
Rename input set {inputset_id} of experiment {experiment_id} to {name}.
DELETE /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/inputsets/{inputsetId} Delete an input set from a chaos experiment · Delete an input set #
Ask an LLM
“How do I get rid of an input set I no longer use on an experiment?”
“Does deleting an experiment input set remove it permanently?”
Tell an agent destructive · confirm first
Delete input set {inputset_id} from experiment {experiment_id}.
Remove saved inputs {inputset_id} on chaos experiment {experiment_id} in project {project}.
GET /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/run Get the result of a chaos experiment run · Get a chaos v2 experiment run #
Ask an LLM
“Did my last chaos experiment run pass or fail?”
“What is the resiliency score of a specific experiment run?”
Tell an agent
Get run {run_id} of chaos experiment {experiment_id}.
Show the outcome of the run with notify id {notify_id} for experiment {experiment_id}.
POST /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/run Run a chaos experiment · Run a chaos v2 experiment #
Ask an LLM
“How do I trigger a chaos experiment to run now?”
“Can I launch an experiment using a saved input set or runtime inputs?”
Tell an agent
Run chaos experiment {experiment_id}.
Start experiment {experiment_id} using input set {inputset}.
GET /gateway/chaos/manager/api/rest/v2/experiments/{experimentId}/variables Get the variables of a chaos experiment · Get a chaos v2 experiment #
Ask an LLM
“Which variables does a chaos experiment expect before it runs?”
“Can I see the runtime inputs an experiment needs?”
Tell an agent
List the variables of chaos experiment {experiment_id}.
Show which inputs experiment {experiment_id} requires in project {project}.
PATCH /gateway/chaos/manager/api/rest/v2/note Edit a note on a chaos experiment or run · Update a resource note #
Ask an LLM
“How do I edit a note I already left on a chaos run?”
“Can I change the comment on an existing experiment note?”
Tell an agent
Update note {note_id} to say {comment}.
Apply operation {operation} to note {note_id} on experiment {experiment_id}.
GET /gateway/chaos/manager/api/rest/v2/notes Read the notes on a chaos experiment or run · Get a chaos resource Note #
Ask an LLM
“What notes have been left on a chaos experiment run?”
“Can I read the comments attached to a GameDay run?”
Tell an agent
Show notes on experiment {experiment_id} run {run_id}.
Get the notes for GameDay run {gameday_run}.
POST /gateway/chaos/manager/api/rest/v2/notes Add a note to a chaos experiment or run · Add a resource note #
Ask an LLM
“How do I leave a comment on a chaos experiment run for my team?”
“Can I attach a note to a GameDay run?”
Tell an agent
Add note {comment} to run {run_id} of experiment {experiment_id}.
Post a new note {comment} on GameDay run {gameday_run} in project {project}.
POST /gateway/chaos/manager/api/rest/v2/pipeline/experiment/runs List chaos runs launched by a pipeline execution · List the experiment runs for a pipeline execution #
Ask an LLM
“Which chaos experiment runs did my pipeline execution trigger?”
“Can I map pipeline notify IDs back to their experiment runs?”
Tell an agent
List the experiment runs for pipeline notify ids {notify_ids}.
Show chaos runs triggered by pipelines in project {project} with notify ids {notify_ids}.
GET /gateway/chaos/manager/api/rest/v2/pipeline/verify/runs Verify the chaos stage of a pipeline run · Verify the chaos stage in pipeline run #
Ask an LLM
“Did the chaos stage in my pipeline execution actually run?”
“Can I check a specific stage of a pipeline run for chaos results?”
Tell an agent
Verify the chaos stage {stage} in execution {execution} of pipeline {pipeline}.
Check the chaos stage runs for pipeline execution {execution} in project {project}.
GET /gateway/chaos/manager/api/v1/notification-experiments List experiments on active infrastructure for notifications · List chaos experiments with active infrastructures in minimal format for… #
Ask an LLM
“Which experiments run on infrastructure that is currently active, in a minimal format?”
“What lightweight experiment list does the notification service use?”
Tell an agent
List experiments with active infrastructures in project {project} for notifications.
Get the minimal notification list of active-infra experiments named {name}.
GET /gateway/chaos/manager/api/v3/chaos-experiment-run/report/{experimentId}/{chaosExperimentRunId} Get the beta1 report for a chaos experiment run · Generate and return beta1 chaos experiment run report #
Ask an LLM
“Can I generate the newer beta1 report for one run of an experiment?”
“Where do I get a shareable report for a specific experiment run by experiment ID?”
Tell an agent
Generate the beta1 run report for experiment {experiment_id}, run {run_id}.
Produce the v3 PDF report for chaos run {run_id} of experiment {experiment_id}.
POST /gateway/chaos/manager/api/v3/experiments/list-metadata List metadata for experiments · List experiment metadata #
Ask an LLM
“Can I get just the metadata of experiments across all scopes?”
“What tags and names do my experiments carry, without full definitions?”
Tell an agent
List experiment metadata for identifiers {identifiers}.
Get experiment metadata tagged {tags} across all scopes for account {account}.
GET /gateway/chaos/manager/api/v3/integrations/get-experiment-or-template-variable Get the inputs of an experiment or template · Get experiment or template inputs #
Ask an LLM
“What inputs does an experiment template from a chaos hub require?”
“Can I fetch variables for either an experiment or a template in one call?”
Tell an agent
Get the inputs of template {identifier} from hub {hub}.
Show integration inputs for experiment {experiment_id} of kind {kind}.
GET /gateway/chaos/manager/api/v3/integrations/list-experiment-or-template List experiments or templates for integrations · List experiment or template metadata #
Ask an LLM
“Which experiment templates are available in a chaos hub for my infrastructure type?”
“Can integrations browse both experiments and templates in one list?”
Tell an agent
List experiment templates in hub {hub} for infrastructure type {infra_type}.
List integration items of kind {kind} matching {search} for account {account}.

Documentation

📖
Documentation
https://apidocs.harness.io
📖
APIReference
https://apidocs.harness.io
📖
GettingStarted
https://developer.harness.io/docs/platform/automation/api/api-quickstart/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/authentication/harness-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/rate-limits/harness-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-experiments-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/scopes/harness-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/errors/harness-error-codes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/conventions/harness-conventions.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/harness:harness-experiments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

harness-experiments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Experiments API
  version: '1.0'
  description: The Harness Software Delivery Platform uses OpenAPI Specification v3.0.
  contact:
    name: API Support
    email: contact@harness.io
    url: https://harness.io/
  x-logo:
    url: https://mma.prnewswire.com/media/779232/Harnes_logo_horizontal.jpg?p=facebook
    altText: Harness
  termsOfService: https://harness.io/terms-of-use/
servers:
- url: https://app.harness.io
  description: Harness host URL
- url: https://{vanity}
  description: Vanity URL
  variables:
    vanity:
      default: app.harness.io
security:
- x-api-key: []
tags:


# --- truncated at 32 KB (264 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-experiments-api-openapi.yml