# Harness Entities API

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

Harness Entities 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 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.

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.

## Operations (17)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/entities` | Create an Entity |
| GET | `/v1/entities` | Get Entities |
| POST | `/v1/entities/bulk-field-update` | Submit a bulk field update on catalog entities |
| GET | `/v1/entities/bulk-field-update/{operation-id}` | Get bulk field update operation status |
| POST | `/v1/entities/by-refs` | Get entities by refs |
| POST | `/v1/entities/import` | Import an Entity from Git |
| GET | `/v1/entities/groups` | Get Entities Groups |
| POST | `/v1/entities/move/{scope}/{kind}/{identifier}` | Move an Entity |
| PUT | `/v1/entities/git-metadata/{scope}/{kind}/{identifier}` | Update GitMetadata for Remote Entities |
| POST | `/v1/entities/convert/{option}` | Convert Entity Format |
| PUT | `/v1/entities/{scope}/{kind}/{identifier}` | Update an Entity |
| DELETE | `/v1/entities/{scope}/{kind}/{identifier}` | Delete an Entity |
| GET | `/v1/entities/{scope}/{kind}/{identifier}` | Get Entity Details |
| GET | `/v1/entities/kinds` | Get Entity Kinds |
| GET | `/v1/entities/filters` | Get Entity Filter Options |
| POST | `/v1/entities/filters` | Get Entities Filters By Query |
| GET | `/v1/entities/json-schema` | Get Entity JSON Schema |

## Machine-readable artifacts (10)

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

Entities

---

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