How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Harness

Harness Onboarding API

This contains APIs related to platform onboarding flows

Documentation Provider Profile APIs.io OpenAPI GitHub

Harness Onboarding API is one of 488 APIs that Harness publishes on the 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 API exposes 16 operations across 14 paths, and defines 71 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://app.harness.io, https://{vanity}.

16 operations 14 paths 71 schemas 1 DELETE6 GET9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://app.harness.io
Authentication
API Key
Contact
API Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Harness Onboarding API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

  • x-api-key — API key is a token provided while making the API calls. This is used to authenticate the client at the exposed endpoint.

Paths & Operations 16

Across 14 paths, the API surfaces 16 operations — 1 DELETE, 6 GET, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Onboarding 16

This contains APIs related to platform onboarding flows

POST
/ng/api/onboarding/execute
Provisions secrets, connectors, and a Kubernetes service (with GitHub manifest…
executeOnboarding 3 params body → 400500default
POST
/ng/api/onboarding/kubeconfig/upload
Upload and process a kubeconfig file for onboarding
uploadKubeConfig 3 params body → 400500default
GET
/gateway/chaos/manager/api/rest/pipeline-onboarding
List pipeline onboarding
listPipelineOnboarding 3 params → 200400404500
POST
/gateway/chaos/manager/api/rest/pipeline-onboarding
Onboard a pipeline to chaos
pipelineOnboardChaos 3 params body → 200400404500
DELETE
/gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}
Delete pipeline onboarding entry
deletePipelineOnboarding 4 params → 200400404500
GET
/gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}/can-onboard-chaos
Check if a pipeline can be onboarded or not
pipelineCanOnboardChaos 4 params → 200400404500
GET
/gateway/chaos/manager/api/rest/pipeline-onboarding/{identity}/status
Check chaos onboarding status for the pipeline
pipelineOnboardChaosStatus 4 params → 200400404500
GET
/gateway/chaos/manager/api/rest/v2/onboarding
Get V2 Onboarding
listV2Onboarding 7 params → 200400500
POST
/gateway/chaos/manager/api/rest/v2/onboarding
Create V2 Onboarding
createV2Onboarding 4 params body → 200400500
POST
/gateway/chaos/manager/api/rest/v2/onboarding-confirm-discovery/{onboardingid}
Confirm discovery step in manual onboarding
onboardingConfirmDiscovery 5 params → 200400500
POST
/gateway/chaos/manager/api/rest/v2/onboarding-confirm-experiment-creation/{onboardingid}
Confirm experiment creation step in manual onboarding
onboardingConfirmExperimentCreation 5 params body → 200400500
POST
/gateway/chaos/manager/api/rest/v2/onboarding-confirm-experiment-run/{onboardingid}
Confirm experiment run step in manual onboarding
onboardingConfirmExperimentRun 5 params → 200400500
POST
/gateway/chaos/manager/api/rest/v2/onboarding-confirm-networkmap/{onboardingid}
Confirm network map creation step in manual onboarding
onboardingConfirmNetworkMap 5 params body → 200400500
GET
/gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}
Get V2 Onboarding
getV2Onboarding 5 params → 200400500
GET
/gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}/experiments
Get V2 Onboarding experiments
getOnboardingExperiments 7 params → 200400500
POST
/gateway/chaos/manager/api/rest/v2/onboarding/{onboardingid}/stop
Stop V2 Onboarding experiments
stopOnboardingExperiments 5 params → 200400500

Schemas 71

The contract defines 71 schemas that model the data the API accepts and returns. The most detailed are OnboardingContext (38 properties), v2_onboarding.V2Onboarding (22 properties), pipelineonboarding.PipelineChaosOnboardingStatusResponse (20 properties), pipelineonboarding.PipelineOnboarding (19 properties). Each schema is shown below with its type and property counts.

