aid: backstage url: https://raw.githubusercontent.com/api-evangelist/backstage/refs/heads/main/apis.yml apis: - aid: backstage:events-system name: Backstage Events System tags: - Developer Portal - Event - Webhook tags_raw: - Developer Portal - Events - Webhooks humanURL: https://backstage.io/docs/plugins/backend-plugin baseURL: https://{backstageHost}/api/events properties: - type: OpenAPI url: openapi/backstage-events-backend-openapi.yaml name: Backstage Events API (first-party, plugins/events-backend/src/schema/openapi.yaml) - type: Overlay url: overlays/backstage-events-backend-overlay.yaml - type: Webhooks url: asyncapi/backstage-webhooks.yml - url: https://backstage.io/docs/plugins/backend-plugin type: Documentation - url: asyncapi/backstage-events-asyncapi.yml type: AsyncAPI description: >- The Backstage Events system provides a publish-subscribe mechanism for broadcasting and consuming events within a Backstage instance. It enables plugins to emit events when significant actions occur (such as catalog entity changes, scaffolder task completions, or permission policy updates) and allows other plugins or external systems to subscribe to those events via HTTP webhooks or the internal event bus. - aid: backstage:backstage-actions-api name: Backstage Actions API description: Endpoints for listing available scaffolder actions. humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Actions baseURL: https://{backstageHost}/api/scaffolder properties: - type: OpenAPI url: openapi/backstage-actions-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-authentication-api name: Backstage Authentication API description: The Authentication API from Backstage — 4 operation(s) for authentication. humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Authentication baseURL: https://{backstageHost}/api/auth properties: - type: OpenAPI url: openapi/backstage-auth-backend-openapi.yaml name: Backstage Auth API (first-party, docs/openapi/definitions/auth.yaml) - type: OpenAPI url: openapi/backstage-authentication-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-authorization-api name: Backstage Authorization API description: The Authorization API from Backstage — 2 operation(s) for authorization. humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Authorization baseURL: https://{backstageHost}/api/permission properties: - type: OpenAPI url: openapi/backstage-authorization-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-documentation-api name: Backstage Documentation API description: The Documentation API from Backstage — 2 operation(s) for documentation. humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Documentation baseURL: https://{backstageHost}/api/techdocs properties: - type: OpenAPI url: openapi/backstage-documentation-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-entities-api name: Backstage Entities API description: Endpoints for managing and querying catalog entities. humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Entities baseURL: https://{backstageHost}/api/catalog properties: - type: ToolCrosswalk url: mcp/backstage-tool-crosswalk.yml name: MCP tool to REST operation crosswalk - type: OpenAPI url: openapi/backstage-catalog-backend-openapi.yaml name: Backstage Software Catalog API (first-party, plugins/catalog-backend/src/schema/openapi.yaml) - type: Overlay url: overlays/backstage-catalog-backend-overlay.yaml - type: DataModel url: data-model/backstage-data-model.yml - type: OpenAPI url: openapi/backstage-entities-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-locations-api name: Backstage Locations API description: Endpoints for managing catalog locations (entity sources). humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Locations baseURL: https://{backstageHost}/api/catalog properties: - type: OpenAPI url: openapi/backstage-locations-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-metadata-api name: Backstage Metadata API description: The Metadata API from Backstage — 2 operation(s) for metadata. humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Metadata baseURL: https://{backstageHost}/api/techdocs properties: - type: OpenAPI url: openapi/backstage-metadata-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-search-api name: Backstage Search API description: The Search API from Backstage — 1 operation(s) for search. humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Search baseURL: https://{backstageHost}/api/search properties: - type: OpenAPI url: openapi/backstage-search-backend-openapi.yaml name: Backstage Search API (first-party, plugins/search-backend/src/schema/openapi.yaml) - type: Overlay url: overlays/backstage-search-backend-overlay.yaml - type: OpenAPI url: openapi/backstage-search-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-sync-api name: Backstage Sync API description: The Sync API from Backstage — 1 operation(s) for sync. humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Sync baseURL: https://{backstageHost}/api/techdocs properties: - type: OpenAPI url: openapi/backstage-sync-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-tasks-api name: Backstage Tasks API description: Endpoints for creating and managing scaffolder tasks. humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Task tags_raw: - Tasks baseURL: https://{backstageHost}/api/scaffolder properties: - type: OpenAPI url: openapi/backstage-scaffolder-backend-openapi.yaml name: Backstage Scaffolder API (first-party, plugins/scaffolder-backend/src/schema/openapi.yaml) - type: Overlay url: overlays/backstage-scaffolder-backend-overlay.yaml - type: OpenAPI url: openapi/backstage-tasks-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-templates-api name: Backstage Templates API description: Endpoints for template metadata and parameter schemas. humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Templates baseURL: https://{backstageHost}/api/scaffolder properties: - type: OpenAPI url: openapi/backstage-templates-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-token-verification-api name: Backstage Token Verification API description: The Token Verification API from Backstage — 1 operation(s) for token verification. humanURL: https://backstage.io/docs/features/software-catalog/software-catalog-api/ tags: - Token Verification baseURL: https://{backstageHost}/api/auth properties: - type: OpenAPI url: openapi/backstage-token-verification-api-openapi.yml - type: Documentation url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ - type: Documentation url: https://backstage.io/docs/features/software-templates/ - type: Documentation url: https://backstage.io/docs/auth/ - type: Documentation url: https://backstage.io/docs/features/techdocs/ - type: Documentation url: https://backstage.io/docs/features/search/ - type: Documentation url: https://backstage.io/docs/permissions/overview - aid: backstage:backstage-notifications-api name: Backstage Notifications API description: >- The Backstage Notifications API delivers user- and group-addressed notifications inside a Backstage portal. Plugins create notifications with a topic, severity and link; users list, read, mark and save them, manage per-topic delivery settings, and query unread status. It is served by @backstage/plugin-notifications-backend on the operator's own Backstage backend at /api/notifications, and the OpenAPI below is published first-party in the Backstage monorepo. humanURL: https://backstage.io/docs/notifications/ baseURL: https://{backstageHost}/api/notifications tags: - Notifications - Developer Portal properties: - type: OpenAPI url: openapi/backstage-notifications-backend-openapi.yaml name: Backstage Notifications API (first-party, plugins/notifications-backend/src/schema/openapi.yaml) - type: Overlay url: overlays/backstage-notifications-backend-overlay.yaml - type: Documentation url: https://backstage.io/docs/notifications/ - aid: backstage:backstage-dynamic-features-api name: Backstage Dynamic Feature Service API description: >- The Backstage dynamic feature service reports the dynamically loaded frontend and backend remotes present in a running Backstage instance. It is the introspection surface behind dynamic plugin loading, served by @backstage/backend-dynamic-feature-service at /api/.backstage/dynamic-features, and its OpenAPI is published first-party in the Backstage monorepo. humanURL: https://backstage.io/docs/backend-system/ baseURL: https://{backstageHost}/api/.backstage/dynamic-features tags: - Plugins - Developer Portal properties: - type: OpenAPI url: openapi/backstage-dynamic-features-openapi.yaml name: Backstage Dynamic Feature Service (first-party, packages/backend-dynamic-feature-service/src/schema/openapi.yaml) - type: Overlay url: overlays/backstage-dynamic-features-overlay.yaml - type: Documentation url: https://backstage.io/docs/backend-system/ name: Backstage tags: - Developer Portal - Internal Developer Platform - Software Catalog - Open-Source - Platform Engineering - Software Templates - CNCF tags_raw: - Developer Portal - Internal Developer Platform - Software Catalog - Open Source - Platform Engineering - Software Templates - CNCF type: Index deliveryModel: model: unknown open_source: unknown commercial: false callable_host: false label: Delivery model not determined — needs a product licence on record confidence: low source: - openapi - repository-unlicensed generated: '2026-08-28' method: derived accessModel: pricing: freemium onboarding: self-serve trial: false try_now: true public: false label: Freemium · Self-serve signup confidence: medium source: - plans - authentication - security generated: '2026-09-03' method: derived image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/backstage.png access: 3rd-Party common: - type: MCPServer url: mcp/backstage-mcp.yml name: Backstage MCP Actions Backend - type: Packages url: packages/backstage-packages.yml name: Backstage npm packages - type: SDKs url: packages/backstage-packages.yml name: Backstage first-party client libraries - type: WellKnown url: well-known/backstage-well-known.yml name: Well-known document probe - type: LLMsTxt url: llms/backstage-llms.txt name: Backstage llms.txt - type: AgentSkill url: skills/_index.yml name: Backstage published Agent Skills - type: Conformance url: conformance/backstage-conformance.yml name: Standards conformance - type: ErrorCatalog url: errors/backstage-problem-types.yml name: Backstage error catalog - type: Lifecycle url: lifecycle/backstage-lifecycle.yml name: Release and versioning lifecycle - type: Deprecation url: lifecycle/backstage-lifecycle.yml name: Backstage deprecation policy - type: OAuthScopes url: scopes/backstage-scopes.yml name: OAuth scopes for the MCP Actions endpoint - type: VulnerabilityDisclosure url: security/backstage-vulnerability-disclosure.yml name: Vulnerability disclosure program - type: Security url: security/backstage-vulnerability-disclosure.yml name: Backstage security policy - type: Sandbox url: sandbox/backstage-sandbox.yml name: Public demo instance and local sandbox - type: Conventions url: conventions/backstage-conventions.yml name: API conventions, dry-run and reversibility - type: ChangeLog url: changelog/backstage-changelog.yml name: Backstage changelog artifact - type: CLI url: cli/backstage-cli.yml name: Backstage CLI - type: Components url: components/backstage-components.yml name: Backstage UI component families - type: DataModel url: data-model/backstage-data-model.yml name: Software Catalog entity graph - type: Webhooks url: asyncapi/backstage-webhooks.yml name: Events plugin HTTP webhook ingress - type: Roadmap url: https://backstage.io/docs/overview/roadmap/ name: Backstage Roadmap - type: APIReference url: https://backstage.io/docs/features/software-catalog/software-catalog-api/ name: Software Catalog API reference - type: Support url: https://backstage.io/docs/overview/support name: Backstage Support - type: DeveloperPortal url: https://backstage.io/docs/ name: Backstage developer documentation portal - type: AgenticAccess url: agentic-access/backstage-agentic-access.yml - type: DomainSecurity url: security/backstage-domain-security.yml - type: Authentication url: authentication/backstage-authentication.yml - url: https://backstage.io/ name: Backstage Website type: Website - url: https://backstage.io/docs/ name: Backstage Documentation type: Documentation - url: https://backstage.io/docs/getting-started/ name: Backstage Getting Started type: GettingStarted - url: https://backstage.io/blog/ name: Backstage Blog type: Blog - url: https://github.com/backstage name: Backstage GitHub Organization type: GitHubOrganization - url: https://github.com/backstage/backstage name: Backstage GitHub Repository type: GitHubRepository - url: https://github.com/backstage/backstage/releases name: Backstage Releases type: ChangeLog - url: https://discord.gg/backstage-687207715902193673 name: Backstage Discord Community type: Community - url: https://backstage.io/plugins/ name: Backstage Plugin Directory type: Developer Tools - type: JSONSchema url: json-schema/backstage-entity-schema.json name: Backstage Entity JSON Schema - type: JSONLD url: json-ld/backstage-context.jsonld name: Backstage JSON-LD Context - type: SpectralRules url: rules/backstage-spectral-rules.yml - type: Vocabulary url: vocabulary/backstage-vocabulary.yaml - name: Features type: Features data: - name: Software Catalog description: Central inventory of all software components, APIs, resources, systems, domains, groups, and users. - name: Software Templates (Scaffolder) description: Bootstrap new projects, services, and components from customizable templates. - name: TechDocs description: Render and serve MkDocs-based technical documentation alongside catalog entities. - name: Plugin Ecosystem description: Extensible plugin architecture with 100+ open-source plugins for CI/CD, monitoring, cloud, and more. - name: Search description: Full-text search across catalog entities, TechDocs, and any other indexed content. - name: Permissions Framework description: Policy-based authorization with conditional rules for resource-level access control. - name: Entity Relations description: Model ownership, dependencies, and API consumption relationships between services. - name: UseCases type: UseCases data: - name: Internal Developer Portal description: Build a unified portal for developers to discover services, read docs, and scaffold projects. - name: Service Catalog description: Maintain a complete, up-to-date inventory of all microservices, APIs, and infrastructure. - name: Developer Onboarding description: Accelerate new developer onboarding with self-service project scaffolding and documentation. - name: API Governance description: Track all internal and external APIs, their owners, and documentation in one place. - name: Integrations type: Integrations data: - name: GitHub description: Catalog ingestion from GitHub repos, GitHub Actions integration for CI/CD visibility. - name: PagerDuty description: Show on-call information and incident status on catalog entity pages. - name: Kubernetes description: Display Kubernetes workload status for catalog entities. - name: Prometheus description: Show metrics and alerts for services directly in the catalog. - name: Snyk description: Display security vulnerability information for catalog entities. - name: Datadog description: Surface monitoring dashboards within Backstage. created: '2024-12-01' modified: '2026-09-04' position: Consuming description: >- Backstage is an open-source developer portal platform created by Spotify. It provides a centralized software catalog, software templates (scaffolder), TechDocs, and a plugin ecosystem for building customizable developer portals. Backstage helps organizations manage their software ecosystem by cataloging services, APIs, resources, and infrastructure, and provides tooling for creating new projects from templates. maintainers: - FN: Kin Lane email: kin@apievangelist.com specificationVersion: '0.23' x-enrichment: date: '2026-09-04' status: enriched artifacts_added: 43 pass: local-v3