# Harness Onboarding API

**Canonical:** https://apis.io/apis/harness/harness-onboarding-api/  
**Provider:** Harness — https://apis.io/providers/harness/  
**Base URL:** https://app.harness.io  
**Documentation:** https://apidocs.harness.io

Harness Onboarding API is one of 488 APIs that [Harness](https://apis.io/providers/harness/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Onboarding. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and rate-limit docs.

This contains APIs related to platform onboarding flows

## Operations (16)

| Method | Path | Summary |
|---|---|---|
| POST | `/ng/api/onboarding/execute` | Provisions secrets, connectors, and a Kubernetes service (with GitHub manifest… |
| POST | `/ng/api/onboarding/kubeconfig/upload` | Upload and process a kubeconfig file for onboarding |
| GET | `/gateway/chaos/manager/api/rest/pipeline-onboarding` | List pipeline onboarding |
| POST | `/gateway/chaos/manager/api/rest/pipeline-onboarding` | Onboard a pipeline to chaos |
| DELETE | `/gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}` | Delete pipeline onboarding entry |
| GET | `/gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}/can-onboard-chaos` | Check if a pipeline can be onboarded or not |
| GET | `/gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}/status` | Check chaos onboarding status for the pipeline |
| GET | `/gateway/chaos/manager/api/rest/v2/onboarding` | Get V2 Onboarding |
| POST | `/gateway/chaos/manager/api/rest/v2/onboarding` | Create V2 Onboarding |
| POST | `/gateway/chaos/manager/api/rest/v2/onboarding-confirm-discovery/{onboardingid}` | Confirm discovery step in manual onboarding |
| POST | `/gateway/chaos/manager/api/rest/v2/onboarding-confirm-experiment-creation/{onboardingid}` | Confirm experiment creation step in manual onboarding |
| POST | `/gateway/chaos/manager/api/rest/v2/onboarding-confirm-experiment-run/{onboardingid}` | Confirm experiment run step in manual onboarding |
| POST | `/gateway/chaos/manager/api/rest/v2/onboarding-confirm-networkmap/{onboardingid}` | Confirm network map creation step in manual onboarding |
| GET | `/gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}` | Get V2 Onboarding |
| GET | `/gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}/experiments` | Get V2 Onboarding experiments |
| POST | `/gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}/stop` | Stop V2 Onboarding experiments |

## Machine-readable artifacts (10)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/openapi/harness-onboarding-api-openapi.yml
- **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
- **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
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/rate-limits/harness-rate-limits.yml

## Other Harness APIs (12)

- [Harness Continuous Integration API](https://apis.io/apis/harness/ci-api/)
- [Harness Continuous Delivery and GitOps API](https://apis.io/apis/harness/cd-api/)
- [Harness Feature Management and Experimentation API](https://apis.io/apis/harness/feature-flags-api/)
- [Harness Cloud Cost Management API](https://apis.io/apis/harness/ccm-api/)
- [Harness Chaos Engineering API](https://apis.io/apis/harness/chaos-api/)
- [Harness Security Testing Orchestration API](https://apis.io/apis/harness/sto-api/)
- [Harness Internal Developer Portal API](https://apis.io/apis/harness/idp-api/)
- [Harness Code Repository API](https://apis.io/apis/harness/code-repo-api/)
- [Harness Service Reliability Management API](https://apis.io/apis/harness/srm-api/)
- [Harness Infrastructure as Code Management API](https://apis.io/apis/harness/iacm-api/)
- [Harness Supply Chain Security API](https://apis.io/apis/harness/ssca-api/)
- [Harness Software Engineering Insights API](https://apis.io/apis/harness/sei-api/)

## Tags

Onboarding

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/harness/harness-onboarding-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/harness/.