v2_onboarding.V2OnboardingStatus
string
api.ResponseErrorCode
string
database.MTLSConfiguration
object
4 properties
v2_onboarding.RunSafeExperimentStatus
object
3 properties
v2_onboarding.AutoCreatedNetworkMapStatus
object
2 properties
v2_onboarding.Experiments
object
10 properties
KubeconfigUploadResponse
object
Result of a kubeconfig onboarding upload
2 properties
infra_v2.Env
object
4 properties
v2_onboarding.ChaosInfraAdvanceConfiguration
object
15 properties
pipelineonboarding.PipelineOnboarding
object
19 properties 2 required
OnboardingInput
object
Envelope carrying the onboarding context (extensible)
1 property
v2_onboarding.AgentData
object
2 properties
pipelineonboarding.InfrastructuresStatus
object
1 property
github_com_harness_hce-saas_graphql_server_api.Pagination
object
4 properties
ValidationError
object
2 properties
v2_onboarding.NetworkMapCreationMode
string
Error1
object
This is Error entity as defined in Harness
7 properties
ResponseMessage
object
7 properties
infra_v2.EnvValueFrom
string
v2_onboarding.OnboardingMode
string
v1.TolerationOperator
string
v2_onboarding.AgentDetails
object
2 properties
v2_onboarding.ConfirmNetworkMapRequest
object
1 property
v1.PullPolicy
string
OnboardingContext
object
Declarative context describing the resources to onboard
38 properties
infra_v2.MTLSConfiguration
object
4 properties
KubeconfigContextDescriptor
object
Per-context connector-creation hint reverse-engineered from a kubeconfig
9 properties
v2_onboarding.V2OnboardingRequest
object
7 properties 3 required
OnboardingExecuteResponse
object
Identifiers of the resources created during onboarding
10 properties
database.CronConfig
object
1 property
database.ProxyConfiguration
object
4 properties
api.RestError
object
3 properties
infra_v2.Volumes
object
2 properties
v2_onboarding.ConfirmDiscoveryResponse
object
3 properties
Failure
object
This is Failure entity as defied in Harness
5 properties
v1.TaintEffect
string
infra_v2.ProxyConfiguration
object
4 properties
pipelineonboarding.Status
string
v1.PodPhase
string
v2_onboarding.OnboardingExperimentResponse
object
3 properties
database.ResourceRequirements
object
2 properties
pipelineonboarding.PipelineChaosOnboardingCheckResponse
object
5 properties
v2_onboarding.OnboardingTargetExperiment
object
5 properties
v2_onboarding.TargetServiceDetails
object
2 properties
model.WorkflowRunStatus
string
v2_onboarding.ConfirmNetworkMapResponse
object
2 properties
v2_onboarding.TargetNetworkMapStatus
object
4 properties
database.DataCollectionConfiguration
object
9 properties
v1.Toleration
object
5 properties
v2_onboarding.V2Onboarding
object
22 properties 2 required
ErrorMetadata2
object
This implements different error meta data objects
1 property
v1.VolumeMount
object
6 properties
targetnetworkmap.ExperimentCreationMode
string
pipelineonboarding.SelectedExperiment
object
8 properties
OnboardingExecuteRequest
object
Top-level onboarding execute request
1 property
v2_onboarding.ConfirmExperimentRunResponse
object
1 property
targetnetworkmap.Status
string
pipelineonboarding.PipelineChaosOnboardingTaskRequest
object
4 properties
pipelineonboarding.PipelineChaosOnboardingStatusResponse
object
20 properties 2 required
database.KubernetesAgentConfiguration
object
13 properties
v2_onboarding.DiscoveredService
object
10 properties
v2_onboarding.V2OnboardingList
object
2 properties
pipelineonboarding.InfrastructureOnboardingMapping
object
4 properties
pipelineonboarding.ListPipelineOnboardingResponse
object
1 property
v2_onboarding.ConfirmExperimentCreationRequest
object
1 property
github_com_harness_hce-saas_graphql_server_api.Empty
object
pipelineonboarding.PipelineChaosOnboardingTaskResponse
object
v1.MountPropagationMode
string
v2_onboarding.ConfirmExperimentCreationResponse
object
2 properties
database.ResourceList
object
2 properties
database.AgentConfiguration
object
8 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-onboarding-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
AE Profile APIs.io
Harness Continuous Delivery and GitOps API
AE Profile APIs.io
Harness Feature Management and Experimentation API
AE Profile APIs.io
Harness Cloud Cost Management API
AE Profile APIs.io
Harness Chaos Engineering API
AE Profile APIs.io
Harness Security Testing Orchestration API
AE Profile APIs.io
Harness Internal Developer Portal API
AE Profile APIs.io
Harness Code Repository API
AE Profile APIs.io
Harness Service Reliability Management API
AE Profile APIs.io
Harness Infrastructure as Code Management API
AE Profile APIs.io
Harness Supply Chain Security API
AE Profile APIs.io
Harness Software Engineering Insights API
AE Profile APIs.io
#Onboarding
← Back to H APIs
API Details
ID
harness:harness-onboarding-api
Base URL
https://app.harness.io
Docs
https://apidocs.harness.io
Provider
Harness
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=harness-onboarding-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/harness-onboarding-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Harness Onboarding API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.