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

Backstage Entity API

The Entity API from Backstage — 9 operation(s) for entity.

Backstage Entity API is one of 23 APIs that Backstage publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Entity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 12 operations across 9 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, /.

12 operations 9 paths 13 schemas 1 DELETE6 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1
Base URL
https://{backstageHost}/api/events
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Backstage Entity API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (JWT).

Paths & Operations 12

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

Entity 12
POST
/refresh
Refresh entity
RefreshEntity body → 200400default
GET
/entities
Get entities
GetEntities 6 params → 200400default
GET
/entities/by-uid/{uid}
Get entity by uid
GetEntityByUid 1 param → 200400default
DELETE
/entities/by-uid/{uid}
Delete entity by uid
DeleteEntityByUid 1 param → 204400default
GET
/entities/by-name/{kind}/{namespace}/{name}
Get entity by name
GetEntityByName 3 params → 200400default
GET
/entities/by-name/{kind}/{namespace}/{name}/ancestry
Get entity ancestry by name
GetEntityAncestryByName 3 params → 200400default
POST
/entities/by-refs
Get entities by refs
GetEntitiesByRefs 1 param body → 200400default
GET
/entities/by-query
Get entities by query
GetEntitiesByQuery 9 params → 200400default
POST
/entities/by-query
Query entities by predicate
QueryEntitiesByPredicate body → 200400default
GET
/entity-facets
Get entity facets
GetEntityFacets 2 params → 200400default
POST
/entity-facets
Query entity facets by predicate
QueryEntityFacetsByPredicate body → 200400default
POST
/validate-entity
Validate entity
ValidateEntity body → 200400

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are EntityMeta (10 properties), Entity (5 properties), EntityLink (4 properties), EntitiesQueryResponse (3 properties). Each schema is shown below with its type and property counts.

JsonObject
object
A type representing all allowed JSON object values.
EntityLink
object
A link to external information that is related to the entity.
4 properties 1 required
EntityAncestryResponse
object
2 properties 2 required
EntityFacet
object
2 properties 2 required
MapStringString
object
Construct a type with a set of properties K of type T
Entity
object
The parts of the format that's common to all versions/kinds of entity.
5 properties 3 required
EntitiesBatchResponse
object
1 property 1 required
EntityFacetsResponse
object
1 property 1 required
EntityMeta
object
Metadata fields common to all versions/kinds of entity.
10 properties 1 required
EntityRelation
object
A relation of a specific type to another entity in the catalog.
2 properties 2 required
Error
object
3 properties 2 required
NullableEntity
EntitiesQueryResponse
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

backstage-entity-api-openapi.yml Raw ↑

Other APIs Backstage publishes across the network.

Backstage Actions API
Backstage Authentication API
Backstage Authorization API
Backstage Documentation API
Backstage Locations API
Backstage Metadata API
Backstage Search API
Backstage Sync API
Backstage Tasks API
Backstage Templates API
Backstage Token Verification API
Backstage Autocomplete API
Where this information came from

This is an independent, third-party profile of Backstage Entity 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.