CatalogApi

Home > @backstage/catalog-client > CatalogApi

A client for interacting with the Backstage software catalog through its API.

Signature:

export interface CatalogApi 

Methods

Method	Description
addLocation(location, options)	Registers a new location.
getEntities(request, options)	Lists catalog entities.
getEntitiesByRefs(request, options)	Gets a batch of entities, by their entity refs.
getEntityAncestors(request, options)	Gets entity ancestor information, i.e. the hierarchy of parent entities whose processing resulted in a given entity appearing in the catalog.
getEntityByRef(entityRef, options)	Gets a single entity from the catalog by its ref (kind, namespace, name) triplet.
getEntityFacets(request, options)	Gets a summary of field facets of entities in the catalog.
getLocationByEntity(entityRef, options)	Gets a location associated with an entity.
getLocationById(id, options)	Gets a registered location by its ID.
getLocationByRef(locationRef, options)	Gets a registered location by its ref.
queryEntities(request, options)	Gets paginated entities from the catalog.
refreshEntity(entityRef, options)	Refreshes (marks for reprocessing) an entity in the catalog.
removeEntityByUid(uid, options)	Removes a single entity from the catalog by entity UID.
removeLocationById(id, options)	Removes a registered Location by its ID.
validateEntity(entity, locationRef, options)	Validate entity and its location.