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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Backstage

Backstage Locations API

Endpoints for managing catalog locations (entity sources).

Documentation Provider Profile APIs.io OpenAPI GitHub

Backstage Locations API is one of 23 APIs that Backstage publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 8 operations across 5 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1.

Requests are made against a single base URL, /.

8 operations 5 paths 18 schemas 1 DELETE3 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

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

Paths & Operations 8

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

Locations 8
POST
/locations
Create location
CreateLocation 2 params body → 201400default
GET
/locations
Get locations
GetLocations → 200default
POST
/locations/by-query
Get locations by query
GetLocationsByQuery body → 200default
GET
/locations/{id}
Get location
GetLocation 1 param → 200default
PUT
/locations/{id}
Update location
UpdateLocation 1 param body → 200default
DELETE
/locations/{id}
Delete location
DeleteLocation 1 param → 204400default
GET
/locations/by-entity/{kind}/{namespace}/{name}
Get location by entity
getLocationByEntity 3 params → 200default
POST
/analyze-location
Analyze location
AnalyzeLocation body → 200400default

Schemas 18

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

AnalyzeLocationExistingEntity
object
If the folder pointed to already contained catalog info yaml files, they are read and emitted like this so that the frontend can inform the user that it locate…
3 properties 3 required
RecursivePartialEntityMeta
AnalyzeLocationResponse
object
2 properties 2 required
AnalyzeLocationGenerateEntity
object
This is some form of representation of what the analyzer could deduce. We should probably have a chat about how this can best be conveyed to the frontend. It'l…
2 properties 2 required
EntityLink
object
A link to external information that is related to the entity.
4 properties 1 required
JsonObject
object
A type representing all allowed JSON object values.
LocationsQueryResponse
object
3 properties 3 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
LocationSpec
object
Holds the entity location information.
2 properties 2 required
EntityMeta
object
Metadata fields common to all versions/kinds of entity.
10 properties 1 required
RecursivePartialEntity
object
Makes all keys of an entire hierarchy optional.
5 properties
EntityRelation
object
A relation of a specific type to another entity in the catalog.
2 properties 2 required
AnalyzeLocationEntityField
object
4 properties 4 required
Error
object
3 properties 2 required
LocationInput
object
2 properties 2 required
Location
object
Entity location for a specific entity.
4 properties 4 required
RecursivePartialEntityRelation
object
A relation of a specific type to another entity in the catalog.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

backstage-locations-api-openapi.yml Raw ↑

Other APIs Backstage publishes across the network.

Backstage Actions API
AE Profile APIs.io
Backstage Authentication API
AE Profile APIs.io
Backstage Authorization API
AE Profile APIs.io
Backstage Documentation API
AE Profile APIs.io
Backstage Metadata API
AE Profile APIs.io
Backstage Search API
AE Profile APIs.io
Backstage Sync API
AE Profile APIs.io
Backstage Tasks API
AE Profile APIs.io
Backstage Templates API
AE Profile APIs.io
Backstage Token Verification API
AE Profile APIs.io
Backstage Autocomplete API
AE Profile APIs.io
Backstage Bus API
AE Profile APIs.io
#Location
← Back to B APIs
API Details
ID
backstage:backstage-locations-api
Base URL
https://{backstageHost}/api/catalog
Docs
https://backstage.io/docs/features/software-catalog/software-catalog-api/
Provider
Backstage
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=backstage-locations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/backstage-locations-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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