Harness

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.

Documentation GitHub OpenAPI

Operations 17

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v1/entities Create a catalog entity from YAML · Create an Entity #

Ask an LLM

“How do I register a new service in the catalog from its YAML definition?”

“Can I dry-run an entity creation to validate the YAML first?”

Tell an agent

Create a catalog entity from this YAML: {yaml}.

Dry-run creating an entity in project {project} with YAML {yaml}.

GET /v1/entities List catalog entities with filters · Get Entities #

Ask an LLM

“Which catalog entities do I own across my projects?”

“Can I filter the software catalog by kind, lifecycle or tags?”

Tell an agent

List catalog entities of kind {kind} owned by {owner}.

Show my favorite catalog entities with lifecycle {lifecycle}.

POST /v1/entities/bulk-field-update Bulk-update one field across catalog entities · Submit a bulk field update on catalog entities #

Ask an LLM

“Can I change the owner on many catalog entities at once?”

“Is there a way to update a single field on every entity matching a filter?”

Tell an agent

Bulk-update entities {entity_refs} with field change {properties}.

Submit a bulk field update of {properties} for all entities matching filter {filter}.

GET /v1/entities/bulk-field-update/{operation-id} Check a bulk field update's status · Get bulk field update operation status #

Ask an LLM

“Has my bulk owner change on the catalog finished yet?”

“Where can I see the result of a bulk field update I submitted?”

Tell an agent

Get the status of bulk field update operation {operation_id}.

Check whether bulk update {operation_id} succeeded.

POST /v1/entities/by-refs Fetch catalog entities by their refs · Get entities by refs #

Ask an LLM

“Can I look up several catalog entities at once from a list of entity references?”

“What's the way to fetch specific entities by ref while still applying filters?”

Tell an agent

Fetch catalog entities matching refs {entity_refs}.

Look up entities {entity_refs} and keep only those tagged {tags}.

POST /v1/entities/import Import a catalog entity from Git · Import an Entity from Git #

Ask an LLM

“Can I import an existing entity YAML file from a Git repo into the catalog?”

“Does importing an entity work with a Harness Code repository?”

Tell an agent

Import the entity at {file_path} in repo {repo} on branch {branch}.

Import a catalog entity from Git using connector {connector}.

GET /v1/entities/groups View catalog entities grouped by scope · Get Entities Groups #

Ask an LLM

“Can I see catalog entities organized by account, organization and project?”

“Which entities sit ungrouped at each level of my hierarchy?”

Tell an agent

Show catalog entities grouped by scope, filtered to kind {kind}.

Group my owned entities by organization and project.

POST /v1/entities/move/{scope}/{kind}/{identifier} Move an inline catalog entity to Git · Move an Entity #

Ask an LLM

“How do I move an inline catalog entity so it's stored in Git?”

“Can I convert an entity from inline storage to remote?”

Tell an agent

Move {kind} entity {identifier} in scope {scope} to remote using Git details {git_details}.

Move entity {identifier} from inline to remote with move type {move_type}.

PUT /v1/entities/git-metadata/{scope}/{kind}/{identifier} Update Git metadata for a remote entity · Update GitMetadata for Remote Entities #

Ask an LLM

“Can I point a remote catalog entity at a different repo or file path?”

“How do I change the branch recorded for an entity stored in Git?”

Tell an agent

Update Git metadata of {kind} entity {identifier} in scope {scope} to repo {repo}.

Change the Git file path of remote entity {identifier} to {file_path}.

POST /v1/entities/convert/{option} Convert entity YAML between Backstage and Harness · Convert Entity Format #

Ask an LLM

“Can I turn a Backstage catalog-info YAML into Harness entity format?”

“Is there a converter for entity definitions going the other way, Harness to Backstage?”

Tell an agent

Convert this entity YAML using option {option}: {yaml}.

Convert my Backstage YAML {yaml} to Harness format with option {option}.

PUT /v1/entities/{scope}/{kind}/{identifier} Replace a catalog entity's definition · Update an Entity #

Ask an LLM

“How do I overwrite an existing catalog entity with new YAML?”

“Will updating an entity create it if it doesn't exist yet?”

Tell an agent

Update {kind} entity {identifier} in scope {scope} with YAML {yaml}.

Replace the definition of entity {identifier} with {yaml}.

DELETE /v1/entities/{scope}/{kind}/{identifier} Permanently delete a catalog entity · Delete an Entity #

Ask an LLM

“Can I permanently remove a service from the software catalog?”

“What happens to references when a catalog entity is deleted?”

Tell an agent destructive · confirm first

Delete {kind} entity {identifier} in scope {scope}.

Permanently remove catalog entity {identifier}.

GET /v1/entities/{scope}/{kind}/{identifier} Get a catalog entity's full details · Get Entity Details #

Ask an LLM

“What do the full YAML and relationships of one catalog entity look like?”

“Can I read an entity's definition from a specific Git branch?”

Tell an agent

Get the details of {kind} entity {identifier} in scope {scope}.

Show entity {identifier} as stored on branch {branch}.

GET /v1/entities/kinds List supported entity kinds with counts · Get Entity Kinds #

Ask an LLM

“Which entity kinds does the catalog support, and how many of each exist?”

“Can I get display names and descriptions for all entity kinds?”

Tell an agent

List entity kinds and their counts for account {account}.

Show the entity kinds available in project {project}.

GET /v1/entities/filters Get the available entity filter options · Get Entity Filter Options #

Ask an LLM

“What filter values can I use when browsing the catalog?”

“Which owners and lifecycles show up as filters for a given kind?”

Tell an agent

Get catalog filter options for account {account}.

Show the available filter values for entity kind {kind}.

POST /v1/entities/filters Get filter options for a set of entity refs · Get Entities Filters By Query #

Ask an LLM

“Can I get filter options limited to a specific list of entity references?”

“Which filter values apply only to the entities I pass in?”

Tell an agent

Get filter options for entities {entity_refs} in account {account}.

Compute filter values scoped to refs {entity_refs}.

GET /v1/entities/json-schema Get the JSON Schema for entity definitions · Get Entity JSON Schema #

Ask an LLM

“Is there a JSON Schema I can use to validate entity YAML before submitting it?”

“Can I get validation rules for just one entity kind?”

Tell an agent

Get the entity JSON Schema for kind {kind}.

Fetch the JSON Schema for validating catalog entity definitions.

Harness Entities API

Operations 17

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification