Backstage
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.
APIs
Backstage Catalog API
The Backstage Software Catalog REST API provides JSON-based endpoints for managing and querying catalog entities, locations, and related metadata. The catalog stores information...
Backstage Scaffolder API
The Backstage Scaffolder (Software Templates) REST API provides endpoints for creating, managing, and monitoring scaffolder tasks. It enables programmatic execution of software ...
Backstage Auth API
The Backstage Auth API provides endpoints for authenticating users and services with the Backstage backend. It supports multiple authentication providers (GitHub, Google, Okta, ...
Backstage TechDocs API
The Backstage TechDocs API provides endpoints for generating, publishing, and serving technical documentation for catalog entities. TechDocs uses MkDocs under the hood to render...
Backstage Search API
The Backstage Search API provides endpoints for querying the Backstage search index. It enables full-text search across all indexed content including catalog entities, TechDocs ...
Backstage Permissions API
The Backstage Permissions API provides endpoints for evaluating and managing authorization decisions within Backstage. It enables plugins to check whether a given user or servic...
Backstage Events System
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 sign...
Capabilities
Backstage Developer Portal
Unified developer portal workflow combining the Backstage Software Catalog, Scaffolder, TechDocs, Search, Auth, and Permissions APIs. Serves platform engineers and developers ma...
Run with NaftikoFeatures
Central inventory of all software components, APIs, resources, systems, domains, groups, and users.
Bootstrap new projects, services, and components from customizable templates.
Render and serve MkDocs-based technical documentation alongside catalog entities.
Extensible plugin architecture with 100+ open-source plugins for CI/CD, monitoring, cloud, and more.
Full-text search across catalog entities, TechDocs, and any other indexed content.
Policy-based authorization with conditional rules for resource-level access control.
Model ownership, dependencies, and API consumption relationships between services.
Use Cases
Build a unified portal for developers to discover services, read docs, and scaffold projects.
Maintain a complete, up-to-date inventory of all microservices, APIs, and infrastructure.
Accelerate new developer onboarding with self-service project scaffolding and documentation.
Track all internal and external APIs, their owners, and documentation in one place.
Integrations
Catalog ingestion from GitHub repos, GitHub Actions integration for CI/CD visibility.
Show on-call information and incident status on catalog entity pages.
Display Kubernetes workload status for catalog entities.
Show metrics and alerts for services directly in the catalog.
Display security vulnerability information for catalog entities.
Surface monitoring dashboards within Backstage.
Event Specifications
Backstage Events System
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 sign...
ASYNCAPI