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 Entities API

APIs for managing catalog Entities which represent the core components of your system. Entities can represent services, APIs, user groups, resources, and more. These endpoints allow you to create, retrieve, update, delete, and query entities across different scopes.

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

Tagged areas include Entities. 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 17 operations across 13 paths, and defines 29 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}.

17 operations 13 paths 29 schemas 1 DELETE7 GET7 POST2 PUT

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 Entities 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 17

Across 13 paths, the API surfaces 17 operations — 1 DELETE, 7 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Entities 17

APIs for managing catalog Entities which represent the core components of your system. Entities can represent services, APIs, user groups, resources, and more. These endpoints all…

POST
/v1/entities
Create an Entity
create-entity 5 params body → 201
GET
/v1/entities
Get Entities
get-entities 14 params → 200
POST
/v1/entities/bulk-field-update
Submit a bulk field update on catalog entities
submit-bulk-update-entity-field 1 param body → 202
GET
/v1/entities/bulk-field-update/{operation-id}
Get bulk field update operation status
get-bulk-update-entity-field-operation 2 params → 200
POST
/v1/entities/by-refs
Get entities by refs
get-entities-by-refs 13 params body → 200
POST
/v1/entities/import
Import an Entity from Git
import-entity 3 params body → 201
GET
/v1/entities/groups
Get Entities Groups
get-entities-groups 11 params → 200
POST
/v1/entities/move/{scope}/{kind}/{identifier}
Move an Entity
move-entity 6 params body → 201
PUT
/v1/entities/git-metadata/{scope}/{kind}/{identifier}
Update GitMetadata for Remote Entities
update-git-metadata 6 params body → 200
POST
/v1/entities/convert/{option}
Convert Entity Format
convert-entity 2 params body → 200
PUT
/v1/entities/{scope}/{kind}/{identifier}
Update an Entity
update-entity 6 params body → 200
DELETE
/v1/entities/{scope}/{kind}/{identifier}
Delete an Entity
delete-entity 6 params → 204
GET
/v1/entities/{scope}/{kind}/{identifier}
Get Entity Details
get-entity 11 params → 200
GET
/v1/entities/kinds
Get Entity Kinds
get-entities-kinds 4 params → 200
GET
/v1/entities/filters
Get Entity Filter Options
get-entities-filters 4 params → 200
POST
/v1/entities/filters
Get Entities Filters By Query
get-entities-filters-by-query 4 params body → 200
GET
/v1/entities/json-schema
Get Entity JSON Schema
get-json-schema 1 param → 200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are EntityResponse (26 properties), EntitiesGroups (12 properties), GitDetails1 (12 properties), GitUpdateDetails2 (10 properties). Each schema is shown below with its type and property counts.

GitMetadataUpdateRequest
object
4 properties
EntityUpdateRequest
object
Entity Update Request Body
2 properties 1 required
EntityRequest
object
Request body for creating or updating an Entity, containing the entity YAML definition as a string.
1 property 1 required
EntitiesGroups
object
Represents a group of entities organized by organization and project, providing a hierarchical view of entities within the system.
12 properties
EntityFilterQueryRequest
object
1 property
BulkFieldUpdateSubmitResponse
object
Returned on submit; carries the operationId to poll for status.
4 properties
EntityJsonSchemaResponse
object
JSON Schema for validating Entity definitions, which can be used for client-side validation before submitting entity operations.
EntityCreateRequest
object
Entity Create Request Body
2 properties 1 required
BulkFieldUpdateOperationResponse
object
Current status and result of an async bulk field update operation.
8 properties
EntityMoveRequest
object
Request body for moving an entity
2 properties 2 required
ScorecardFilter
object
5 properties 1 required
GitCreateDetails2
object
Contains parameters related to creating an Entity for Git Experience.
8 properties
BulkEntityFieldUpdateError
object
2 properties
BulkEntityFieldUpdateSkipped
object
2 properties
EntityConvertResponse
object
Result of converting an Entity between formats (Backstage to Harness or vice versa), containing the converted YAML definition.
1 property 1 required
EntityResponse
object
Detailed information about an Entity, including its metadata, relationships, and YAML representation.
26 properties 6 required
BulkEntityFieldUpdateRequest
object
Selects catalog entities by EITHER a filter OR a list of entityRefs (exactly one must be provided) and updates one or more allowlisted fields (each given as ke…
3 properties 1 required
EntitiesGroupsResponse
object
Entities organized in hierarchical groups based on account, organization, and project, along with count information for each level.
2 properties
GitMoveDetails1
object
Parameters related to moving an entity for Git Experience.
7 properties 4 required
GitUpdateDetails2
object
Contains parameters related to updating an Entity for Git Experience.
10 properties
EntityFiltersResponse
object
Filter options for Entities, including the filter name and its possible values. Used for building dynamic filter UIs.
2 properties
CacheResponseData
object
4 properties
GitImportDetails1
object
Parameters related to importing an entity for Git.
5 properties
EntityMoveOperationType
string
Operation type to move the entity
GitDetails1
object
Git Experience related details of the Entity.
12 properties
EntityKindsResponse
object
Information about an Entity Kind, including its display name, description, and the count of entities of this kind in the system.
4 properties
BulkFieldUpdateProperty
object
A single field to update, as a key/value pair with an optional write mode.
3 properties 2 required
EntitiesByRefsRequest
object
1 property
DefaultSaveResponse
object
Default response for Save/Edit operations
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

harness-entities-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 Entities 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.