Harness

Harness Onboarding API

This contains APIs related to platform onboarding flows

GitHub OpenAPI

Operations 16

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 /ng/api/onboarding/execute Provision a Kubernetes service setup in one call · Provisions secrets, connectors, and a Kubernetes service (with GitHub manifest… #
Ask an LLM
“Can I create the secrets, connectors and Kubernetes service for onboarding in one request?”
“Does one declarative onboarding call set up a service with a Git manifest and Docker image?”
Tell an agent
Run declarative onboarding in project {project} with this context: {input}.
Provision secrets, connectors and a Kubernetes service for account {account} from {input}.
POST /ng/api/onboarding/kubeconfig/upload Upload a kubeconfig for onboarding · Upload and process a kubeconfig file for onboarding #
Ask an LLM
“Can I onboard my cluster by uploading a kubeconfig file?”
“What happens to a kubeconfig I upload during onboarding?”
Tell an agent
Upload kubeconfig file {file} for onboarding in account {account}.
Process kubeconfig {file} for project {project}.
GET /gateway/chaos/manager/api/rest/pipeline-onboarding List pipelines onboarded to chaos · List pipeline onboarding #
Ask an LLM
“Which of my pipelines have been onboarded to chaos engineering?”
“Where can I see all pipeline chaos onboarding entries in a project?”
Tell an agent
List pipeline chaos onboarding entries in project {project}.
Show every pipeline onboarded to chaos for account {account}.
POST /gateway/chaos/manager/api/rest/pipeline-onboarding Onboard a pipeline to chaos engineering · Onboard a pipeline to chaos #
Ask an LLM
“Can I add chaos experiments to an existing pipeline?”
“Is AI-assisted setup available when onboarding a pipeline to chaos?”
Tell an agent
Onboard pipeline {pipeline} to chaos in project {project}.
Onboard pipeline {pipeline} to chaos with AI enabled set to {ai}.
DELETE /gateway/chaos/manager/api/rest/pipeline-onboarding/{identity} Delete a pipeline chaos onboarding entry · Delete pipeline onboarding entry #
Ask an LLM
“Can I remove a pipeline's chaos onboarding record?”
“What is needed to undo onboarding a pipeline to chaos?”
Tell an agent destructive · confirm first
Delete the chaos onboarding entry {identity}.
Remove pipeline onboarding {identity} from project {project}.
GET /gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}/can-onboard-chaos Check whether a pipeline can be onboarded · Check if a pipeline can be onboarded or not #
Ask an LLM
“Is my pipeline eligible to be onboarded to chaos?”
“Can this pipeline take chaos experiments before I try onboarding it?”
Tell an agent
Check if pipeline {identity} can be onboarded to chaos.
Verify chaos onboarding eligibility for pipeline {identity} in project {project}.
GET /gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}/status Get a pipeline's chaos onboarding status · Check chaos onboarding status for the pipeline #
Ask an LLM
“Has my pipeline finished onboarding to chaos?”
“What stage is a pipeline's chaos onboarding in right now?”
Tell an agent
Get chaos onboarding status for pipeline {identity}.
Show how far pipeline {identity} is through chaos onboarding.
GET /gateway/chaos/manager/api/rest/v2/onboarding List chaos onboarding runs · Get V2 Onboarding #
Ask an LLM
“Which chaos onboarding runs exist in my project?”
“Can I search v2 chaos onboardings by name?”
Tell an agent
List chaos onboardings in project {project} matching {search}, page {page} of size {limit}.
Search v2 onboardings for {search}.
POST /gateway/chaos/manager/api/rest/v2/onboarding Start a chaos onboarding for an environment · Create V2 Onboarding #
Ask an LLM
“Can I start chaos onboarding against a specific environment and infrastructure?”
“Does chaos onboarding support an automatic mode and a manual mode?”
Tell an agent
Start chaos onboarding in {mode} mode for environment {env} on infrastructure {infra}.
Create a v2 onboarding using service account {sa} on infrastructure {infra}.
POST /gateway/chaos/manager/api/rest/v2/onboarding-confirm-discovery/{onboardingid} Confirm the discovery step of manual onboarding · Confirm discovery step in manual onboarding #
Ask an LLM
“How do I approve the service discovery step in a manual chaos onboarding?”
“Can I move a manual onboarding past discovery once I've checked it?”
Tell an agent
Confirm discovery for onboarding {onboarding}.
Approve the discovered services in manual onboarding {onboarding}.
POST /gateway/chaos/manager/api/rest/v2/onboarding-confirm-experiment-creation/{onboardingid} Confirm experiment creation in manual onboarding · Confirm experiment creation step in manual onboarding #
Ask an LLM
“Can I approve which chaos experiments get created during manual onboarding?”
“What confirms the experiment-creation step of a manual onboarding?”
Tell an agent
Confirm experiment creation for onboarding {onboarding}.
Approve creating experiments in onboarding {onboarding} using mode {mode}.
POST /gateway/chaos/manager/api/rest/v2/onboarding-confirm-experiment-run/{onboardingid} Confirm the experiment run in manual onboarding · Confirm experiment run step in manual onboarding #
Ask an LLM
“When onboarding manually, how do I give the go-ahead to run the experiments?”
“Can I trigger the experiment-run step of a manual onboarding?”
Tell an agent
Confirm the experiment run for onboarding {onboarding}.
Let onboarding {onboarding} run its chaos experiments.
POST /gateway/chaos/manager/api/rest/v2/onboarding-confirm-networkmap/{onboardingid} Confirm network map creation in onboarding · Confirm network map creation step in manual onboarding #
Ask an LLM
“Can I confirm the network map a manual chaos onboarding built?”
“What step accepts the network map during manual onboarding?”
Tell an agent
Confirm the network map for onboarding {onboarding}.
Accept network map creation in onboarding {onboarding} with mode {mode}.
GET /gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid} Get a chaos onboarding · Get V2 Onboarding #
Ask an LLM
“What is the current state of one chaos onboarding run?”
“Can I look up a single v2 onboarding by its ID?”
Tell an agent
Get chaos onboarding {onboarding}.
Show details of v2 onboarding {onboarding} in project {project}.
GET /gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}/experiments List experiments created by an onboarding · Get V2 Onboarding experiments #
Ask an LLM
“Which chaos experiments did an onboarding create?”
“Can I page through the experiments tied to one onboarding?”
Tell an agent
List experiments for onboarding {onboarding}, page {page} with {limit} per page.
Show the chaos experiments generated by onboarding {onboarding}.
POST /gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}/stop Stop experiments started by an onboarding · Stop V2 Onboarding experiments #
Ask an LLM
“Can I halt the chaos experiments an onboarding kicked off?”
“What stops all running experiments from one onboarding?”
Tell an agent destructive · confirm first
Stop the experiments of onboarding {onboarding}.
Halt every chaos experiment running under onboarding {onboarding}.

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-onboarding-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-onboarding-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-onboarding-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Harness Onboarding 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 (120 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-onboarding-api-openapi.yml