# Spotify for Backstage

- [Spotify Portal for Backstage](https://backstage.spotify.com/docs/portal/index.md): Documentation for Spotify Portal for Backstage — a managed, no-code internal developer portal built on Backstage.
- [Getting Started Guide](https://backstage.spotify.com/docs/portal/getting-started.md): Set up your Portal instance by configuring your domain, connecting an identity provider like GitHub, Okta, or Entra ID, and completing initial onboarding.
- [AWS Marketplace](https://backstage.spotify.com/docs/portal/aws-marketplace.md): Subscribe to Spotify Portal through AWS Marketplace to simplify procurement, consolidate billing, and draw down on your existing AWS committed spend.
- [Portal Features & Plugins](https://backstage.spotify.com/docs/portal/core-features-and-plugins/index.md): Navigate Portal core features and plugins including Catalog, TechDocs, Scaffolder, Soundcheck, Search, RBAC, Insights, and third-party integrations.
- [Software Catalog Overview](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/index.md): Track ownership and metadata for all software in your ecosystem — services, libraries, data pipelines, and more — with Portal-managed or YAML-managed ingestion.
- [Creating the Catalog Graph](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/creating-the-catalog-graph.md): Understand how the catalog graph is built from entities, kinds, relations, specs, types, and annotations to model your software ecosystem.
- [Descriptor Format of Catalog Entities](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/descriptor-format.md): Documentation on Descriptor Format of Catalog Entities which describes the default data shape and semantics of catalog entities
- [Life of an Entity](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/life-of-an-entity.md): How entities flow through the catalog backend — ingestion from providers, processing by policies and processors, and stitching into the final catalog.
- [Entity References](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/references.md): How to express references between entities
- [System Model](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/system-model.md): The core entity model used by the catalog — Components, APIs, Resources, Systems, Domains, Groups, Users, and how they relate to each other.
- [Well-known Relations between Catalog Entities](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/well-known-relations.md): Documentation that lists a number of well known Relations, that have defined semantics. They can be attached to catalog entities and consumed by plugins as needed.
- [Well-known Status fields of Catalog Entities](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/well-known-statuses.md): Lists a number of well known entity statuses, that have defined semantics. They can be attached to catalog entities and consumed by plugins as needed.
- [Creating a Single Entity](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/single-entity-create.md)
- [Auto Ingestion](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/auto-ingestion.md): Automatically ingest all repositories from GitHub, Azure DevOps, and GitLab as Portal-managed catalog entities, no YAML files required.
- [Monorepos](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/monorepos.md): Configure Portal to discover and ingest monorepo packages as individual Software Catalog components.
- [Updating Components](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog/bulk-editing.md): Edit component metadata individually or in bulk for Portal-managed components using the edit entity dialog and bulk edit interfaces.
- [Bulk catalog ingestion](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog-builder/index.md): Onboard multiple repositories into your Portal catalog at once from GitHub, GitLab, or Azure DevOps using Portal-managed or YAML-managed modes.
- [Understanding Management Modes](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog-builder/management-modes.md): Compare Portal-managed and YAML-managed modes for catalog components — how metadata is stored, updated, and when to use each approach.
- [Portal Mode Walkthrough](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog-builder/portal-mode-walkthrough.md): Step-by-step guide to ingesting repositories using Portal-managed mode — select repos, fill metadata, review, and submit.
- [YAML Mode Walkthrough](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog-builder/yaml-mode-walkthrough.md): Step-by-step guide to ingesting repositories using YAML-managed mode — register existing catalog-info.yaml files or create them via pull requests.
- [Troubleshooting Bulk Catalog Ingestion](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog-builder/troubleshooting.md): Resolve common issues with bulk catalog ingestion — missing organizations, failed pull requests, duplicate components, and provider errors.
- [Frequently Asked Questions](https://backstage.spotify.com/docs/portal/core-features-and-plugins/catalog-builder/faq.md): Answers to common questions about bulk catalog ingestion — switching management modes, handling duplicates, re-importing, and more.
- [Scaffolder (Portal)](https://backstage.spotify.com/docs/portal/core-features-and-plugins/scaffolder/index.md): Discover, create, edit, publish, and run Software Templates entirely within Portal to standardize and automate engineering workflows.
- [Getting Started with Scaffolder](https://backstage.spotify.com/docs/portal/core-features-and-plugins/scaffolder/getting-started.md): Create your first Software Template in Portal using premade templates or from scratch, then preview and run it with dry-run mode.
- [How-to Guides](https://backstage.spotify.com/docs/portal/core-features-and-plugins/scaffolder/how-to-guides.md): Step-by-step guides for creating, editing, publishing, and managing Software Templates in the Portal Scaffolder.
- [Scaffolder Reference](https://backstage.spotify.com/docs/portal/core-features-and-plugins/scaffolder/reference.md): Technical reference for Scaffolder template structure including form field types, action steps, field properties, and validation rules.
- [TechDocs](https://backstage.spotify.com/docs/portal/core-features-and-plugins/techdocs.md): Publish docs-like-code documentation from Markdown files alongside your source code using TechDocs in Portal, with search and catalog integration.
- [Soundcheck](https://backstage.spotify.com/docs/portal/core-features-and-plugins/soundcheck.md): Measure and improve software quality with checks, tracks, levels, and certifications that enforce organizational engineering standards in Portal.
- [Fleetshift: Getting Started](https://backstage.spotify.com/docs/portal/core-features-and-plugins/fleetshift/getting-started.md): Set up webhooks for GitHub or Azure DevOps and configure permissions so your Portal instance is ready for Fleetshift.
- [Enable AI Shifts](https://backstage.spotify.com/docs/portal/core-features-and-plugins/fleetshift/enable-ai-shifts.md): Connect Anthropic, Amazon Bedrock, Google Vertex AI, or OpenAI and enable models so Fleetshift agents can transform code.
- [Create and Run a Shift](https://backstage.spotify.com/docs/portal/core-features-and-plugins/fleetshift/create-and-run.md): Define your first Fleetshift agent shift and run it against target repositories.
- [Fleetshift Guides](https://backstage.spotify.com/docs/portal/core-features-and-plugins/fleetshift/guides.md): Step-by-step guides for common Fleetshift workflows, from running your first agent shift to bulk-fixing Soundcheck failures.
- [Fleetshift: Writing and Publishing npm Package Shifts](https://backstage.spotify.com/docs/portal/core-features-and-plugins/fleetshift/npm-package-shifts.md): Write a deterministic shift as an npm package, publish it to your Portal registry, and run it against target repositories.
- [Fleetshift: OpenRewrite Shifts](https://backstage.spotify.com/docs/portal/core-features-and-plugins/fleetshift/openrewrite-shifts.md): Run OpenRewrite recipes across your fleet without requiring target repositories to have OpenRewrite configured.
- [Fleetshift MCP Actions](https://backstage.spotify.com/docs/portal/core-features-and-plugins/fleetshift/mcp-actions.md): Use MCP actions to drive Fleetshift shifts from AiKA or any MCP-compatible AI agent.
- [Fleetshift Troubleshooting](https://backstage.spotify.com/docs/portal/core-features-and-plugins/fleetshift/troubleshooting.md): Common Fleetshift errors and how to fix them.
- [Fleetshift FAQ](https://backstage.spotify.com/docs/portal/core-features-and-plugins/fleetshift/faq.md): Frequently asked questions about Fleetshift safety, metrics, rollouts, and integrations.
- [AI Gateway](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-gateway/index.md): Configure and manage AI providers, models, and re-ranking capabilities in Portal through the centralized AI Gateway plugin.
- [Integrations](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-gateway/integrations/index.md): Browse supported AI Gateway provider integrations for language models and re-ranking, including Anthropic, AWS Bedrock, Azure, OpenAI, Cohere, Google, and Ollama.
- [Anthropic](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-gateway/integrations/anthropic.md): Configure direct Anthropic API access in AI Gateway for Claude models, with optional gateway routing and custom headers.
- [OpenAI](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-gateway/integrations/openai.md): Configure direct OpenAI API access in AI Gateway for GPT and o-series models, with optional gateway routing and custom headers.
- [Azure OpenAI](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-gateway/integrations/azure.md): Connect Azure OpenAI to AI Gateway with API keys, resource names, deployment configuration, and optional gateway base URLs.
- [Cohere](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-gateway/integrations/cohere.md): Integrate Cohere language models and re-ranking capabilities with AI Gateway for improved content relevance and document indexing.
- [Google Generative AI](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-gateway/integrations/google.md): Configure Google Gemini models in AI Gateway for language generation, embeddings, and multi-modal AI capabilities.
- [Ollama](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-gateway/integrations/ollama.md): Connect self-hosted Ollama instances to AI Gateway for running open-source language models on your own infrastructure.
- [Amazon Bedrock](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-gateway/integrations/aws-bedrock.md): Set up Amazon Bedrock as an AI Gateway provider for LLM and re-ranking models, including model compatibility checks and region-specific access.
- [DevEx Metrics](https://backstage.spotify.com/docs/portal/core-features-and-plugins/devex-metrics.md): Track developer productivity with automatically collected DORA metrics, AI usage data, pull request stats, and CI/CD execution insights in Portal.
- [Search](https://backstage.spotify.com/docs/portal/core-features-and-plugins/search.md): Configure Portal Search to index content across plugins on a customizable schedule, with out-of-the-box support and troubleshooting guidance.
- [Home](https://backstage.spotify.com/docs/portal/core-features-and-plugins/home.md): Portal's homepage provides a customizable widget-based dashboard with built-in widgets and support for custom widgets from plugins.
- [Insights](https://backstage.spotify.com/docs/portal/core-features-and-plugins/insights.md): Monitor Portal adoption with usage analytics, developer sentiment surveys, and DevEx Metrics dashboards covering active users and feature engagement.
- [Skill Exchange](https://backstage.spotify.com/docs/portal/core-features-and-plugins/skillexchange.md): Set up an internal marketplace for mentorships, embeds, and pair programming opportunities to foster cross-team learning in Portal.
- [Role-Based Access Control (RBAC)](https://backstage.spotify.com/docs/portal/core-features-and-plugins/rbac.md): Define roles, assign users and groups, and configure permissions to control access to Portal functionality and data without writing code.
- [Getting Started with AiKA](https://backstage.spotify.com/docs/portal/core-features-and-plugins/aika/getting-started.md): Set up AiKA in your Portal instance — configure an AI gateway provider, enable knowledge sources, and run your first AI-assisted query.
- [Searching for Information](https://backstage.spotify.com/docs/portal/core-features-and-plugins/aika/searching-for-information.md): Use AiKA to search across your organization's repositories, documentation, wikis, and data sources from within Portal.
- [Semantic Plugin](https://backstage.spotify.com/docs/portal/core-features-and-plugins/aika/semantic-plugin.md): Enable semantic search in AiKA using an MCP server for contextually relevant retrieval across your organization's documentation.
- [Tracing for AiKA](https://backstage.spotify.com/docs/portal/core-features-and-plugins/aika/tracing.md): Set up observability tracing for AiKA to debug query processing, knowledge retrieval, re-ranking, and response generation.
- [AiKA Data Flow & Security](https://backstage.spotify.com/docs/portal/core-features-and-plugins/aika/data-flow.md): How data flows through AiKA — query processing, knowledge retrieval, model interactions, and security controls.
- [Agent Configuration](https://backstage.spotify.com/docs/portal/core-features-and-plugins/aika/agent-configuration.md): Configure AiKA agent behavior — control query processing, tool usage, response generation, and model settings.
- [AiKA Side Panel](https://backstage.spotify.com/docs/portal/core-features-and-plugins/aika/side-panel.md): Configure the AiKA side panel — a contextual chat surface on plugin pages for asking questions while keeping your work visible.
- [Modes](https://backstage.spotify.com/docs/portal/core-features-and-plugins/aika/modes.md): Create declarative agents that turn AiKA into purpose-built assistants with custom instructions, tools, and quality controls.
- [AI Explorer](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-explorer/index.md)
- [Configuration](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-explorer/configuration.md)
- [Local Resource Management From AI Explorer](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-explorer/installation.md)
- [Rules](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-explorer/rules.md)
- [Skills](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-explorer/skills.md)
- [Marketplaces & Plugins](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-explorer/marketplaces.md)
- [Ownership](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-explorer/ownership.md)
- [Soundcheck Integration](https://backstage.spotify.com/docs/portal/core-features-and-plugins/ai-explorer/soundcheck.md)
- [Confidence Flags](https://backstage.spotify.com/docs/portal/core-features-and-plugins/confidence-flags.md): Use Confidence Flags for feature flagging with multi-platform SDKs, sophisticated targeting, gradual rollouts, and remote configuration in Portal.
- [Entity Overlays](https://backstage.spotify.com/docs/portal/core-features-and-plugins/entity-overlays.md): Apply reversible metadata overlays to Software Catalog entities, adding labels, annotations, tags, and updating ownership without modifying the source.
- [Overview](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/overview.md): What the Data Experience is, how it brings dataset metadata into Portal alongside services and components, and the integrations it supports.
- [Data Experience Quick Start](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/quickstart.md): Minimal steps to connect a data warehouse and start ingesting dataset metadata into Portal.
- [Key Concepts](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/key-concepts.md): Core Data Experience concepts — ingest sources, datasets, the data registry API, and how metadata flows into the catalog.
- [Configuration](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/configuration.md): Configure Data Experience settings — catalog defaults, entity exclusions, connector cards, and history retention.
- [TechDocs](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/techdocs.md): Add markdown-based documentation to programmatically ingested dataset entities using TechDocs and entity overlays.
- [Dataset Access Requests](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/data-access.md): Let users request access to datasets and owners approve or deny requests directly within Portal.
- [Integration: Redshift](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/integration-redshift.md): Configure Redshift as a Data Experience source — set up IAM authentication and ingest metadata from your clusters.
- [Integration: Snowflake](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/integration-snowflake.md): Configure Snowflake as a Data Experience source — authenticate with key-pair credentials and ingest table and view metadata.
- [Integration: BigQuery](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/integration-bigquery.md): Configure BigQuery as a Data Experience source — authenticate with GCP and ingest tables and views from your projects.
- [Integration: Databricks](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/integration-databricks.md): Ingest dataset metadata from Databricks Unity Catalog into Portal's software catalog.
- [Integration: dbt](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/integration-dbt.md): Configure dbt Cloud or dbt Core as a Data Experience source — ingest models, sources, and lineage from manifest files stored in GCS or S3.
- [Data Lineage](https://backstage.spotify.com/docs/portal/core-features-and-plugins/data-experience/data-lineage.md): Collect and visualize dataset and workflow lineage in Portal using the OpenLineage specification.
- [MCP in Portal](https://backstage.spotify.com/docs/portal/core-features-and-plugins/mcp/overview.md): How Portal exposes plugin capabilities as MCP tools that AI agents like AiKA, Claude Code, Cursor, and VS Code Copilot can discover and use.
- [Connecting AI Agents](https://backstage.spotify.com/docs/portal/core-features-and-plugins/mcp/connecting-agents.md): Connect external AI agents to Portal's MCP endpoint using static tokens or CIMD OAuth-based client registration.
- [Available MCP Tools](https://backstage.spotify.com/docs/portal/core-features-and-plugins/mcp/available-tools.md): Reference list of built-in MCP tools that Portal ships — search, semantic search, catalog entity queries, and more.
- [Registering MCP Tools](https://backstage.spotify.com/docs/portal/core-features-and-plugins/mcp/registering-tools.md): Register your Portal plugin's capabilities as MCP tools via the Actions Registry so AI agents can discover and use them.
- [Third-Party MCP Servers](https://backstage.spotify.com/docs/portal/core-features-and-plugins/mcp/third-party-servers.md): Add third-party MCP servers to Portal to extend AI agent capabilities beyond built-in tools, with security and operational considerations.
- [Get started with Portal CLI](https://backstage.spotify.com/docs/portal/core-features-and-plugins/cli/getting-started.md)
- [Getting Started](https://backstage.spotify.com/docs/portal/core-features-and-plugins/audit-logs/getting-started.md): Query Portal audit log events via REST API with token authentication, filtering by plugin, severity, time range, and actor.
- [Guides](https://backstage.spotify.com/docs/portal/core-features-and-plugins/audit-logs/guides.md): Set up the audit log API token and configure event exclusion rules to control which actions are recorded in the Portal audit trail.
- [Reference](https://backstage.spotify.com/docs/portal/core-features-and-plugins/audit-logs/reference.md): API reference for Portal audit log endpoints covering request parameters, filters, pagination, and response field schema.
- [PagerDuty](https://backstage.spotify.com/docs/portal/core-features-and-plugins/recommended-plugins/pagerduty.md): View active incidents, on-call schedules, and escalation policies from PagerDuty directly on Portal entity pages with self-service incident creation.
- [Buildkite](https://backstage.spotify.com/docs/portal/core-features-and-plugins/recommended-plugins/buildkite.md): Monitor Buildkite CI/CD builds, view pipeline steps, access logs, and trigger reruns from Portal entity pages.
- [GitHub Actions](https://backstage.spotify.com/docs/portal/core-features-and-plugins/recommended-plugins/github-actions.md): View, monitor, and re-run GitHub Actions workflow runs with real-time status updates directly from Portal entity pages.
- [GitHub Deployments](https://backstage.spotify.com/docs/portal/core-features-and-plugins/recommended-plugins/github-deployments.md): Track deployment history, environment status, and deployment frequency across services using the GitHub Deployments API in Portal.
- [GitHub Issues](https://backstage.spotify.com/docs/portal/core-features-and-plugins/recommended-plugins/github-issues.md): Display and filter GitHub issues with labels, assignees, and status on Portal entity pages for centralized issue tracking.
- [GitHub Pull Request Board](https://backstage.spotify.com/docs/portal/core-features-and-plugins/recommended-plugins/github-pull-request-board.md): Visualize pull requests in a kanban board layout with review status filtering to accelerate code review workflows in Portal.
- [Azure DevOps](https://backstage.spotify.com/docs/portal/core-features-and-plugins/recommended-plugins/azure-devops.md): Surface Azure DevOps pipelines, work items, pull requests, and test results on Portal entity pages for unified CI/CD visibility.
- [New Relic](https://backstage.spotify.com/docs/portal/core-features-and-plugins/recommended-plugins/new-relic.md): Embed New Relic dashboards and APM metrics on Portal entity pages for real-time application performance monitoring and alert visibility.
- [SonarQube](https://backstage.spotify.com/docs/portal/core-features-and-plugins/recommended-plugins/sonarqube.md): Display SonarQube code quality ratings, coverage, security vulnerabilities, technical debt, and quality gate status on Portal entity pages.
- [Jira Dashboard](https://backstage.spotify.com/docs/portal/core-features-and-plugins/recommended-plugins/jira-dashboard.md): Surface Jira issues, sprint progress, and epic tracking on Portal entity pages with JQL filtering and custom dashboard views.
- [Portal Connect](https://backstage.spotify.com/docs/portal/core-features-and-plugins/portal-connect.md): Deploy a lightweight agent to securely proxy Portal requests to APIs behind your firewall using mTLS, with no inbound firewall rules required.
- [Developing Portal plugins](https://backstage.spotify.com/docs/portal/portal-plugins/index.md): Create custom Backstage plugins for Portal to connect external data sources, customize core features, and extend software templates.
- [Get started](https://backstage.spotify.com/docs/portal/portal-plugins/get-started.md): Set up a workspace to create, develop, and test custom plugins for Portal.
- [Build a plugin](https://backstage.spotify.com/docs/portal/portal-plugins/build-plugin.md): Follow step-by-step guides to build custom Portal plugins, including scaffolder actions, external catalog data sources, and homepage widgets.
- [Publishing Plugins](https://backstage.spotify.com/docs/portal/portal-plugins/publishing-plugins.md): Publish custom Backstage plugins privately to your Portal Cloud instance using npm registry tokens and CI/CD pipelines.
- [Generate package metadata](https://backstage.spotify.com/docs/portal/portal-plugins/generate-metadata.md): Use the Backstage CLI to generate valid package metadata for Portal plugins with missing or incomplete pluginIds and publish configuration.
- [Managing Plugins](https://backstage.spotify.com/docs/portal/managing-plugins/index.md): Navigate Portal's Plugin Settings page to install, update, and uninstall Backstage plugins through a guided workflow.
- [Installing a Plugin](https://backstage.spotify.com/docs/portal/managing-plugins/installing-plugins.md): Install Backstage plugins in Portal by browsing recommended plugins or entering npm package names directly.
- [Updating a Plugin](https://backstage.spotify.com/docs/portal/managing-plugins/updating-plugins.md): Update individual plugins or batch-update all plugins with available newer versions from the Portal Plugin Settings page.
- [Uninstalling a Plugin](https://backstage.spotify.com/docs/portal/managing-plugins/uninstalling-plugins.md): Remove installed plugins from your Portal instance, review affected packages, and understand data removal implications.
- [Build Progress](https://backstage.spotify.com/docs/portal/managing-plugins/build-progress.md): Track plugin build stages from queuing through completion, handle build failures, and monitor in-progress builds in Portal.
- [Plugin Versioning](https://backstage.spotify.com/docs/portal/managing-plugins/plugin-versioning.md): Specify semver versions and prerelease tags when installing or updating Portal plugins, and understand how Portal detects available updates.
- [Guides](https://backstage.spotify.com/docs/portal/guides/index.md): Step-by-step guides for configuring authentication, integrations, admin settings, and feature flags in Spotify Portal for Backstage.
- [Authentication](https://backstage.spotify.com/docs/portal/guides/auth/index.md): Choose and configure an identity provider for Portal user authentication, with supported options including Entra ID, Okta, GitHub, and GitLab.
- [Entra ID](https://backstage.spotify.com/docs/portal/guides/auth/entraId/index.md): Set up Microsoft Entra ID (formerly Azure Active Directory) as the authentication provider for Portal, including app registration and user ingestion.
- [Create an Azure App Registration](https://backstage.spotify.com/docs/portal/guides/auth/entraId/create-azure-app-registration.md): Register a new Azure App in Microsoft Entra ID with the correct redirect URI so Portal can authenticate users via OAuth.
- [Ingest users and groups](https://backstage.spotify.com/docs/portal/guides/auth/entraId/setup-catalog-provider.md): Configure Microsoft Graph API permissions and the catalog provider to import users and groups from Entra ID into Portal.
- [Setup auth provider](https://backstage.spotify.com/docs/portal/guides/auth/entraId/setup-auth.md): Configure Microsoft Entra ID as the Portal sign-in provider by entering Azure App Registration credentials and enabling the auth resolver.
- [Retain admin access](https://backstage.spotify.com/docs/portal/guides/auth/entraId/retain-admin-access.md): Preserve Portal admin privileges when switching to Entra ID by adding admin users or groups before changing auth providers.
- [Okta](https://backstage.spotify.com/docs/portal/guides/auth/okta/index.md): Set up Okta as the authentication provider for Portal, including OIDC app creation, sign-in configuration, and user ingestion.
- [Ingest users and groups](https://backstage.spotify.com/docs/portal/guides/auth/okta/setup-catalog-provider.md): Create an Okta API Services app and configure the catalog provider to import users and groups from Okta into Portal.
- [Setup auth provider](https://backstage.spotify.com/docs/portal/guides/auth/okta/setup-auth.md): Create an OIDC app integration in Okta and configure Portal to use it as the sign-in authentication provider.
- [GitHub](https://backstage.spotify.com/docs/portal/guides/auth/github/index.md): Set up GitHub as the authentication provider for Portal, covering OAuth configuration, repository integration, and catalog ingestion.
- [GitHub Identity Setup Guide](https://backstage.spotify.com/docs/portal/guides/auth/github/setup-auth.md): Walk through the end-to-end process of configuring GitHub App authentication, repository integration, and catalog ingestion in Portal.
- [GitLab](https://backstage.spotify.com/docs/portal/guides/auth/gitlab/index.md): Set up GitLab as the authentication provider for Portal, including OAuth app creation, sign-in configuration, and user ingestion.
- [Ingest users and groups](https://backstage.spotify.com/docs/portal/guides/auth/gitlab/setup-catalog-provider.md): Configure the GitLab catalog provider to import users and groups from GitLab into Portal.
- [Setup auth provider](https://backstage.spotify.com/docs/portal/guides/auth/gitlab/setup-auth.md): Create a GitLab OAuth application and configure Portal to use GitLab as the sign-in authentication provider.
- [Integrations](https://backstage.spotify.com/docs/portal/guides/integrations/index.md): Connect Portal to external services like GitHub, GitLab, and Azure DevOps for catalog ingestion, repository integration, and CI/CD visibility.
- [Azure DevOps](https://backstage.spotify.com/docs/portal/guides/integrations/azure-devops/index.md): Integrate Azure DevOps with Portal for catalog entity discovery, pipeline visibility, pull requests, scaffolder actions, and wiki search indexing.
- [Setup the Azure integration in App Settings](https://backstage.spotify.com/docs/portal/guides/integrations/azure-devops/azure-app-settings-integrations.md): Add Azure DevOps credentials to Portal App Settings using a Personal Access Token or service principal with client secret.
- [Setup Azure DevOps Discovery](https://backstage.spotify.com/docs/portal/guides/integrations/azure-devops/azure-devops-discovery.md): Enable Azure DevOps Discovery in Portal to automatically find and ingest catalog-info.yaml files from your Azure DevOps repositories.
- [Install the Azure DevOps Annotator Processor](https://backstage.spotify.com/docs/portal/guides/integrations/azure-devops/azure-devops-annotator-processor.md): Install the Azure DevOps Annotator Processor plugin to automatically add required annotations to catalog entities for Azure DevOps features.
- [Install the Azure DevOps plugin](https://backstage.spotify.com/docs/portal/guides/integrations/azure-devops/azure-devops-plugin.md): Install the Azure DevOps plugin to display pipeline results, pull requests, Git tags, and README files on Portal entity pages.
- [Install the Azure DevOps scaffolder actions](https://backstage.spotify.com/docs/portal/guides/integrations/azure-devops/azure-devops-scaffolder-actions.md): Install Azure DevOps and Dotnet scaffolder action plugins to use Azure DevOps operations in Portal Software Templates.
- [Install the Azure DevOps Wiki Collator](https://backstage.spotify.com/docs/portal/guides/integrations/azure-devops/azure-devops-wiki-collator.md): Install the Azure DevOps Wiki collator to index wiki content so it appears in Portal search results and is available to AiKA.
- [GitLab](https://backstage.spotify.com/docs/portal/guides/integrations/gitlab/index.md): Integrate GitLab with Portal for supported GitLab-backed workflows.
- [Setup the GitLab integration in App Settings](https://backstage.spotify.com/docs/portal/guides/integrations/gitlab/gitlab-app-settings-integrations.md): Add GitLab credentials to Portal App Settings.
- [Setup GitLab Discovery](https://backstage.spotify.com/docs/portal/guides/integrations/gitlab/gitlab-discovery.md): Enable GitLab Discovery in Portal for GitLab-backed repository workflows.
- [AWS Credentials](https://backstage.spotify.com/docs/portal/guides/integrations/aws-credentials.md): Configure how Portal authenticates with your AWS accounts using static credentials or Workload Identity Federation.
- [Migrating to a GitHub App Integration](https://backstage.spotify.com/docs/portal/guides/integrations/migrating-to-a-github-app-integration.md): Migrate Portal from a Personal Access Token to a GitHub App for organization-level permissions, automatic commit signing, and shared credential management.
- [Ingesting Entities into your Catalog from GitHub](https://backstage.spotify.com/docs/portal/guides/integrations/ingesting-entities-into-your-catalog-from-github.md): Configure GitHub Discovery in Portal to automatically find and ingest catalog entities from your GitHub organization repositories.
- [Storing Entity Metadata outside of your SCM System](https://backstage.spotify.com/docs/portal/guides/integrations/storing-entity-metadata-outside-of-your-scm-system.md): Use Portal as the source of truth for catalog entity metadata instead of storing catalog-info.yaml files in GitHub or GitLab.
- [Enabling recovery mode](https://backstage.spotify.com/docs/portal/guides/enable-recovery-mode.md): Request recovery mode from support when you are locked out of your Portal instance and cannot access the admin interface.
- [Introduction to Flags](https://backstage.spotify.com/docs/portal/guides/confidence-flags/index.md): Learn how Confidence Flags provides managed feature flagging with variants, rules, targeting, and client-side flag resolution in Portal.
- [Confidence Flag SDKs](https://backstage.spotify.com/docs/portal/guides/confidence-flags/sdks.md): Integrate Confidence Flags into your apps with OpenFeature-compatible SDKs for Swift, Kotlin, JavaScript, React, Java, Go, Python, Rust, and Flutter.
- [Configure a Flag](https://backstage.spotify.com/docs/portal/guides/confidence-flags/quickstart.md): Create your first feature flag, define its schema and variants, force a variant for testing, and verify resolution using the resolve tester.
- [Rules](https://backstage.spotify.com/docs/portal/guides/confidence-flags/rules.md): Assign variants to users with general, override, and percentage-based rules that execute in priority order in Confidence Flags.
- [Flags](https://backstage.spotify.com/docs/portal/guides/confidence-flags/reference.md): Create, name, and manage feature flags in Confidence Flags, including schema definition, variant configuration, and client assignment.
- [Resolve Tester](https://backstage.spotify.com/docs/portal/guides/confidence-flags/resolve-tester.md): Test flag resolution by providing an evaluation context and inspecting which rules match, with troubleshooting for common failures.
- [Audience](https://backstage.spotify.com/docs/portal/guides/confidence-flags/audience.md): Define audiences with inclusion criteria and logical operators to target specific users or units in Confidence Flags rules.
- [Event-Driven Catalog Component Updates](https://backstage.spotify.com/docs/portal/guides/events-based-github.md): Enable GitHub webhook-driven catalog updates to reduce API rate limiting and keep Portal components in sync with repository changes in real time.
- [Getting Started with Admin](https://backstage.spotify.com/docs/portal/guides/Admin/getting_started.md): Navigate the Portal Admin interface to manage App Settings, Plugin Settings, and Catalog Settings for your organization.
- [Create api key](https://backstage.spotify.com/docs/portal/guides/Admin/create-api-key.md): Generate API tokens in Portal App Settings for external services, scripts, and automation to authenticate with Portal APIs.
- [Portal Connect](https://backstage.spotify.com/docs/portal/guides/portal-connect/index.md): Learn what Portal Connect is, how it works, and when to use it
- [Installation and Setup](https://backstage.spotify.com/docs/portal/guides/portal-connect/installation.md): Step-by-step guide to install and deploy Portal Connect Agent
- [Managing Portal Connect](https://backstage.spotify.com/docs/portal/guides/portal-connect/managing.md): Configure, monitor, and troubleshoot Portal Connect in production
- [Security Model](https://backstage.spotify.com/docs/portal/guides/portal-connect/security.md): Comprehensive security architecture and data handling for Portal Connect
- [Portal Security Overview](https://backstage.spotify.com/docs/portal/security.md): Review Portal security architecture, access controls, vulnerability management, and recommended mitigations for root admin and plugin risks.
- [Troubleshooting](https://backstage.spotify.com/docs/portal/troubleshooting/index.md): Diagnose and resolve common Portal issues including authentication failures, catalog sync errors, and identity provider misconfiguration.
- [GitHub Integration Troubleshooting](https://backstage.spotify.com/docs/portal/troubleshooting/github-integration.md): Resolve GitHub App and Personal Access Token integration issues in Portal, including permissions, repository access, and authentication errors.
- [Troubleshooting Rate Limiting Issues](https://backstage.spotify.com/docs/portal/troubleshooting/rate-limiting.md): Identify and fix API rate limiting in Portal by tuning catalog processing intervals, GitHub App authentication, and batch job schedules.
- [Spotify Portal for Backstage Changelog](https://backstage.spotify.com/docs/portal/changelog.md): Browse the full history of Portal releases, new features, improvements, bug fixes, and breaking changes by date.
- [Videos](https://backstage.spotify.com/docs/portal/videos.md): Watch video tutorials and demos covering Portal features including Plugin Studio, AiKA, Software Catalog, Soundcheck, and more.
- [Spotify Plugins for Backstage](https://backstage.spotify.com/docs/plugins/index.md): Explore the Spotify Plugins for Backstage bundle, including Insights, RBAC, Skill Exchange, and Soundcheck to enhance your developer portal.
- [Getting Started Guide](https://backstage.spotify.com/docs/plugins/getting-started/index.md): Obtain your license key, verify Backstage version compatibility, and set up the Spotify Plugins for Backstage.
- [AWS Marketplace](https://backstage.spotify.com/docs/plugins/getting-started/aws-marketplace.md): Purchase and configure Spotify Plugins for Backstage through AWS Marketplace using Quick Launch CloudFormation deployment.
- [Soundcheck](https://backstage.spotify.com/docs/plugins/soundcheck/index.md): Define development and operational standards, measure software component health, and incentivize quality across your engineering organization with Soundcheck.
- [Installation & Setup](https://backstage.spotify.com/docs/plugins/soundcheck/setup-and-installation.md): Install and configure the Soundcheck backend and frontend plugins in your Backstage instance, including package dependencies, database setup, and UI integration.
- [Core Concepts](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/index.md): Explore the foundational building blocks of Soundcheck including checks, tracks, campaigns, fact collectors, filters, and notifications.
- [Checks](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/checks/index.md): Create and configure checks that compare actual outcomes against organizational standards, using the no-code UI or YAML-based rules.
- [Manual Checks](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/checks/manual-checks.md): Create checks that require human input to set pass or fail state, rather than being automatically executed by Soundcheck.
- [Multi-Fact Checks](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/checks/multi-fact-checks.md): Configure checks that compare values from two different fact sources in a single rule, such as correlating Datadog metrics with catalog metadata.
- [Check Exemptions](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/checks/check-exemptions.md): Exempt specific components from checks when they are not applicable or cannot pass, with full audit logging of justifications and creators.
- [Tracks](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/tracks.md): Build multi-level tracks composed of checks and certifications to drive long-term tech health initiatives, using custom tracks or Spotify templates.
- [Campaigns](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/campaigns.md): Create and manage time-bound initiatives like software upgrades or system migrations, with dashboard tracking, Slack notifications, and archiving.
- [Filters](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/filters.md): Narrow the applicability of checks, tracks, campaigns, and collector schedules to specific catalog entities using key-value filter syntax.
- [Check Results](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/checkResults.md): Understand the six possible check result states: Passed, Failed, Warning, Not Applicable, Not Reported, and Error.
- [Fact Collectors](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/index.md): Collect raw data about your components using built-in and third-party fact collectors, then use those facts to power Soundcheck checks.
- [Azure DevOps](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/azure.md): Collect facts from Azure DevOps repositories including branch policies, branch status, pull requests, and work items for Soundcheck checks.
- [BigQuery](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/bigquery.md): Run Google SQL queries against BigQuery and use the results as facts in Soundcheck checks, with GCP authentication configuration.
- [Catalog](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/catalog.md): Use the built-in Catalog integration to expose Software Catalog entity metadata as facts for Soundcheck compliance checks.
- [Datadog](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/datadog.md): Extract service definition and service level objective facts from Datadog for use in Soundcheck checks.
- [Data Registry](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/data-registry.md): Collect dataset schema facts from Portal Data Registry to run Soundcheck compliance checks against dataset API entities.
- [GitHub](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/github.md): Collect GitHub-specific facts including branch protections, repository details, Dependabot alerts, code scanning alerts, and security advisories.
- [GitLab](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/gitlab.md): Collect GitLab-specific facts including branch protections, project details, and project languages for Soundcheck checks.
- [HTTP](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/http.md): Collect facts from arbitrary HTTP endpoints with token or API key authentication and simple response body transformations.
- [Jira](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/jira.md): Extract Jira issues search results and issue counts as Soundcheck facts using basic or personal access token authentication.
- [Kubernetes](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/kubernetes.md): Collect facts from Kubernetes clusters including pods, deployments, services, HPAs, stateful sets, and ingresses via the Kubernetes API.
- [NewRelic](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/newrelic.md): Collect entity, entity search, and policies search facts from New Relic via the NerdGraph API for Soundcheck checks.
- [PagerDuty](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/pagerduty.md): Extract PagerDuty service details, standards compliance, and incident data as Soundcheck facts for operational readiness checks.
- [Source Control Management](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/scm.md): Collect repository content facts from GitHub, GitLab, Bitbucket, Azure, Gerrit, and Gitea source control providers.
- [Snyk](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/snyk.md): Collect Snyk vulnerability issue counts and product coverage facts to check security posture in Soundcheck.
- [SonarQube](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/sonarqube.md): Collect SonarQube projects, project tags, issues, and code quality measures as Soundcheck facts for code health checks.
- [Soundcheck](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/soundcheck.md): Use the built-in Soundcheck fact collector to expose track certification levels as facts, enabling cross-track dependency checks.
- [Tech Insights](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/fact-collectors/3p-integrations/techinsights.md): Expose facts from the Backstage Tech Insights backend as Soundcheck facts, bridging Tech Insights data into Soundcheck checks.
- [Check Insights Page Overview](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/check-insights.md): View entity health metrics for a specific check, including current and historical pass/fail status, filtering, and state distribution breakdowns.
- [Track Insights Page Overview](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/track-insights.md): Analyze entity certification levels and check pass rates across a specific track, with historical trends and level-by-level breakdowns.
- [Campaign Insights Page Overview](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/campaign-insights.md): Monitor campaign progress with entity-level pass rates, historical trends, filtering options, and date-based metrics for focused Soundcheck initiatives.
- [Tech Insights](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/tech-insights.md): Give leadership real-time visibility into team-level tech health with hierarchical data navigation, compliance filtering, and summary analytics.
- [Events](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/events.md): Enable Soundcheck to emit CheckStatusChange and CertificationChange events to the Backstage events plugin for downstream automation.
- [Notifications](https://backstage.spotify.com/docs/plugins/soundcheck/core-concepts/notifications.md): Integrate Soundcheck with the Backstage Notifications plugin for check status and certification change alerts, replacing legacy Slack and email notifications.
- [Entity Card](https://backstage.spotify.com/docs/plugins/soundcheck/soundcheck-elements/soundcheck-entity-card.md): Configure the Soundcheck Entity Card to display track badge levels and technical health summaries on a Backstage entity overview page.
- [Entity Tab](https://backstage.spotify.com/docs/plugins/soundcheck/soundcheck-elements/soundcheck-entity-tab.md): Set up the Soundcheck Entity Tab to show detailed track progress, check statuses, and maturity levels for each Backstage entity.
- [Creating a Custom Third-Party Integration](https://backstage.spotify.com/docs/plugins/soundcheck/tutorials/custom-fact-collector.md): Build a custom Soundcheck fact collector from scratch to gather data from any third-party API, using a PagerDuty integration as a working example.
- [Creating a Custom No-Code UI for a Third-Party Integration](https://backstage.spotify.com/docs/plugins/soundcheck/tutorials/custom-fact-collector-ncui.md): Build a No-Code UI frontend extension for a custom Soundcheck fact collector so users can configure integrations through the Soundcheck interface instead of YAML.
- [Start Measuring Catalog Maturity in 1 hour with the SCM Compliance Track](https://backstage.spotify.com/docs/plugins/soundcheck/tutorials/start-measuring-catalog-maturity.md): Set up the SCM Compliance Track to automatically measure catalog maturity using popular checks for README files, API reports, licenses, and contributions.
- [Climb the maturity ladder with the Recommended Source Control Track](https://backstage.spotify.com/docs/plugins/soundcheck/tutorials/climb-the-maturity-ladder-with-the-recommended-source-control-track.md): Enforce repository security policies and branch protection rules using Soundcheck SCM integrations for GitHub, GitLab, and Azure DevOps.
- [Start to enable your experts to manage maturity progress](https://backstage.spotify.com/docs/plugins/soundcheck/tutorials/start-to-enable-your-experts-to-manage-maturity-progress.md): Empower domain experts to manage their own Soundcheck Checks and Tracks using the UI, local YAML, or remote YAML configuration methods.
- [Get campaigns](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/campaigns/get-campaigns.md): Get campaigns, optionally filtered by campaign ids, entity ref, and applicable checks.
- [Create campaigns](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/campaigns/create-campaigns.md): Create one or more campaigns.
- [Get campaign entities](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/campaigns/get-campaign-entities.md): Get a paginated list of entities for a campaign, enriched with certification status and check results. Exactly one of campaignId or campaignName must be provided. If checkStates is provided, a checkId or checkName must also be provided.
- [Get a campaign](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/campaigns/get-a-campaign.md): Get a single campaign, optionally filtered by entity ref and applicable checks.
- [Update a campaign](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/campaigns/update-a-campaign.md): Update a campaign by id.
- [Delete a campaign](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/campaigns/delete-a-campaign.md): Delete a campaign by id.
- [Get certifications for an entity](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/certification/get-certifications-for-an-entity.md): Get certifications for a specific entity, optionally filtered by track.
- [Certify world](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/certification/certify-world.md): Trigger certification for all entities, optionally filtered by scope, track, and time range.
- [Get checks](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/get-checks.md): Get checks, including internal and external checks, optionally filtered by check ids.
- [Create checks](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/create-checks.md): Create one or more checks. Supports three check types based on the fields provided: - **Rule-based** (default): include a `rule` field with fact conditions. Soundcheck evaluates these automatically. - **Manual**: set `type: "manual"`. Results are entered by humans via the Soundcheck UI. - **External…
- [Execute checks](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/execute-checks.md): Execute checks by id or execute an inline check against specific entities or a filter.
- [Get exemptions](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/get-exemptions.md): Returns exemptions. Optionally filter by checkId or trackId (mutually exclusive). When trackId is provided, returns exemptions for all checks in that track (including campaigns). When neither is provided, returns all exemptions paginated with limit/offset.
- [Create an exemption](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/create-an-exemption.md): Create an exemption for an entity on a specific check.
- [Revoke an exemption](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/revoke-an-exemption.md): Revoke an active exemption for a specific entity and check. The exemption remains in the database for audit purposes but is no longer active.
- [Restore a revoked exemption](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/restore-a-revoked-exemption.md): Restore a previously revoked exemption, reactivating it.
- [Get revoked exemptions](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/get-revoked-exemptions.md): Returns revoked exemptions, optionally filtered by checkId or entityRef.
- [Get a check](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/get-a-check.md): Get a single check by id.
- [Update a check](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/update-a-check.md): Update a check by id. Supports three check types based on the fields provided: - **Rule-based** (default): include a `rule` field with fact conditions. Soundcheck evaluates these automatically. - **Manual**: set `type: "manual"`. Results are entered by humans via the Soundcheck UI. - **External**: o…
- [Delete a check](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/delete-a-check.md): Delete a check by id.
- [Get the aggregate status of a check](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/get-the-aggregate-status-of-a-check.md): Get the aggregate status of a check - an aggregation of the state of all of the results for the check.
- [Get the aggregate status of a check](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/get-the-aggregate-status-of-a-check-1.md): Get the aggregate status of a check - an aggregation of the state of all of the results for all entities matching the filter.
- [Get the status history of a check](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/get-the-status-history-of-a-check.md): Get the status history of a check - an aggregation of the state of all of the results for the check over time.
- [Get the status history of a check](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checks/get-the-status-history-of-a-check-1.md): Get the status history of a check - an aggregation of the state of all of the results for entities matching the filter over time.
- [List fact collectors](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/factcollectors/list-fact-collectors.md)
- [Create fact collectors](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/factcollectors/create-fact-collectors.md)
- [Get a fact collector](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/factcollectors/get-a-fact-collector.md)
- [Update a fact collector](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/factcollectors/update-a-fact-collector.md)
- [Delete a fact collector](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/factcollectors/delete-a-fact-collector.md)
- [Submit facts](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/facts/submit-facts.md)
- [Trigger on-demand fact collection](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/facts/trigger-on-demand-fact-collection.md): Queues fact collection jobs for the specified collectors and entities. Collection is performed asynchronously; the endpoint returns immediately with a summary of what was queued. Requires the soundcheck.fact.collect permission.
- [Get check results](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checkresults/get-check-results.md): Get check results for an entity.
- [Submit check results](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checkresults/submit-check-results.md): Submit check results for one or more entities.
- [Delete check results](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/checkresults/delete-check-results.md): Delete check results for an entity.
- [Get tracks](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/tracks/get-tracks.md): Get tracks, optionally filtered by track ids, entity ref, and applicable checks.
- [Create tracks](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/tracks/create-tracks.md): Create one or more tracks.
- [Get a track](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/tracks/get-a-track.md): Get a single track, optionally filtered by entity ref and applicable checks.
- [Update a track](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/tracks/update-a-track.md): Update a track by id.
- [Delete a track](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/tracks/delete-a-track.md): Delete a track by id.
- [Get entities for a track filtered by certification status](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/tracks/get-entities-for-a-track-filtered-by-certification-status.md): Get a paginated list of entities associated with a track, optionally filtered by their certification status.
- [Get the aggregate certification status for a track](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/tracks/get-the-aggregate-certification-status-for-a-track.md): Get the aggregate certification status for a track - an aggregation of the state of all of the entities for the track.
- [Get the aggregate certification status for a track](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/tracks/get-the-aggregate-certification-status-for-a-track-1.md): Get the aggregate certification status for a track - an aggregation of the state of all of the entities matching the given filter for the track.
- [Get the aggregate certification status history of a track](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/tracks/get-the-aggregate-certification-status-history-of-a-track.md): Get the aggregate certification status history of a track - an aggregation of the state of all of the results for the track over time.
- [Get the aggregate certification status history of a track](https://backstage.spotify.com/docs/plugins/soundcheck/api-reference/tracks/get-the-aggregate-certification-status-history-of-a-track-1.md): Get the aggregate certification status history of a track - an aggregation of the state of all of the results for entities matching the given filter for the track over time.
- [API Client](https://backstage.spotify.com/docs/plugins/soundcheck/api-client.md): Use the fully-typed Soundcheck REST API client to programmatically interact with checks, tracks, campaigns, fact collectors, exemptions, results, and facts from your own backend code.
- [MCP Actions](https://backstage.spotify.com/docs/plugins/soundcheck/mcp-actions.md): Reference for all Soundcheck MCP actions available through the Actions Registry.
- [Health Page](https://backstage.spotify.com/docs/plugins/soundcheck/health.md): Monitor the operational health of your Soundcheck instance with a dashboard showing startup errors, configuration issues, integration status, and runtime metrics.
- [Soundcheck - Advanced Performance Tuning](https://backstage.spotify.com/docs/plugins/soundcheck/performance.md): Optimize Soundcheck performance with the in-memory catalog and cache warming service to reduce database load and speed up fact collection at scale.
- [Internationalization (i18n)](https://backstage.spotify.com/docs/plugins/soundcheck/internationalization.md): Override UI strings, rename concepts like "Track" to "Standard", or provide full translations for new languages.
- [Troubleshooting](https://backstage.spotify.com/docs/plugins/soundcheck/troubleshooting/index.md): Diagnose and resolve common Soundcheck issues including checks not running, missing facts, fact collector errors, and incorrect check results.
- [Job Queue Statistics](https://backstage.spotify.com/docs/plugins/soundcheck/troubleshooting/job-queue-statistics.md): Enable and configure scheduled monitoring of Soundcheck job queue performance, including throughput metrics, backlog tracking, and worker processing rates.
- [RBAC](https://backstage.spotify.com/docs/plugins/rbac/index.md): Control access to Backstage resources and actions without writing code using the RBAC plugin and the Backstage permission framework.
- [Installation & Setup](https://backstage.spotify.com/docs/plugins/rbac/setup-and-installation.md): Set up prerequisites, install the RBAC backend and frontend plugins, configure the permission framework, and import or export policies.
- [Core Concepts](https://backstage.spotify.com/docs/plugins/rbac/core-concepts.md): Learn about RBAC policy lifecycle, roles, permission matching, conditional decisions, and decision resolution strategies.
- [Fine-tune Software Templates Access](https://backstage.spotify.com/docs/plugins/rbac/tutorials/fine-tune-template-access.md): Use RBAC conditional rules and tags to control which users and groups can access specific Software Templates in Backstage.
- [Read-Only Catalog Permissions](https://backstage.spotify.com/docs/plugins/rbac/tutorials/read-only-catalog.md): Configure RBAC to prevent users from creating or deleting catalog entities, enforcing a read-only catalog experience in Backstage.
- [Catalog Delete Permissions](https://backstage.spotify.com/docs/plugins/rbac/tutorials/delete-catalog-for-owners.md): Restrict catalog entity deletion to owners only by configuring a conditional RBAC rule on the catalog.entity.delete permission.
- [Establish a foundational permission policy](https://backstage.spotify.com/docs/plugins/rbac/tutorials/foundational-permission-policy.md): Create your first RBAC policy with roles, permission decisions, and fallback rules to establish a baseline access control configuration.
- [Skill Exchange](https://backstage.spotify.com/docs/plugins/skill-exchange/index.md): Build an internal marketplace for mentoring, hack projects, and embedded learning opportunities to connect developers across your organization.
- [Setup & Installation](https://backstage.spotify.com/docs/plugins/skill-exchange/setup-and-installation.md): Install the Skill Exchange backend and frontend plugins, configure authentication, user entities, and optional notifications.
- [Notifications](https://backstage.spotify.com/docs/plugins/skill-exchange/notifications.md): Configure Backstage notifications for Skill Exchange to alert users about mentorship requests, hack project updates, and collaboration opportunities.
- [Skill Exchange Actions](https://backstage.spotify.com/docs/plugins/skill-exchange/actions.md): Integrate Skill Exchange with the Backstage Actions Registry to programmatically search skills, find experts, and automate workflows.
- [Customizing Skill Exchange](https://backstage.spotify.com/docs/plugins/skill-exchange/tutorials/customizing-skill-exchange.md): Customize Skill Exchange UI labels, categories, skills lists, and page text using the message customization API and configuration options.
- [EmbedsMessageBuilder](https://backstage.spotify.com/docs/plugins/skill-exchange/references/EmbedsMessageBuilder.md): API reference for the EmbedsMessageBuilder interface used to customize notification messages for Skill Exchange Embed posts.
- [MentorsMessageBuilder](https://backstage.spotify.com/docs/plugins/skill-exchange/references/MentorsMessageBuilder.md): API reference for the MentorsMessageBuilder interface used to customize notification messages for Skill Exchange Mentorship posts.
- [HacksMessageBuilder](https://backstage.spotify.com/docs/plugins/skill-exchange/references/HacksMessageBuilder.md): API reference for the HacksMessageBuilder interface used to customize notification messages for Skill Exchange Hack project posts.
- [Overview](https://backstage.spotify.com/docs/plugins/insights/index.md): Measure Backstage adoption, track user engagement trends, collect feedback surveys, and evaluate program success with the Insights plugin.
- [Setup & Installation](https://backstage.spotify.com/docs/plugins/insights/setup-and-installation.md): Install and configure the Insights backend and frontend plugins, set up the sign-in resolver, and enable usage data collection.
- [Usage Data](https://backstage.spotify.com/docs/plugins/insights/core-concepts/usage-data.md): Understand how Insights collects and displays usage data including active users, search activity, catalog interactions, and template executions.
- [Feedback](https://backstage.spotify.com/docs/plugins/insights/core-concepts/feedback.md): Create and configure pop-up surveys in Backstage to collect qualitative user feedback, satisfaction scores, and comments via the Insights plugin.
- [Migration & Installation](https://backstage.spotify.com/docs/plugins/insights/migrating-to-insights-with-feedback.md): Migrate from Insights v0.3.0 or earlier to v0.4.0+ by adding database support and updated frontend wiring for the Feedback feature.
- [Optimizing your Insights configuration](https://backstage.spotify.com/docs/plugins/insights/tutorials/Optimizing-Insights-set-up.md): Tune host filters, user counts, and data collection settings to ensure accurate Insights dashboards and adoption metrics.
- [Tips for running your first Feedback Survey](https://backstage.spotify.com/docs/plugins/insights/tutorials/feedback-survey.md): Plan and launch your first Insights feedback survey with recommendations tailored to your Backstage adoption stage and organization size.
- [Xirp](https://backstage.spotify.com/docs/xirp/index.md): Run and manage local AI coding sessions across projects, agents, and Git worktrees.
- [Get started with Xirp](https://backstage.spotify.com/docs/xirp/getting-started.md): Install Xirp, sign in, complete first-run setup, and create your first AI coding session.
- [Projects](https://backstage.spotify.com/docs/xirp/projects.md): Add local projects to Xirp and use overview, Git, files, skills, rules, and worktrees.
- [Sessions](https://backstage.spotify.com/docs/xirp/sessions.md): Create, monitor, organize, and resume persistent coding-agent sessions in Xirp.
- [Settings](https://backstage.spotify.com/docs/xirp/settings.md): Configure Xirp appearance, sessions, terminal behavior, notifications, coding agents, projects, and diagnostics.
- [Xirp and Portal](https://backstage.spotify.com/docs/xirp/xirp-and-portal.md): Add organizational context, catalog-based launches, shared knowledge, and session continuity to Xirp with Spotify Portal.
- [Connect Xirp to Portal](https://backstage.spotify.com/docs/xirp/connecting-to-portal.md): Connect Portal to add catalog, Workspace context, and session sharing features to Xirp.
- [Connect GitHub and populate the catalog](https://backstage.spotify.com/docs/xirp/github-onboarding.md): Configure a GitHub App for Portal and ingest repositories, users, and groups for Xirp and Workspaces.
- [Workspaces](https://backstage.spotify.com/docs/xirp/workspaces/index.md): Centralize project knowledge in Portal for people, Xirp sessions, and other MCP-compatible agents.
- [Add Workspace resources](https://backstage.spotify.com/docs/xirp/workspaces/adding-resources.md): Add catalog entities, links, documents, tasks, pull requests, and other shared context to a Portal Workspace.
- [Workspace wiki pages](https://backstage.spotify.com/docs/xirp/workspaces/wiki-pages.md): Generate, review, create, and maintain Wiki pages from shared Workspace context.
- [Launch and share Xirp sessions](https://backstage.spotify.com/docs/xirp/workspaces/launching-sessions.md): Start a Xirp coding session from a Portal Workspace, use shared MCP context, and upload the transcript.
- [FAQ](https://backstage.spotify.com/docs/xirp/faq.md): Frequently asked questions about Xirp — installation, agents, Portal, sessions, security, and beta limitations.
- [Xirp changelog](https://backstage.spotify.com/docs/xirp/changelog.md): Customer-visible changes and beta notes for Xirp.

## OpenAPI Specs

- [openapi](/docs/plugins/soundcheck/openapi.yaml)

## Optional

- [Contact us](https://backstage.spotify.com/contact-us/talk-to-us/)