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

Harness Onboarding Resource API

Onboarding

Harness Onboarding Resource API is one of 488 APIs that Harness publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OnboardingResource. 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 4 operations across 4 paths, and defines 10 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}.

4 operations 4 paths 10 schemas 2 GET2 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
Terms of Service
Resource Areas
1

Authentication & Security 1

Harness Onboarding Resource 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 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

OnboardingResource 4

Onboarding

GET
/v1/onboarding/harness-entities
Get Harness Entities
get-harness-entities 7 params → 200
GET
/v1/onboarding/harness-entities-count
Get Harness Entities Count
get-harness-entities-count 1 param → 200
POST
/v1/onboarding/import-harness-entities
Import Harness Entities to IDP
import-harness-entities 1 param body → 200
POST
/v1/onboarding/generate-yaml
Generate YAML Definition for entity
onboarding-generate-yaml 1 param body → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are HarnessBackstageEntities (6 properties), CatalogConnectorInfo (4 properties), HarnessEntitiesCountResponse (3 properties), EntitiesForImport (2 properties). Each schema is shown below with its type and property counts.

ConnectorDetails
object
Connector details containing identifier and type
2 properties 2 required
CatalogConnectorInfo
object
Details of IDP catalog connector
4 properties 4 required
GenerateYamlResponse
object
Response contianing entity yaml definition and description about the entity
1 property 1 required
HarnessEntitiesCountResponse
object
Response for harness entities count that can be imported to IDP
3 properties 3 required
ImportEntitiesBase
object
Abstract base for import entities
2 properties 2 required
EntitiesForImport
object
Details of Harness Entities to import
2 properties 2 required
HarnessEntitiesResponse
object
Response for harness entities mapping with backstage entities
1 property 1 required
GenerateYamlRequest
object
Request to generate yaml for any one entity if provided or generate sample entity yaml definition
1 property 1 required
ImportEntitiesResponse
object
Response for import / save harness entities to IDP
1 property 1 required
HarnessBackstageEntities
object
Harness entities mapping with backstage entities
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-onboardingresource-api-openapi.yml Raw ↑

Other APIs Harness publishes across the network.

Harness Continuous Integration API
Harness Continuous Delivery and GitOps API
Harness Feature Management and Experimentation API
Harness Cloud Cost Management API
Harness Chaos Engineering API
Harness Security Testing Orchestration API
Harness Internal Developer Portal API
Harness Code Repository API
Harness Service Reliability Management API
Harness Infrastructure as Code Management API
Harness Supply Chain Security API
Harness Software Engineering Insights API
Where this information came from

This is an independent, third-party profile of Harness Onboarding Resource 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.