Tyk Backstage Plugin

The Tyk Backstage Plugin imports Tyk API definitions and components into the Backstage catalog directly from Tyk Dashboards.

Overview

This plugin provides a Backstage entity provider that automatically discovers and imports API definitions from your Tyk Dashboard into the Backstage software catalog. It supports both scheduled synchronization and real-time webhook-based updates.

Documentation

• Installation & Configuration Guide - Complete setup instructions
• Contributing Guide - Development environment and contribution guidelines
• Code of Conduct - Community guidelines
• Security Policy - How to report security vulnerabilities

Quick Start

Install the plugin in your Backstage backend:

yarn --cwd packages/backend add @tyk-technologies/plugin-catalog-backend-module-tyk

Add the plugin to your Backstage backend (packages/backend/src/index.ts):

backend.add(import('@tyk-technologies/plugin-catalog-backend-module-tyk/alpha'));

Configure the plugin in your app-config.yaml:

tyk:
  globalOptions:
    scheduler:
      enabled: true
      frequency: 5
  dashboards:
    - host: http://localhost:3000
      token: ${TYKDASHBOARDAPITOKEN}
      name: development
      defaults:
        owner: group:default/guests
        system: system:default/tyk
        lifecycle: development

See the full documentation for detailed configuration options.

Features

• ✅ Automatic discovery of Tyk API definitions
• ✅ Imports APIs, Dashboards, and Gateway components
• ✅ Scheduled synchronization
• ✅ Real-time webhook-based updates
• ✅ Multi-dashboard support
• ✅ Configurable metadata and relationships
• ✅ Support for Tyk categories as Backstage tags
• ✅ Custom labels and annotations

Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Tyk Community: Tyk Community Forum

License

This project is licensed under the GNU Affero General Public License v3.0 - see the LICENSE file for details.