Tyk Dashboard Release Notes

This page contains all release notes for Dashboard displayed in a reverse chronological order

​

Support Lifetime

Our minor releases are supported until our next minor comes out.

---

​

5.8 Release Notes

​

5.8.2 Release Notes

​

Release Date 1st July 2025

​

Release Highlights

This is a version bump to align with Gateway v5.8.2, no changes have been implemented in this release.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.8.2	MDCB v2.8.1	MDCB v2.8.1
	Operator v1.2.0	Operator v0.17
	Sync v2.1.0	Sync v2.1.0
	Helm Chart v3.0	Helm all versions
	EDP v1.13	EDP all versions
	Pump v1.12.0	Pump all versions
	TIB (if using standalone) v1.7.0	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.23	1.23	Go plugins must be built using Go 1.23
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	13.x - 17.x	13.x - 17.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release.

Upgrade instructions

If you are upgrading to 5.8.2, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.8.2
    

• Helm charts
  • tyk-charts v3.0.0

Changelog

No changes in this release.

---

​

5.8.1 Release Notes

​

Release Date 9 May 2025

​

Release Highlights

This patch release contains various bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.8.1	MDCB v2.8.1	MDCB v2.8.1
	Operator v1.2.0	Operator v0.17
	Sync v2.1.0	Sync v2.1.0
	Helm Chart v3.0	Helm all versions
	EDP v1.13	EDP all versions
	Pump v1.12.0	Pump all versions
	TIB (if using standalone) v1.7.0	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.23	1.23	Go plugins must be built using Go 1.23
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	13.x - 17.x	13.x - 17.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release.

Upgrade instructions

If you are upgrading to 5.8.1, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.8.1
    

• Helm charts
  • tyk-charts v3.0.0

​

Changelog

Fixed

• License allocation now works across multiple dashboards

  Admin permissions correctly assigned during SSO login

  Fixed import of Tyk OAS API definitions in YAML format

  Fixed broken cancel button in Tyk Classic to Tyk OAS flow

  Multi-part OpenAPI descriptions in YAML format can now be imported

  Various fixes to the Dashboard UI

Security Fixes

• Show High priority CVEs fixed

  Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:

  • CVE-2025-46569

​

5.8.0 Release Notes

​

Release Date 28 March 2025

​

Release Highlights

With Tyk 5.8.0 we are delighted to unlock the power and flexibility of Tyk OAS for all users, with full feature parity with the legacy Tyk Classic style for REST APIs. We are thrilled to announce new updates and improvements in Tyk 5.8.0, delivering more control, flexibility, and performance. For a comprehensive list of changes, please refer to the detailed changelog below.

Full support for API configuration using Tyk OAS

We have completed the journey with Tyk OAS that started back in Tyk 4.1 - and now anything that you can configure using the Tyk Classic API definition is also available in the Tyk OAS API definition. Tyk OAS is now the recommended API style for all REST services, with Tyk Classic recommended for use only for GraphQL and TCP services. With Tyk OAS we combine the industry standard OpenAPI description with the Tyk Vendor Extension, which encapsulates all of the Tyk Gateway settings that cannot be inferred from the OpenAPI Specification (OAS). You can keep your service description (OAS) as source of truth and update the OpenAPI description part of a Tyk OAS API independently from the Tyk Vendor Extension - no need to unpick distributed vendor extensions from your OAS. For more details, please see the documentation. Now that we have achieved this milestone we are keen to support users in migrating their existing Tyk Classic API portfolio to Tyk OAS and offer methods to do this both within the Tyk Dashboard Classic API Designer and via the Tyk Dashboard API. For more details of the migration tool, please see the documentation.

Enhanced upstream authentication

We are pleased to introduce advanced options for your Tyk OAS APIs when it comes to authenticating with the upstream service - a critical feature for integration with many partner services. With Tyk 5.8.0 you are now able to configure Tyk to act as an OAuth 2.0 client, retrieving an access token via the Client Credentials grant method. For legacy integrations Tyk can also support OAuth 2.0 Resource Owner Password Credentials grant and Basic Authentication methods. For more details please see the documentation.

Enhanced user experience within the Tyk Dashboard API Designer

To accompany the launch of fully featured Tyk OAS capabilities, we have made a raft of improvements in the Tyk Dashboard GUI. There’s an all-new API test and debug facility in the API designer, allowing you to issue requests to your APIs and then examine the debug traces produced by the Gateway without leaving the Tyk Dashboard. Our new, enhanced code editor allows you to work in YAML or JSON. We’ve also given the UI a spring clean to improve the usability.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.8.0	MDCB v2.8.0	MDCB v2.8.0
	Operator v1.2.0	Operator v0.17
	Sync v2.1.0	Sync v2.1.0
	Helm Chart v3.0	Helm all versions
	EDP v1.13	EDP all versions
	Pump v1.12.0	Pump all versions
	TIB (if using standalone) v1.7.0	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.23	1.23	Go plugins must be built using Go 1.23
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	13.x - 17.x	13.x - 17.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release.

Upgrade instructions

If you are upgrading to 5.8.0, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.8.0
    

• Helm charts
  • tyk-charts v3.0.0

​

Changelog

Added

• YAML Support for Tyk OAS

  Added Support for External References in OpenAPI Descriptions

  API Testing & Debugging with Tyk OAS

  Support for Read/Write Endpoints on RDS for Analytics and Logs

  Certificate Support for GraphQL Introspection During API Creation

  Convert Tyk Classic API Definitions to Tyk OAS

  Upstream Authentication Support in Tyk Dashboard

  Quick Start Wizard for New Dashboard Users on Tyk Cloud

  View Audit Logs in the Dashboard UI

Changed

• Support for PostgreSQL 17

  Upgraded to Golang 1.23

  Improved Dashboard Code Editor

  Improved Labelling in Tyk Dashboard

  "Manage Account" Link from Dashboard

  Improved Form Performance in API Designer

  Updated Default Configuration for Tyk Operator and Sync Compatibility

  Removed unsupported TLS options in Tyk Classic API Designer

Fixed

• Show Enhanced OPA Rules for Token Reset and User Data Access

  Updated OPA rules in the Dashboard to allow all users to reset their own access tokens and view their user data, improving self-service while maintaining security. Note that users with custom OPA rules are strongly advised to update their configurations to include the is_self_key_reset and is_me helper rules. Additionally, they should modify their rules to exclude cases where is_self_key_reset or is_me apply, in order to enable this functionality.

• Show Improved Control for Dashboard API Credentials

  Users can now always access their own Dashboard API credentials, regardless of permissions. Admins’ ability to view or reset other users’ credentials is now strictly controlled by security flags.

---

​

5.7 Release Notes

​

5.7.3 Release Notes

​

Release Date 05 June 2025

​

Release Highlights

This is a version bump to align with Gateway v5.7.3, no changes have been implemented in this release.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.7.3	MDCB v2.7.2	MDCB v2.5.1
	Operator v1.1.0	Operator v0.17
	Sync v2.0.2	Sync v1.4.3
	Helm Chart v2.2	Helm all versions
	EDP v1.12	EDP all versions
	Pump v1.11.1	Pump all versions
	TIB (if using standalone) v1.6.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.22	1.22	Go plugins must be built using Go 1.22
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release.

Upgrade instructions

If you are upgrading to 5.7.3, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.7.3
    

• Helm charts
  • tyk-charts v2.2.0

Changelog

No changes in this release.

​

5.7.2 Release Notes

​

Release Date 19 February 2025

​

Release Highlights

This release focuses mainly on a security fix. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.7.2	MDCB v2.7.2	MDCB v2.5.1
	Operator v1.1.0	Operator v0.17
	Sync v2.0.2	Sync v1.4.3
	Helm Chart v2.2	Helm all versions
	EDP v1.12	EDP all versions
	Pump v1.11.1	Pump all versions
	TIB (if using standalone) v1.6.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.22	1.22	Go plugins must be built using Go 1.22
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release

Upgrade instructions

If you are upgrading to 5.7.2, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.7.2
    

• Helm charts
  • tyk-charts v2.2.0

Changelog

No changes have been implemented in this release.

Fixed

• Show Adding a TLS/SSL certificate caused the page to go blank

  Fixed an issue where attempting to add a certificate on the TLS/SSL Certificates page caused the page to go blank with an error. This has been resolved by ensuring the file input is handled correctly.

Security Fixes

• Show Critical Priority CVE Fixed

  • Fixed the following critical-priority CVE identified in the Dashboard UI, providing increased protection and improved security:
    • CVE-2025-21613

• Show High Priority CVE Fixed

  • Fixed the following CVE:
    • CVE-2025-21614

---

​

5.7.1 Release Notes

​

Release Date 31 December 2024

​

Release Highlights

This release focuses mainly on bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.7.1	MDCB v2.7.2	MDCB v2.5.1
	Operator v1.1.0	Operator v0.17
	Sync v2.0.1	Sync v1.4.3
	Helm Chart v2.2	Helm all versions
	EDP v1.12	EDP all versions
	Pump v1.11.1	Pump all versions
	TIB (if using standalone) v1.6.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.22	1.22	Go plugins must be built using Go 1.22
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

We have deprecated the obsolescent http_server_options.prefer_server_ciphers configuration option. This legacy control no longer has any effect on the underlying library and users are advised to remove this setting from their configurations.

Upgrade instructions

If you are upgrading to 5.7.1, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.7.1
    

• Helm charts
  • tyk-charts v2.2.0

​

Changelog

Fixed

• Show Fixed Issue with Restore Zooming in API Activity Dashboard

  Resolved a bug where clicking “Restore zooming to initial state” in the API Activity Dashboard would cause the graph to show blank instead of resetting to the initial zoom level. This fix ensures that users can now correctly restore the default zoom state in all charts on the Dashboard.

• Show Deprecation of http_server_options.prefer_server_ciphers

  This option has been marked as deprecated due to its obsolescence in the underlying library functions used by Tyk. Users are advised to remove this configuration from their setups as it no longer has any effect.

---

​

5.7.0 Release Notes

​

Release Date 03 December 2024

​

Release Highlights

We are thrilled to announce new updates and improvements in Tyk 5.7.0, bringing more control, flexibility, and performance. For a comprehensive list of changes, please refer to the detailed changelog below.

Tyk Streams can be configured through Tyk Dashboard

With this release we are adding a possibility for users to configure their Stream & Events APIs using Tyk Dashboard. The new API designer leads users step-by-step to create a new Stream configuration easily. Pre-filled stream configurations for different inputs and outputs make it easy to make sure that the Stream is configured correctly.

Improved Audit Log Management

Tyk 5.7.0 enhances Audit Log management with new features designed for efficiency and security. Users can now store Dashboard Audit Logs in a database for persistent retention and access them via the new /audit-logs API, which supports advanced filtering by attributes like action, IP, status, and user. Additionally, a dedicated Audit Log RBAC group ensures secure access to sensitive log data. These improvements simplify monitoring and compliance workflows, particularly in containerized environments.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.7.0	MDCB v2.7.2	MDCB v2.5.1
	Operator v1.1.0	Operator v0.17
	Sync v2.0.1	Sync v1.4.3
	Helm Chart v2.2	Helm all versions
	EDP v1.12	EDP all versions
	Pump v1.11.1	Pump all versions
	TIB (if using standalone) v1.6.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.22	1.22	Go plugins must be built using Go 1.22
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

In 5.7.0, we have deprecated the dedicated External OAuth (Tyk Classic: external_oauth, Tyk OAS: server.authentication.securitySchemes.externalOAuth) and OpenID Connect (Tyk Classic: auth_configs.oidc, Tyk OAS: server.authentication.oidc) authentication methods. We advise users to switch to JWT Authentication. Additionally, SQLite has reached its End of Life in this release, enabling a fully static, CGO-free Tyk Dashboard optimised for RHEL8. Sqlite was previously recommended only to be used in basic proofs of concept. Now, for such scenarios and for production, we recommend migrating to PostgreSQL or MongoDB for better scalability and support.

Upgrade instructions

If you are upgrading to 5.7.0, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.7.0
    

• Helm charts
  • tyk-charts v2.2.0

​

Changelog

Added

• Added confirmation prompt for Stream deletion

  Displayed Streaming API in API overview table

  Implemented logic for config framework selection in Streaming API creation

  Enhanced info messages for securing Streaming & Events APIs in policies & keys

  Enabled URL view and copy functionality in external playgrounds tab

  Introduced /streams endpoint to Tyk Dashboard API

  Split Streaming API into new type in API designer

  Integrated step-by-step UI for Config framework selection in Streaming API creation

  Easily contact Tyk Support during Tyk Cloud trial

  Support for JWE in OIDC SSO

  Store Audit Logs in a Database

  Access Audit Logs via /audit-logs endpoint

  New Role-Based Access Control (RBAC) for Audit Logs

Changed

• Removed AJV validation for Streams config editor

  Hide unnecessary field from API Designer page for Streams

  Automatic configuration of request validation for path-level parameters during import of OpenAPI description

  Deprecated SQLite support from Dashboard for RHEL8 compatibility

  Deprecated External OAuth and OpenID Connect Options in Tyk Dashboard

  Updated NPM package dependencies

Fixed

• Fixed navigation issue with "Back to APIs Page" Button on Streams API page

  Resolved search box limitation on Tyk OAS and Streams API pages

  Unable to see all *user groups* in Dashboard dropdown

​

5.6 Release Notes

​

5.6.1 Release Notes

​

Release Date 18 October 2024

​

Release Highlights

This is a version bump to align with Gateway v5.6.1, no changes have been implemented in this release.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.6.1	MDCB v2.7.1	MDCB v2.5.1
	Operator v1.0.0	Operator v0.17
	Sync v2.0	Sync v1.4.3
	Helm Chart v2.1	Helm all versions
	EDP v1.11	EDP all versions
	Pump v1.11	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.22	1.22	Go plugins must be built using Go 1.22
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release.

Upgrade instructions

If you are upgrading to 5.6.1, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.6.1
  

• Helm charts
  • Tyk Charts v2.0.0

Changelog

No changes in this release.

---

​

5.6.0 Release Notes

​

Release Date 10 October 2024

​

Release Highlights

We are thrilled to announce new updates and improvements in Tyk 5.6.0, bringing more control, flexibility, and performance. For a comprehensive list of changes, please refer to the detailed changelog below.

Per endpoint Rate Limiting for clients

Now you can configure rate limits at the endpoint level per client, using new configuration options in the access key. Use Tyk’s powerful security policies to create templates to set appropriate rate limits for your different categories of user.

Go upgrade to 1.22

We’ve upgraded the Tyk Dashboard to Golang 1.22, bringing improved performance, better security, and enhanced stability to the core system.

Strengthened Role-Based Access Controls (RBAC) to combat privilege escalation risks

We’ve tightened up the rules that govern a user’s ability to create admin users and to reset other users’ passwords when using Tyk’s RBAC function. Now, only super-admins can create new admins, admin roles can’t be assigned to user groups, and only admin users can reset another user’s password (and only within their Tyk organization).

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.6.0	MDCB v2.7.1	MDCB v2.5.1
	Operator v1.0.0	Operator v0.17
	Sync v2.0	Sync v1.4.3
	Helm Chart v2.1	Helm all versions
	EDP v1.11	EDP all versions
	Pump v1.11	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.22	1.22	Go plugins must be built using Go 1.22
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

We are deprecating support for SQLite, External OAuth Middleware, and OpenID Connect (OIDC) Middleware in Tyk Dashboard to simplify the platform and enhance overall performance. These changes will take effect from 5.7.0.

​

Why the Change?

​

SQLite

While useful for testing, SQLite is not designed for production environments. By focusing on PostgreSQL and MongoDB, we can provide users with more scalable and reliable options.

​

External OAuth Middleware

This feature serves a similar purpose to our JWT Authentication and may lead to confusion. We recommend transitioning to JWT Authentication for a more streamlined experience.

​

OpenID Connect (OIDC) Middleware

The low adoption of this option, along with its functional overlap with other supported authentication methods, prompts us to deprecate OIDC middleware to reduce complexity within the platform. We recommend users transition to JWT Authentication. We encourage users to switch to the recommended alternatives. For more detailed information, please refer to the Documentation

Upgrade instructions

If you are upgrading to 5.6.0, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.6.0
  

• Helm charts
  • tyk-charts v2.1.0

​

Changelog

Added

• Show Per endpoint client rate limiting

  Building on the per-endpoint upstream rate limits introduced in Tyk 5.5.0 we have now added per-endpoint client rate limits. This new feature allows for more granular control over client consumption of API resources by associating the rate limit with the access key, enabling you to manage and optimize API usage more effectively.

Changed

• Upgrade to Go 1.22 for Tyk Dashboard

  Improved documentation and schema for Tyk Dashboard API

  Renamed GraphQL "Playground" tab to "Playgrounds"

Fixed

• Addressed some display issues in Dashboard Analytics and Classic Portal when using PostgreSQL storage

  Dashboard didn't display correctly if more than 10 policies assigned to a key

  Dashboard UI did not prevent multiple versions of a Tyk Classic API from being assigned to a policy

  Dashboard didn't correctly record scope to policy mappings for JWTs

  Gateway logs page not displaying correctly

---

​

5.5 Release Notes

​

5.5.2 Release Notes

​

Release Date 03 October 2024

​

Release Highlights

This release replaces Tyk Dashboard 5.5.1 which was accidentally released as a non-distroless image.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.5.2	MDCB v2.7	MDCB v2.5.1
	Operator v0.18	Operator v0.17
	Sync v1.5	Sync v1.4.3
	Helm Chart v2.0.0	Helm all versions
	EDP v1.10	EDP all versions
	Pump v1.11	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.21	1.21	Go plugins must be built using Go 1.21
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release.

Upgrade instructions

If you are upgrading to 5.5.2, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.5.2
  

• Helm charts
  • Tyk Charts v2.0.0

Changelog

No changes in this release.

---

​

5.5.1 Release Notes

​

Release Date 26 September 2024

​

Release Highlights

This is a version bump to align with Gateway v5.5.1, no changes have been implemented in this release.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.5.1	MDCB v2.7	MDCB v2.5.1
	Operator v0.18	Operator v0.17
	Sync v1.5	Sync v1.4.3
	Helm Chart v2.0.0	Helm all versions
	EDP v1.10	EDP all versions
	Pump v1.11	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.21	1.21	Go plugins must be built using Go 1.21
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release.

Upgrade instructions

If you are upgrading to 5.5.1, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.5.1
  

• Helm charts
  • Tyk Charts v2.0.0

Changelog

No changes in this release.

---

​

5.5.0 Release Notes

​

Release Date 12 August 2024

​

Release Highlights

We are excited to announce Tyk Dashboard 5.5, featuring a brand-new dashboard identity, advanced rate-limiting capabilities, and enhanced security options. For a comprehensive list of changes, please refer to the changelog below.

New Tyk brand identity

Experience a refreshed and modern look with our updated brand identity. The new design enhances usability and provides a cleaner, more intuitive interface for managing your APIs.

Per Endpoint Rate Limiting

Now configure rate limits at the endpoint level for both Tyk OAS and Tyk Classic APIs, providing granular protection for upstream services against overloading and abuse.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.5.0	MDCB v2.7	MDCB v2.5.1
	Operator v0.18	Operator v0.17
	Sync v1.5	Sync v1.4.3
	Helm Chart v1.6	Helm all versions
	EDP v1.10	EDP all versions
	Pump v1.11	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.21	1.21	Go plugins must be built using Go 1.21
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release.

Upgrade instructions

If you are upgrading to 5.5.0, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.5.0
  

• Helm charts
  • tyk-charts v1.6

​

Changelog

Added

• Configure the new endpoint level rate limits in API Designer

  Improved handling of requests to non-existent versions of APIs when using URL path versioning

  Improved schema editor functionality for GQL APIs

Changed

• Show Updated NPM packages dependencies

  Updated npm package dependencies of Dashboard, to address security vulnerabilities.

Fixed

• Resolved an issue seen when using reponse plugins with Tyk OAS APIs

  Save API button now visible for SSO users

  Public playground schema exposure fixed with Introspection disabled

  Resolved issue with no analytics data showing on Endpoint Popularity page

Security Fixes

• Show High priority CVEs fixed

  Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:

  • CVE-2023-39325
  • CVE-2023-45283

---

​

5.4 Release Notes

​

5.4.0 Release Notes

​

Release Date 2 July 2024

​

Breaking Changes

Attention: Please read this section carefully There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.4.0	MDCB v2.6.0	MDCB v2.5.1
	Operator v0.18	Operator v0.17
	Sync v1.5.0	Sync v1.4.3
	Helm Chart v1.5.0	Helm all versions
	EDP v1.10.0	EDP all versions
	Pump v1.10.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.21	1.21	Go plugins must be built using Go 1.21
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release.

Upgrade instructions

If you are upgrading to 5.4.0, please follow the detailed upgrade instructions. Add upgrade steps here if necessary.

​

Release Highlights

We’re thrilled to introduce exciting enhancements in Tyk Dashboard 5.4, aimed at improving your experience with Tyk Dashboard. For a comprehensive list of changes, please refer to the change log below.

​

Event handling for Tyk OAS APIs

We’ve added support for you to register webhooks with your Tyk OAS APIs so that you can handle events triggered by the Gateway, including circuit breaker and quota expiry. You can also assign webhooks to be fired when using the new smoothing rate limiter to notify your systems of ongoing traffic spikes. For more details see the documentation.

​

Enhanced Header Handling in GraphQL APIs

Introduced a features object in API definitions for GQL APIs, including the use_immutable_headers attribute. This allows advanced header control, enabling users to add new headers, rewrite existing ones, and selectively remove specific headers. Existing APIs will have this attribute set to false by default, ensuring no change in behavior. For new APIs, this attribute is true by default, facilitating smoother migration and maintaining backward compatibility.

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.4.0
  

• Helm charts
  • tyk-charts v1.5

​

Changelog

Added

• Introduced Rate Limit Smoothing for Redis Rate Limiter

  Updated API designer toolbar for GraphQL and Universal Data Graph

  Updated API designer toolbar for HTTP and TCP

  New Tyk OAS features

  New Dashboard API endpoints

Fixed

• Fixed template inheritance issue in API Designer

  Corrected assignment issue for API Templates in Tyk organizations

  Addressed keyboard shortcut issues in Universal Data Graph URL field configuration

  Streamlined data source import endpoint in Dashboard API

  Enhanced password reset security

  Corrected filtering for Dashboard Analytics with PostgreSQL

  Minor Dashboard UI fixes and improvements

Security Fixes

• Show High priority CVEs fixed

  Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:

  • CVE-2023-39325
  • CVE-2023-45283

---

​

5.3 Release Notes

​

5.3.11 Release Notes

​

Release Date 7 May 2025

​

Release Highlights

This patch release contains various bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.11	MDCB v2.8.0	MDCB v2.8.0
	Operator v1.2.0	Operator v0.17
	Sync v2.1.0	Sync v2.1.0
	Helm Chart v3.0	Helm all versions
	EDP v1.13	EDP all versions
	Pump v1.12.0	Pump all versions
	TIB (if using standalone) v1.7.0	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.23	1.23	Go plugins must be built using Go 1.23
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	13.x - 17.x	13.x - 17.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release.

Upgrade instructions

If you are upgrading to 5.3.11, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.3.11
    

• Helm charts
  • tyk-charts v3.0.0

​

Changelog

Fixed

• License allocation now works across multiple dashboards

  Improved Control for Dashboard API Credentials

  Enhanced OPA Rules for Token Reset and User Data Access

  Various fixes to the Dashboard UI

​

Security Fixes

• Show High priority CVEs fixed

  Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:

  • CVE-2025-46569

​

5.3.10 Release Notes

​

Release Date 19 February 2025

​

Release Highlights

In this release, we upgraded the Golang version to v1.23 and fixed a CVE-2025-21613. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Breaking Changes

This release has no breaking changes.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.10	MDCB v2.5.1	MDCB v2.5.1
	Operator v0.17	Operator v0.16
	Sync v1.4.3	Sync v1.4.3
	Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v2.0.0	Helm all versions
	EDP v1.8.3	EDP all versions
	Pump v1.9.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.23	1.23	Go plugins must be built using Go 1.23
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

Given the time difference between your upgrade and the release of this version, we recommend customers verify the ongoing support of third-party dependencies they install, as their status may have changed since the release.

​

Deprecations

There are no deprecations in this release

​

Upgrade Instructions

If you are upgrading to 5.3.10, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.3.10
    

• Helm charts
  • tyk-charts v2.0.0

​

Changelog

Fixed

• Show Upgraded to Golang 1.23

  Tyk Dashboard now runs on Golang 1.23, bringing security and performance improvements. Key changes include unbuffered Timer/Ticker channels, removal of 3DES cipher suites, and updates to X509KeyPair handling. Users may need to adjust their setup for compatibility.

Security Fixes

• Show Critical Priority CVEs Fixed

  Fixed the following critical priority CVE identified in the Dashboard UI, providing increased protection and improved security:

  • CVE-2025-21613

• Show High Priority CVE Fixed

  • Fixed the following CVE:
    • CVE-2025-21614

---

​

5.3.9 Release Notes

​

Release Date 31 December 2024

​

Release Highlights

This release contains bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Breaking Changes

This release has no breaking changes.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.9	MDCB v2.5.1	MDCB v2.5.1
	Operator v0.17	Operator v0.16
	Sync v1.4.3	Sync v1.4.3
	Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v2.0.0	Helm all versions
	EDP v1.8.3	EDP all versions
	Pump v1.9.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.22	1.22	Go plugins must be built using Go 1.22
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

Given the time difference between your upgrade and the release of this version, we recommend customers verify the ongoing support of third-party dependencies they install, as their status may have changed since the release.

​

Deprecations

We have deprecated the obsolescent http_server_options.prefer_server_ciphers configuration option. This legacy control no longer has any effect on the underlying library and users are advised to remove this setting from their configurations.

​

Upgrade Instructions

If you are upgrading to 5.3.9, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.3.9
    

• Helm charts
  • tyk-charts v2.0.0

​

Changelog

Fixed

• Fixed Issue with Restore Zooming in API Activity Dashboard

  Deprecation of http_server_options.prefer_server_ciphers

  CVE-2020-8911 resolved in Tyk Dashboard

---

​

5.3.8 Release Notes

​

Release Date 07 November 2024

​

Release Highlights

This release focuses mainly on bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Breaking Changes

This release has no breaking changes.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.8	MDCB v2.5.1	MDCB v2.5.1
	Operator v0.17	Operator v0.16
	Sync v1.4.3	Sync v1.4.3
	Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v2.0.0	Helm all versions
	EDP v1.8.3	EDP all versions
	Pump v1.9.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.22	1.22	Go plugins must be built using Go 1.22
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

Given the time difference between your upgrade and the release of this version, we recommend customers verify the ongoing support of third-party dependencies they install, as their status may have changed since the release.

​

Deprecations

This is an advanced notice that the dedicated External OAuth, OpenID Connect (OIDC) authentication options, and SQLite support will be deprecated starting in version 5.7.0. We recommend that users of the External OAuth and OpenID Connect methods migrate to Tyk’s dedicated JWT Auth method. Please review your API configurations, as the Gateway logs will provide notifications for any APIs utilizing these methods.

​

Upgrade Instructions

If you are upgrading to 5.3.8, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.3.8
    

• Helm charts
  • tyk-charts v2.0.0

​

Changelog

Added

• Show Advanced notice of deprecation of dedicated External OAuth and OpenID Connect auth options

  The UI now displays a deprecation notice for the dedicated External OAuth and OpenID Connect (OIDC) authentication mechanisms. This provides advanced notification that these authentication options will be deprecated in version 5.7.0. Users are advised to migrate to the JWT Auth method, which supports integration with both OAuth and OIDC providers, in preparation for future upgrade.

Fixed

• Show User Group dropdown limitations in Dashboard

  Fixed an issue with the user group dropdown in the Dashboard UI, ensuring that all available user groups are displayed when creating a new user.

• Show Rate Limiting settings not saved when Upstream Certificates enabled for Tyk OAS API

  Fixed an issue in the Tyk OAS API Designer where Rate Limiting settings were not saved when Upstream Certificates were enabled. This fix ensures that both Rate Limits and Upstream Certificates configurations can now be saved together

---

​

5.3.7 Release Notes

​

Release Date 22 October 2024

​

Release Highlights

This is a version bump to align with Gateway v5.3.7, no changes have been implemented in this release.

​

Breaking Changes

There are no breaking changes in this release.

​

Dependencies

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.7	MDCB v2.5.1	MDCB v2.5.1
	Operator v0.17	Operator v0.16
	Sync v1.4.3	Sync v1.4.3
	Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v2.0.0	Helm all versions
	EDP v1.8.3	EDP all versions
	Pump v1.9.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.22	1.22	Go plugins must be built using Go 1.22
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Deprecations

There are no deprecations in this release.

Upgrade instructions

If you are upgrading to 5.3.7, please follow the detailed upgrade instructions.

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.3.7
  

• Helm charts
  • Tyk Charts v2.0.0

Changelog

No changes in this release.

---

​

5.3.6 Release Notes

​

Release Date 04 October 2024

​

Release Highlights

This release primarily focuses on bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Breaking Changes

Attention: Please read this section carefully. Docker images are now based on distroless. No shell is shipped in the image. If moving from a version of Tyk older than 5.3.0 please read the explanation provided with 5.3.0 release.

​

Deprecations

There are no deprecations in this release.

​

Upgrade Instructions

When upgrading to 5.3.6, please follow the detailed upgrade instructions.

​

Dependencies

With MongoDB 4.4 reaching EOL in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are using MongoDB we recommend that you upgrade to a version that we have tested with, as indicated below. With PostgreSQL v11 reaching EOL in November 2023, we can no longer guarantee full compatibility with this version of the database. If you are using PostgreSQL we recommend that you upgrade to a version that we have tested with, as indicated below.

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.6	MDCB v2.5.1	MDCB v2.5.1
	Operator v0.17	Operator v0.16
	Sync v1.4.3	Sync v1.4.3
	Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v2.0.0	Helm all versions
	EDP v1.8.3	EDP all versions
	Pump v1.9.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.22	1.22	Go plugins must be built using Go 1.22
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.3.6
  

• Helm charts
• tyk-charts v2.0

​

Changelog

Changed

• Show Upgrade to Go 1.22 for Tyk Dashboard

  The Tyk Dashboard has been upgraded from Golang 1.21 to Golang 1.22, bringing enhanced performance, strengthened security, and access to the latest features available in the new Golang release.

• Show Introducing Distroless Containers for Tyk Dashboard (2024 LTS)

  In this release, we’ve enhanced the security of the Tyk Dashboard image by changing the build process to support distroless containers. This significant update addresses critical CVEs associated with Debian, ensuring a more secure and minimal runtime environment. Distroless containers reduce the attack surface by eliminating unnecessary packages, which bolsters the security of your deployments.

Fixed

• Gateway secret could be exposed in debug logs

  Dashboard didn't display correctly if more than 10 policies assigned to a key

  Dashboard UI did not prevent multiple versions of a Tyk Classic API from being assigned to a policy

  Dashboard didn't correctly record scope to policy mappings for JWTs

Security Fixes

• Show High priority CVEs fixed

  Fixed the following high-priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:

  • CVE-2024-6104

---

​

5.3.5 Release Notes

​

Release Date 26 September 2024

​

Release Highlights

This is a version bump to align with Gateway v5.3.5, no changes have been implemented in this release.

​

Breaking Changes

Attention: Please read this section carefully. There are no breaking changes in this release, however, if moving from a version of Tyk older than 5.3.0 please read the explanation provided with 5.3.0 release.

​

Deprecations

There are no deprecations in this release.

​

Upgrade Instructions

When upgrading to 5.3.5, please follow the detailed upgrade instructions.

​

Dependencies

With MongoDB 4.4 reaching EOL in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are using MongoDB we recommend that you upgrade to a version that we have tested with, as indicated below. With PostgreSQL v11 reaching EOL in November 2023, we can no longer guarantee full compatibility with this version of the database. If you are using PostgreSQL we recommend that you upgrade to a version that we have tested with, as indicated below.

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.5	MDCB v2.5.1	MDCB v2.5.1
	Operator v0.17	Operator v0.16
	Sync v1.4.3	Sync v1.4.3
	Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v2.0.0	Helm all versions
	EDP v1.8.3	EDP all versions
	Pump v1.9.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.21	1.21	Go plugins must be built using Go 1.21
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.3.5
  

• Helm charts
• tyk-charts v2.0.0

Changelog

No changes in this release.

---

​

5.3.4 Release Notes

​

Release Date August 26 2024

​

Breaking Changes

Attention: Please read this section carefully. There are no breaking changes in this release, however, if moving from a version of Tyk older than 5.3.0 please read the explanation provided with 5.3.0 release.

​

Deprecations

There are no deprecations in this release.

​

Upgrade Instructions

When upgrading to 5.3.4 please follow the detailed upgrade instructions.

​

Release Highlights

For a comprehensive list of changes, please refer to the detailed changelog below.

​

Dependencies

With MongoDB 4.4 reaching EOL in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are using MongoDB we recommend that you upgrade to a version that we have tested with, as indicated below. With PostgreSQL v11 reaching EOL in November 2023, we can no longer guarantee full compatibility with this version of the database. If you are using PostgreSQL we recommend that you upgrade to a version that we have tested with, as indicated below.

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.4	MDCB v2.5.1	MDCB v2.5.1
	Operator v0.17	Operator v0.16
	Sync v1.4.3	Sync v1.4.3
	Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v1.4.0	Helm all versions
	EDP v1.8.3	EDP all versions
	Pump v1.9.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.21	1.21	Go plugins must be built using Go 1.21
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.3.4
  

• Helm charts
• tyk-charts v1.4

​

Changelog

Fixed

• Fixed display issue for API stats

  Fixed display issue of 429 status codes on the Activity page

  Fixed display of graphs and requests counter on Portal

  Fixed Error Breakdown display issues with dates

---

​

5.3.3 Release Notes

​

Release Date August 2nd 2024

​

Breaking Changes

Attention: Please read this section carefully. There are no breaking changes in this release, however, if moving from a version of Tyk older than 5.3.0 please read the explanation provided with 5.3.0 release.

​

Deprecations

There are no deprecations in this release.

​

Upgrade Instructions

When upgrading to 5.3.3 please follow the detailed upgrade instructions.

​

Release Highlights

For a comprehensive list of changes, please refer to the detailed changelog below.

​

Dependencies

With MongoDB 4.4 reaching EOL in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are using MongoDB we recommend that you upgrade to a version that we have tested with, as indicated below. With PostgreSQL v11 reaching EOL in November 2023, we can no longer guarantee full compatibility with this version of the database. If you are using PostgreSQL we recommend that you upgrade to a version that we have tested with, as indicated below.

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.3	MDCB v2.5.1	MDCB v2.5.1
	Operator v0.17	Operator v0.16
	Sync v1.4.3	Sync v1.4.3
	Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v1.4.0	Helm all versions
	EDP v1.8.3	EDP all versions
	Pump v1.9.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.21	1.21	Go plugins must be built using Go 1.21
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.3.3
  

• Helm charts
• tyk-charts v1.4

​

Changelog

Added

• Show Corrected ordering of Tyk OAS API paths to prevent Middleware misapplication

  Fixed an issue where nested API endpoints, such as ‘/test’ and ‘/test/abc’, might incorrectly apply middleware from the parent path to the nested path. The fix ensures that API endpoint definitions are correctly ordered, preventing this middleware misapplication and ensuring both the HTTP method and URL match accurately.

---

Fixed

• Save API button now visible for all users

  Dashboard blank page issue when retrieving key for API with mTLS and dynamic JWT Auth fixed

  Empty Endpoint popularity page issue resolved in version 5.3.1

---

​

5.3.2 Release Notes

​

Release Date 5th June 2024

​

Breaking Changes

Attention: Please read this section carefully. There are no breaking changes in this release, however if moving from a version of Tyk older than 5.3.0 please read the explanation provided with 5.3.0 release.

​

Deprecations

There are no deprecations in this release.

​

Upgrade Instructions

When upgrading to 5.3.2 please follow the detailed upgrade instructions.

​

Release Highlights

This release primarily focuses on bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Dependencies

With MongoDB 4.4 reaching EOL in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are using MongoDB we recommend that you upgrade to a version that we have tested with, as indicated below. With PostgreSQL v11 reaching EOL in November 2023, we can no longer guarantee full compatibility with this version of the database. If you are using PostgreSQL we recommend that you upgrade to a version that we have tested with, as indicated below.

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.2	MDCB v2.5.1	MDCB v2.5.1
	Operator v0.17	Operator v0.16
	Sync v1.4.3	Sync v1.4.3
	Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v1.4.0	Helm all versions
	EDP v1.8.3	EDP all versions
	Pump v1.9.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.21	1.21	Go plugins must be built using Go 1.21
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	12.x - 16.x LTS	12.x - 16.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Downloads

• Docker Image to pull
  • Copy

    Ask AI

    docker pull tykio/tyk-dashboard:v5.3.2
    

• Helm charts
  • tyk-charts v1.4

​

Changelog

Fixed

• Fixed Dashboard Analytics for PostgreSQL

  Enhanced Password Reset security

  Fixed Universal Data Graph Schema Editor Import Issue

  Enhanced Dashboard UI language

  API Template not associated with Tyk Organization

  Added control over access to context variables from middleware when using Tyk OAS APIs

  Resolved PostgreSQL Dashboard Analytics issue

---

​

5.3.1 Release Notes

​

Release Date 24 April 2024

​

Breaking Changes

Attention: Please read this section carefully. There are no breaking changes in this release, however if moving from a version of Tyk older than 5.3.0 please read the explanation provided with 5.3.0 release.

​

Deprecations

There are no deprecations in this release.

​

Upgrade Instructions

When upgrading to 5.3.1, please follow the detailed upgrade instructions.

​

Release Highlights

This release primarily focuses on bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Dependencies

With MongoDB 4.4 reaching EOL in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are using MongoDB we recommend that you upgrade to a version that we have tested with, as indicated below.

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.1	MDCB v2.5.1	MDCB v2.5.1
	Operator v0.17	Operator v0.16
	Sync v1.4.3	Sync v1.4.3
	Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v1.3.0	Helm all versions
	EDP v1.8.3	EDP all versions
	Pump v1.9.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.21	1.21	Go plugins must be built using Go 1.21
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	11.x - 15.x LTS	11.x - 15.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.3.1
  

• Helm charts
  • tyk-charts v1.3

​

Changelog

Fixed

• Improved security: user search method transitioned to POST

  Improved security: removal of Access-Control-Allow-Credentials header

  Improved security: mitigation against brute force attacks based on login response time analysis

  Improved security: now unable to log into deleted Orgs

  Improved security: suppressed accidental exposure of access keys to stdout

  Endpoint Designer does not handle wildcards in GraphQL policy allow/block lists

  Open Policy Agent editor fails to open on Windows platform

  Common keyboard shortcuts not working with UDG URL field in Data Graph Designer

  Unexplained HTTP 400 error reported in Tyk OAS API Designer

  Replaced the text editor used in Tyk Dashboard to address cursor issues

  Activity by Graph chart sometimes had display issues

  Analytics screens fail when too many requests are aggregated

  Unable to delete APIs from DocumentDB storage

  Unable to clear the API cache in distributed data plane Gateways from the control plane Dashboard

---

​

5.3.0 Release Notes

​

Release Date 5 April 2024

​

Deployment Options for Tyk Dashboard

Tyk Cloud

Tyk Dashboard 5.3.0 is available on Tyk Cloud since 5th April 2024.

Self-Managed

This release is ready for installation on your own infrastructure.

​

Breaking Changes

Attention: Please read this section carefully.

Tyk OAS APIs Compatibility Caveats

This upgrade transitions Tyk OAS APIs out of Early Access.

• Out of Early access
  • This means that from now on, all Tyk OAS APIs will be backwards compatible and in case of a downgrade from 5.3.X to 5.3.0, the Tyk OAS API definitions will always work.
• Not Backwards Compatible
  • Tyk OAS APIs in Tyk Dashboard v5.3.0 are not backwards compatible. This means that the new Tyk OAS API format used by Tyk Gateway/Dashboard v5.3.X does not work with older versions of Tyk Gateway/Dashboard, i.e. you cannot export these API definitions from a v5.3.X Tyk Dashboard and import to an earlier version.
  • The upgrade of Tyk OAS API definitions is not reversible, i.e. you cannot use version 5.3.X Tyk OAS API definitions with an older version of Tyk Dashboard.
  • This means that if you wish to downgrade or revert to your previous version of Tyk, you will need to restore these API definitions from a backup. Please go to the backup section for detailed instructions on backup before upgrading to v5.3.0.
  • When using MongoDB as your persistent data store, Tyk OAS APIs from v5.3.0 require a minimum version of MongoDB 5.0.
  • If you are not using Tyk OAS APIs, Tyk will maintain backward compatibility standards.
• Not Forward Compatible
  • Tyk OAS API Definitions prior to v5.3.0 are not forward compatible with Tyk Gateway v5.3.X.
  • This means that any Tyk OAS APIs created in any previous release (4.1.0-5.2.x) cannot work with the new Tyk Dashboard v5.3.X without being migrated to its latest format.
• MDCB deployment and Tyk OAS APIs
  • Tyk OAS APIs created in Tyk v5.3.0 will not be loaded by the data plane gateways if you are using MDCB v2.4 or older. This means that MDCB users already working with Tyk OAS APIs must wait for the release of MDCB v2.5 before upgrading Tyk Gateway and Dashboard to v5.3.0.
  • Tyk Dashboard v5.3.0 managing Tyk OAS APIs requires Tyk Gateway v5.3.0 and MDCB v2.5.X for proper functionality. Older versions of Tyk Gateway may experience compatibility issues with Tyk OAS API definitions from v5.3.0.
• After upgrade (the good news)
  • If you had a Tyk OAS API prior to v5.3.0 then Tyk Dashboard will automatically update the API definition to latest format.
  • This means that you do not have to do anything to make your Tyk OAS APIs compatible with the new 5.3.0 release as Tyk Dashboard will take care of that during start-up.
  • As mentioned above, this upgrade of Tyk OAS API definitions is irreversible.

Important: Please go to the backup section for essential instructions on how to backup before upgrading to v5.3.0

​

Dependencies

With MongoDB 4.4 reaching EOL in February 2024, we can no longer guarantee full compatibility with this version of the database and recommend upgrading to a version that we have tested with, as indicated below.

Compatibility Matrix For Tyk Components

Dashboard Version	Recommended Releases	Backwards Compatibility
5.3.0	MDCB v2.5	MDCB v2.5
	Operator v0.17	Operator v0.16
	Sync v1.4.3	Sync v1.4.3
	Helm Chart (tyk-stack, tyk-oss, tyk-dashboard, tyk-gateway) v1.3.0	Helm all versions
	EDP v1.8.3	EDP all versions
	Pump v1.9.0	Pump all versions
	TIB (if using standalone) v1.5.1	TIB all versions

Third Party Dependency	Tested Versions	Compatible Versions	Comments
GoLang	1.21	1.21	Go plugins must be built using Go 1.21
Redis	6.2.x, 7.x	6.2.x, 7.x	Used by Tyk Dashboard
MongoDB	5.0.x, 6.0.x, 7.0.x	5.0.x, 6.0.x, 7.0.x	Used by Tyk Dashboard
PostgreSQL	11.x - 15.x LTS	11.x - 15.x	Used by Tyk Dashboard
OpenAPI Specification	v3.0.x	v3.0.x	Supported by Tyk OAS

Given the potential time difference between your upgrade and the release of this version, we recommend users verify the ongoing support of third-party dependencies they install, as their status may have changed since the release.

​

Deprecations

There are no deprecations in this release.

Upgrade Instructions

The following steps are essential to follow before upgrading

1. For Self Managed deployments - Backup Your environment using the usual guidance documented with every release (this includes backup config file and database).
2. For all deployments - Backup all your API definitions (Tyk OAS API and Classic Definitions):
   • For Tyk Cloud deployments - To perform the backup please use our guide for exporting APIs and policies.
   • For Self-Managed deployments - To perform the backup please use Tyk Sync.
3. Performing the upgrade - For all deployments, follow the instructions in the upgrade guide when upgrading Tyk.

​

Release Highlights

We are excited to announce the release of 5.3.0, packed with new features, improvements and bug fixes to enhance your experience with Tyk Dashboard. For a comprehensive list of changes, please refer to the detailed changelog below.

Tyk OAS Feature Maturity

Tyk OAS is now out of Early Access as we have reached feature maturity. You are now able to make use of the majority of Tyk’s features from your Tyk OAS APIs, so they are a credible alternative to the legacy Tyk Classic APIs. From Tyk 5.3.0 we support the following features when using Tyk OAS APIs with Tyk Dashboard:

• Security
  • All Tyk-supported client-gateway authentication methods including custom auth plugins
  • Automatic configuration of authentication from the OpenAPI description
  • Gateway-upstream mTLS
  • CORS
• API-level (global) middleware including:
  • Response caching
  • Custom plugins for PreAuth, Auth, PostAuth, Post and Response hooks
  • API-level rate limits
  • Request transformation - headers
  • Response transformation - headers
  • Service discovery
  • Internal API
• Endpoint-level (per-path) middleware including:
  • Request validation - headers and body (automatically configurable from the OpenAPI description)
  • Request transformation - method, headers and body
  • Response transformation - headers and body
  • URL rewrite and internal endpoints
  • Mock responses (automatically configurable from the OpenAPI description)
  • Response caching
  • Custom Go Post-Plugin
  • Request size limit
  • Virtual endpoint
  • Allow and block listing
  • Do-not-track
  • Circuit breakers
  • Enforced timeouts
  • Ignore authentication
• Observability
  • Open Telemetry tracing
  • Detailed log recording (include payload in the logs)
  • Do-not-track endpoint
• Governance
  • API Versioning
  • API Categories
  • API Ownership

API Templates

Exclusively for Tyk OAS APIs, we are pleased to announce the introduction of API Templates: an API governance feature provided to streamline the process of creating APIs. An API template is an asset managed by Tyk Dashboard that is used as the starting point - a blueprint - from which you can create a new Tyk OAS API definition. With templates you can standardize configuration of your APIs more easily, combining your service-specific OpenAPI descriptions with enterprise requirements such as health endpoints, caching and authorization.

Enhanced User Permissions

Introducing allow list in field-based permissions via the Dashboard specifically tailored for GraphQL APIs. Users can now define granular access control for API key holders based on types and fields from a GraphQL schema. This feature enhances security and flexibility in managing API access, providing a more tailored and secure experience for users.

Global Header Management

We’ve introduced global header management specifically for UDG, simplifying header configuration across all data sources. Users can now effortlessly add, adjust, and delete multiple global headers, ensuring consistency and efficiency throughout API management, ultimately saving developers time and effort

GraphQL focused analytics

We have made the first step towards bringing our users GraphQL-focused monitoring capabilities. Users can now gain valuable insights into error trends and usage patterns for GraphQL APIs, when storing graph analytics in SQL databases. With the addition of popularity and error bar charts, users can delve deeper into their data, facilitating optimization and troubleshooting efforts.

Redis v7.x Compatibility

We have upgraded Redis driver go-redis to v9. Subsequently, Tyk 5.3 is compatible with Redis v7.x.

MongoDB v7.0.x Compatibility

We have upgraded mongo-go driver to mongo-go v1.13.1. It allows us to benefit from the bug fixes and enhancements released by MongoDB. We have also tested that both Tyk 5.0.x+ and Tyk 5.3 are compatible with MongoDB v7.0.x.

​

Downloads

• Docker Image to pull
• Copy

  Ask AI

  docker pull tykio/tyk-dashboard:v5.3.0
  

• Helm charts
  • tyk-charts GH Repo

​

Changelog

Added

• Additional features now supported in Tyk OAS API Designer when working with Tyk OAS APIs

  Implemented Design Elements for GraphQL Permissions

  Added API Categories support for Tyk OAS APIs

  Added API Ownership support for Tyk OAS APIs

  Added API Templates for Tyk OAS APIs

  Import OpenAPI Documents from File or URL

  Introduced Global Header Management for GraphQL

  Added monitoring capabilities for GraphQL APIs in the Dashboard

  Support MongoDB v7.0.x

  Support Redis v7.0.x

Changed

• Enhanced Dashboard Navigation: Introducing Favorite Screens

  Improved UI for GraphQL Data Source Headers Management

  Go 1.21 upgrade for Dashboard

  The internal TIB session secret defaults to admin_secret if it is not set explicitly

  Set default MongoDB driver to mongo-go

Fixed

• Resolved OPA rule restriction on UDG OAS import endpoint

  Optimized Policy Creation Endpoint

  Improved Security for Classic Portal

  Errors importing larger OpenAPI Documents

  Removed the need for a Description to be provided in the OpenAPI schema when autogenerating a Tyk OAS mock response

  Fixed SSO flow for Classic Developer Portal

  Remove unnecessary warning output from `tyk-dashboard --version`

Security Fixes

• Show High priority CVEs fixed

  Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:

  • CVE-2023-39325
  • CVE-2023-45283

---

​

5.2 Release Notes

​

5.2.5 Release Notes

Release Date 19 Dec 2023

​

Breaking Changes

Attention: Please read carefully this section. We have two topics to report:

​

Early Access Features:

Please note that the Tyk OAS APIs feature, currently marked as Early Access, is subject to breaking changes in subsequent releases. Please refer to our Early Access guide for specific details. Upgrading to a new version may introduce changes that are not backwards-compatible. Downgrading or reverting an upgrade may not be possible resulting in a broken installation. Users are strongly advised to follow the recommended upgrade instructions provided by Tyk before applying any updates.

​

Deprecations

There are no deprecations in this release.

​

Upgrade Instructions

If you are using a 5.2.x version, we advise you to upgrade ASAP to this latest release. If you are on an older version, you should skip 5.2.0 and upgrade directly to this release. Go to the Upgrading Tyk section for detailed upgrade Instructions.

​

Release Highlights

Dashboard 5.2.5 was version bumped only, to align with Gateway 5.2.5. Subsequently, no changes were encountered in release 5.2.5. Gateway 5.2.5 was a critical patch release. For further information please see the release notes for Gateway v5.2.5

​

Downloads

• Docker image to pull

Changelog

Since this release was version bumped only to align with Gateway v5.2.5, no changes were encountered in this release.

---

---

​

5.2.4 Release Notes

Release Date 7 Dec 2023

​

Breaking Changes

Attention: Please read carefully this section. We have two topics to report:

​

Early Access Features:

Please note that the Tyk OAS APIs feature, currently marked as Early Access, is subject to breaking changes in subsequent releases. Please refer to our Early Access guide for specific details. Upgrading to a new version may introduce changes that are not backwards-compatible. Downgrading or reverting an upgrade may not be possible resulting in a broken installation. Users are strongly advised to follow the recommended upgrade instructions provided by Tyk before applying any updates.

​

Deprecations

There are no deprecations in this release.

​

Upgrade Instructions

If you are using a 5.2.x version, we advise you to upgrade ASAP to this latest release. If you are on an older version, you should skip 5.2.0 and upgrade directly to this release. Go to the Upgrading Tyk section for detailed upgrade Instructions.

​

Release Highlights

This release primarily focuses on bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Downloads

• Docker image to pull

​

Changelog

Fixed

• Poor experience when using the Open Policy Agent (OPA) editor

  Annoying bugs when setting Dashboard user access controls

  Unable to select Mutual TLS version 1.3 from the API Designer dropdown

  Tyk Dashboard panic when using mongo-go driver

  Confusing error message if user tries to modify Tyk OAS API using a Tyk Classic API endpoint

Added

• Show Implemented a `tyk version` command that provides more details about the Tyk Dashboard build

  This prints the release version, git commit, Go version used, architecture and other build details.

---

​

5.2.3 Release Notes

Release Date 21 Nov 2023

​

Breaking Changes

Attention: Please read carefully this section. We have two topics to report:

​

Early Access Features:

Please note that the Tyk OAS APIs feature, currently marked as Early Access, is subject to breaking changes in subsequent releases. Please refer to our Early Access guide for specific details. Upgrading to a new version may introduce changes that are not backwards-compatible. Downgrading or reverting an upgrade may not be possible resulting in a broken installation. Users are strongly advised to follow the recommended upgrade instructions provided by Tyk before applying any updates.

​

Deprecations

There are no deprecations in this release.

​

Upgrade Instructions

If you are using a 5.2.x version, we advise you to upgrade ASAP to this latest release. If you are on an older version, you should skip 5.2.0 and upgrade directly to this release. Go to the Upgrading Tyk section for detailed upgrade Instructions.

​

Release Highlights

This release primarily focuses on bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Downloads

• Docker image to pull

​

Changelog

Fixed

• Unable to resize OPA editor in Tyk Dashboard

  User Search not working unless you enter the full email address

  Dashboard 4.1.0+ cannot retrieve certificates from downrev gateways

  Authentication Mode changes after changing API Protocol in API Designer

  Unable to configure external OAuth flow using Raw API editor

  If the GraphQL subscription upstream disconnects, the UI is unaware of the reconnection event

---

​

5.2.2 Release Notes

Release Date 31 Oct 2023

​

Breaking Changes

Attention: Please read carefully this section. We have two topics to report:

​

Early Access Features:

Please note that the Tyk OAS APIs feature, currently marked as Early Access, is subject to breaking changes in subsequent releases. Please refer to our Early Access guide for specific details. Upgrading to a new version may introduce changes that are not backwards-compatible. Downgrading or reverting an upgrade may not be possible resulting in a broken installation. Users are strongly advised to follow the recommended upgrade instructions provided by Tyk before applying any updates.

​

Deprecations

There are no deprecations in this release.

​

Upgrade Instructions

If you are using a 5.2.x version, we advise you to upgrade ASAP to this latest release. If you are on an older version, you should skip 5.2.0 and upgrade directly to this release. Go to the Upgrading Tyk section for detailed upgrade Instructions.

​

Release Highlights

This release primarily focuses on bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Downloads

• Docker image to pull

​

Changelog

Added

• Show Added new Dashboard configuration option `allow_unsafe_oas`

  Added a new Dashboard configuration option allow_unsafe_oas. This permits the modification of Tyk OAS APIs via the Tyk Classic API endpoints. This is not a recommended action due to the risk of inconsistent behavior and potential for breaking changes while Tyk OAS is in Early Access. This is provided for early adopters and will be deprecated later, once Tyk OAS reaches full maturity.

Fixed

• Fixed security policy grant permissions issue encountered with MongoDB

  User might not correctly inherit all permissions from their user group

  Tyk would not store Policy ID in the API Definition for a policy that did not exist

  Service Uptime page did not report the number of success hits correctly

  High priority CVEs fixed

  Azure SAML2.0 Identity Provider was preventing users from authenticating

  Fields defined in Uptime_Tests.Check_List were not correctly handled in API Designer

  Tyk Dashboard API security vulnerability

Updated

• Show Renamed License Limit to License Entitlement on Tyk Dashboard's Licensing Statistics screen

  On Tyk Dashboard’s Licensing Statistics screen, we have renamed the License Limit to License Entitlement. We’ve also improved the experience when there is no limit in the license by hiding the License Entitlement line if no limit is set.

---

​

5.2.1 Release Notes

Release Date 10 Oct 2023

​

Breaking Changes

​

Early Access Features:

Please note that the Tyk OAS APIs feature, currently marked as Early Access, is subject to breaking changes in subsequent releases. Please refer to our Early Access guide for specific details. Upgrading to a new version may introduce changes that are not backwards-compatible. Downgrading or reverting an upgrade may not be possible result in a broken installation. Users are strongly advised to follow the recommended upgrade instructions provided by Tyk before applying any updates.

​

Deprecations

There are no deprecations in this release.

​

Upgrade Instructions

If you are on a 5.2.0 we advise you to upgrade ASAP and if you are on an older version skip 5.2.0 and upgrade directly to this release. Go to the Upgrading Tyk section for detailed upgrade Instructions.

​

Release Highlights

This release primarily focuses on bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

​

Downloads

• Docker image to pull

​

Changelog

Added

• Show Support added to Tyk Dashboard API for Tyk Sync to fully support OAS API Definitions

  Added support to Tyk Dashboard API so that Tyk Sync can fully support Tyk OAS API Definitions; this will be enabled from Tyk Sync version 1.4.1.

Fixed

• Show Pagination in APIs screen was breaking for API of type GraphQL/UDG

  Fixed a bug in the Tyk Dashboard UI where pagination in the APIs screen was breaking for API of type GraphQL/UDG. This resulted in the page failing to load data and displaying a ‘No data to display’ message.

• Show Unable to disable Add Graph Operation checkbox in the GraphQL data source configuration screen

  Fixed an issue where the ‘Add GraphQL Operation’ checkbox in the GraphQL data source configuration screen couldn’t be disabled, even when no operation was added. Now, its state can be adjusted based on the presence of GraphQL operations and variables.

---

​

5.2.0 Release Notes

Release Date 29 Sep 2023

​

Breaking Changes

Attention: Please read carefully this section. We have two topics to report:

​

Early Access Features:

Please note that the Tyk OAS APIs feature, currently marked as Early Access, is subject to breaking changes in subsequent releases. Please refer to our Early Access guide for specific details. Upgrading to a new version may introduce changes that are not backwards-compatible. Downgrading or reverting an upgrade may not be possible resulting in a broken installation. Users are strongly advised to follow the recommended upgrade instructions provided by Tyk before applying any updates.

​

Deprecations

There are no deprecations in this release.

​

Release Highlights

We’re thrilled to bring you some exciting enhancements and crucial fixes to improve your experience with Tyk Dashboard. For a comprehensive list of changes, please refer to the detailed changelog below. Configure Caching Timeouts Per API Endpoint and Enable Advanced Caching Options From Within Dashboard We’ve added the ability to configure per-endpoint timeouts for Tyk’s response cache, giving you increased flexibility to tailor your APIs to your upstream services. While doing this, we’ve also fixed a longstanding issue within the Tyk Dashboard so that you can configure more of the advanced caching options from within the UI.

Added Body Transform Middleware to Tyk OAS API Definition

With this release, we are adding the much requested Body Transformations to Tyk OAS API Definition. You can now configure middleware for both request and response Body Transformations and - as a Tyk Dashboard user - you’ll be able to do so from within our simple and elegant API Designer tool. Visually test and preview Body Transformations from within the API Designer.

Track Usage Of License APIs, Gateways And Distributed Data Planes Over Time

Within the Dashboard UI, we’ve enhanced the Licensing information page, so that you can visualise your usage of licensed APIs, Gateways and distributed Data Planes over time. This allows the visualisation of deployed and active APIs using a range of different types of interactive charts.

​

Downloads

Tyk Dashboard 5.2 - Docker image to pull

​

API Changes

The following is a list of API changes in this release. Please visit our Postman collection for further information on our APIs.

• Show Added /system/stats endpoint to provide statistics for total and active APIs deployed

  Added a new endpoint, /system/stats, to provide insight and operational statistics on total and active APIs deployed. The endpoint’s flexible date filtering options, equip users to obtain comprehensive insights into usage trends.

​

Changelog

Added

• Configure request and response body transformations

  Adding a new data source is simpler when working with UDG

  Added /system/stats endpoint to provide statistics for total and active APIs deployed

Changed

• Saving operation is simpler when creating an API within the API Designer

  Saving a UDG data source is simpler and quicker

  Enhanced API usage monitoring added to Dashboard

  New chart introduced on License Statistics page to show number of deployed Data Planes

Fixed

• Advanced cache config data was absent in the Raw Editor

  403 errors were raised with JWT claim names containing spaces

  Popular endpoints were not displayed in Tyk Dashboard when SQL aggregated analytics was enabled

  Fixed security issue with expired certificates

  Users were unable to view request analytics for a specific date in the API Activity dashboard

  Enforced timeout configuration parameter for an API endpoint was not validated

  Duplicate APIs could be created when click save button multiple times in API Designer

  Connection issues were encountered with MongoDB connection strings

---

​

5.1 Release Notes

​

5.1.0 Release Notes

​

Release Date 23 June 2023

​

Breaking Changes

*Attention warning: Please read carefully this section. We have two topics to report:

Golang Version upgrade

Our Dashboard is using Golang 1.19 programming language starting with the 5.1 release. This brings improvements to the code base and allows us to benefit from the latest features and security enhancements in Go. Don’t forget that, if you’re using GoPlugins, you’ll need to recompile these to maintain compatibility with the latest Gateway.

Tyk OAS APIs

To provide a superior experience with OAS APIs, we have made some changes which include various security fixes, improved validation etc. Upgrading to v5.1 from v4.x.x may be irreversible, rollback to v4.x.x could break your OAS API definitions. For this reason, we recommend making a database backup so you can always restore from the backup (of v4.X.X) in case you encounter a problem during the upgrade. Please refer to our guides for detailed information on upgrading Tyk and how to back up tyk

​

Deprecation

There are no deprecations in this release.

​

Upgrade Instructions

Go to the Upgrading Tyk section for detailed upgrade instructions.

​

Release Highlights

Dashboard Analytics for API Ownership

When we implemented Role Based Access Control and API Ownership in Tyk Dashboard, we unlocked great flexibility for you to assign different roles to different users and user groups with visibility and control over different collections of APIs on your Gateway. Well, from 5.1 we have added a new Role, which layers on top of the existing “Analytics” role and can be used to restrict a user’s access, within the Dashboard Analytics screens, to view only the statistics from APIs that they own; we’ve called this “Owned Analytics”. Due to the way the analytics data are aggregated (to optimize storage), a user granted this role will not have access to the full range of charts. Take a look at the documentation for a full description of this new user role.

Import API examples from within the Dashboard

In 5.0 we introduced the possibility to import API examples manually or via Tyk Sync. We have now extended this feature and it is now possible to do this without leaving the Dashboard. When having an empty “Data Graphs” section you will be presented with 3 icon buttons with one of them offering you to import an Example API. If you already have Data Graphs in your Dashboard you can either click on the “Import” button or click on the “Add Data Graph“ button and select “Use example data graph“ on the next screen. The examples UI will present you with a list of available examples. You can navigate to the details page for every example and import it as well from the same page.

Improved nested GraphQL stitching

Before this release, it was only possible to implement nested GraphQL stitching (GraphQL data source inside another data source) by using a REST data source and providing the GraphQL body manually. We have now extended the GraphQL data source so that you can provide a custom operation and therefore access arguments or object data from parent data sources. To use this feature you will only need to check the “Add GraphQL operation“ checkbox when creating a GraphQL data source.

Import UDG API from OAS 3.0.0

We added a Dashboard API Endpoint that is capable of taking an OAS 3.0.0 document and converting it into a UDG API. This will generate the full schema as well as the data sources that are defined inside the OAS document.

Changed default RPC pool size for MDCB deployments

We have reduced the default RPC pool size from 20 to 5. This can reduce the CPU and memory footprint in high throughput scenarios. Please monitor the CPU and memory allocation of your environment and adjust accordingly. You can change the pool size using slave_options.rpc_pool_size

​

Downloads

docker image to pull

​

Changelog

Added

• Added two endpoints to the dashboard to support the retrieval of example API definitions. One for fetching all examples and another for fetching a single example.
• Added a way to display UDG examples from the tyk-examples repository in the Dashboard UI
• Added screens in Dashboard New Graph flow, that allows users to choose between creating a graph from scratch or importing one of our example graphs
• Added a screen to display details of a UDG example API
• Added a feature to display a full Tyk Sync command that will allow a user to import an example UDG into their Dashboard
• Added /examples endpoint to Dashboard API that returns a list of available API examples that can later be imported into the Dashboard GET /api/examples
• Added /data-graphs/data-sources/import endpoint to Dashboard API that transforms an OpenAPI document into UDG config and publishes it in Dashboard POST /api/data-graphs/data-sources/import
• Added query param apidef=true to example detail endpoint in Dashboard API to retrieve the API definition of an example
• Added new owned_analytics user permission which restricts the user’s access only to analytics relating to APIs they own. These are the API Activity Dashboard Requests and Average Errors Over Time charts in the Tyk Dashboard. Note that it is not currently possible to respect API Ownership in other aggregated charts

Changed

• Tyk Dashboard updated to Go 1.19
• Updated npm package dependencies of Dashboard, to address critical and high CVEs
• Changed the field mapping tickbox description in GUI to be ‘Use default field mapping’

Fixed

• Fixed an issue when using custom authentication with multiple authentication methods. Custom authentication could not be selected to provide the base identity
• Fixed an issue where the login URL was displayed as undefined when creating a TIB Profile using LDAP as a provider
• Fixed an issue where it was not possible to download Activity by API or Activity by Key from the Dashboard when using PostgreSQL for the analytics store
• Fixed an issue where a new user could be stuck in a password reset loop in the dashboard if TYK_DB_SECURITY_FORCEFIRSTLOGINPWRESET was enabled
• Fixed an issue where the ssl_force_common_name_check flag was disappearing. The flag was disappearing after being updated via dashboard UI raw API editor and a subsequent page reload. It was also disappearing when updating the API Definition via the GW/DB API.
• Fixed an issue where a user could update their email address to match that of another user within the same organization
• Fixed an issue where users without user:write permission were able to update their permissions through manipulation of Dashboard API calls
• Fixed an issue where the versions endpoint returned APIs that were not owned by the logged-in user
• Fixed an issue where the log browser showed analytics for APIs not owned by the logged-in user
• Fixed an issue that prevented non-admin users from seeing Endpoint Popularity data in the Tyk Dashboard
• Fixed an issue where additional data was returned when requesting analytics with p=-1 query when using SQL for the analytics store
• Fixed an issue so that filtering by API now respects API Ownership in three Dashboard charts.
  • Gateway Dashboard - API Activity Dashboard - Requests
  • Activity by API - Traffic Activity per API
  • Errors - Average Errors Over Time
• Fixed an issue so that the Log Browser now respects API Ownership. A user will now only be able to see logs for the APIs that they are authorized to view
• Fixed filters for the Log Browser, Errors - Average Errors Over Time and API Activity Dashboard - Requests so that a user can only select from versions of APIs for which they have visibility
• Fixed UI bug so that data graphs created with multiple words are sluggified, i.e. spaces are replaced with a hyphen -
• Fixed an issue with routing, which was sending the user to a blank screen while creating a new Data Graph or importing an example API

​

5.0 Release Notes

​

5.0.15 Release Notes

​

Release Date 24 October 2024

​

Release Highlights

This is a version bump to align with Gateway v5.0.15, no changes have been implemented in this release.

​

Breaking Changes

There are no breaking changes in this release.

Upgrade instructions

If you are upgrading to 5.0.15, please follow the detailed upgrade instructions.

Changelog

No changes in this release.

---

​

5.0.14 Release Notes

​

Release Date 18th September 2024

​

Upgrade Instructions

This release is not tightly coupled with Tyk Gateway v5.0.14, so you do not have to upgrade both together. Go to the Upgrading Tyk section for detailed upgrade instructions.

​

Release Highlights

This release fixes some display issues in Tyk Dashboard and Tyk Classic Portal when using PostgreSQL.

​

Changelog

Fixed

• Tyk Dashboard UI: Fixed display issue for API statistics

  Tyk Dashboard UI: Fixed issue with display of HTTP 429 status codes on the Activity page

  Tyk Classic Portal UI: Fixed display of graphs and requests counter

  Tyk Dashboard UI: fixed issues with the Error Breakdown display, specifically related to date handling

---

​

5.0.13 Release Notes

Please refer to our GitHub release notes

---

​

5.0.12 Release Notes

Please refer to our GitHub release notes

---

​

5.0.11 Release Notes

Please refer to our GitHub release notes

---

​

5.0.10 Release Notes

Please refer to our GitHub release notes

---

​

5.0.9 Release Notes

Please refer to our GitHub release notes

---

​

5.0.8 Release Notes

Please refer to our GitHub release notes

---

​

5.0.7 Release Notes

Please refer to our GitHub release notes.

---

​

5.0.6 Release Notes

Please refer to our GitHub release notes.

---

​

5.0.5 Release Notes

Please refer to our GitHub release notes.

---

​

5.0.4 Release Notes

Please refer to our GitHub release notes.

---

​

5.0.3 Release Notes

Please refer to our GitHub release notes.

---

​

5.0.2 Release Notes

Release Date 29 May 2023

Release Highlights

Support for MongoDB 5 and 6

From Tyk 5.0.2, we added support for MongoDB 5.0.x and 6.0.x. To enable this, you have to set new Dashboard config option driver to mongo-go. The driver setting defines the driver type to use for MongoDB. It can be one of the following values:

• mgo (default): Uses the mgo driver. This driver supports MongoDB versions <= v4.x (lower or equal to v4.x). You can get more information about this driver in the mgo GH repository. To allow users more time for migration, we will update our default driver to the new driver, mongo-go, in next major release.
• mongo-go: Uses the official MongoDB driver. This driver supports MongoDB versions >= v4.x (greater or equal to v4.x). You can get more information about this driver in mongo-go-driver GH repository.

See how to Choose a MongoDB driver Note: Tyk Pump 1.8.0 and MDCB 2.2 releases have been updated to support the new driver option

Downloads

docker image to pull

Fixed

• Fixed a bug on migration of a portal catalog with deleted policy to SQL
• Fixed: Redirect unregistered user to new page when SSOOnlyForRegisteredUsers is set to true

---

​

5.0.1 Release Notes

Release Date 25 Apr 2023

Release Highlights

This release primarily focuses on bug fixes. For a comprehensive list of changes, please refer to the detailed changelog below.

Downloads

• docker image to pull

Added

• Improved security for people using the Dashboard by adding the Referrer-Policy header with the value no-referrer
• Added ability to select the plugin driver within the Tyk OAS API Designer

Changed

• When creating a new API in the Tyk OAS API Designer, caching is now disabled by default

Fixed

• Fixed a bug where a call to the /hello endpoint would unnecessarily log http: superfluous response.WriteHeader call
• Fixed a bug where the Dashboard was showing Average usage over time for all Developers, rather than just those relevant to the logged in developer
• Fixed a bug where logged in users could see Identity Management pages, even if they didn’t have the rights to use these features
• Fixed a bug that prevented Tyk Dashboard users from resetting their own passwords
• Fixed issue with GraphQL proxy headers added via UI
• Fixed a bug where the Dashboard would not allow access to any screens if a logged in user didn’t have access to the APIs resource regardless of other access rights
• Fixed a bug on the key management page where searching by key_id did not work - you can now initiate the search by pressing enter after typing in the key_id
• Fixed a bug where Dashboard API could incorrectly return HTTP 400 when deleting an API
• Fixed UDG UI bug that caused duplicate data source creation on renaming
• Fixed schema validation for custom domain in Tyk OAS API definition
• Fixed a bug where the left menu did not change when Dashboard language was changed
• Fixed a bug that caused the Dashboard to report errors when decoding multiple APIs associated with a policy
• Fixed a bug where it was not possible to disable the Use Scope Claim option when using JWT authentication
• Fixed a bug in the default OPA rule that prevented users from resetting their own password
• Fixed a bug where authToken data was incorrectly stored in the JWT section of the authentication config when a new API was created

---

​

5.0.0 Release Notes

​

Release Date 28 Mar 2023

​

Release Highlights

Improved OpenAPI support

Tyk Dashboard has been enhanced with all the custom middleware options for Tyk OAS APIs, so for the first time you can configure your custom middleware from the Dashboard; this covers the full suite of custom middleware from pre- to post- and response plugins. We’ve got support for middleware bundles, Go plugins and Tyk Virtual Endpoints, all within the new and improved Tyk Dashboard UI. Versioning your Tyk OAS APIs is easier than ever, with the Tyk OSS Gateway now looking after the maintenance of the list of versions associated with the base API for you; we’ve also added a new endpoint on the Tyk API that will return details of the versions for a given API. Tyk Dashboard hasn’t been left out, we’ve implemented a brand new version management UI for Tyk OAS APIs, to make it as easy as possible for you to manage those API versions as you develop and extend your API products with Tyk. We’ve improved support for OAS Mock Responses, with the Tyk OAS API definition now allowing you to register multiple Mock Responses in a single API, providing you with increased testing flexibility. Another new feature in the Tyk OAS API Designer is that you can now update (PATCH) your existing Tyk OAS APIs through the Dashboard API without having to resort to curl. That should make life just that little bit easier. Of course, we’ve also addressed some bugs and usability issues as part of our ongoing ambition to make Tyk OAS API the best way for you to create and manage your APIs.

GraphQL and Universal Data Graph improvements

This release is all about making things easier for our users with GraphQL and Universal Data Graph. In order to get our users up and running with a working Universal Data Graph quickly, we’ve created a repository of examples that anyone can import into their Dashboard or Gateway and see what Universal Data Graph is capable of. Import can be done in two ways:

• manually, by simply copying a Tyk API definition from GitHub - TykTechnologies/tyk-examples: A repository containing example API definitions and policies for Tyk products.
• via command line using tyk-sync

To make it easier for our users to find their way to Universal Data Graph, we’ve also given it its own space in the Dashboard. From now on you can find UDG under Data Graphs section of the menu. It also got a lot easier to turn a Kafka topic into a GraphQL subscription. Using our new Dashboard API endpoint, users will be able to transform their AsyncAPI documentation into Universal Data Graph definition with a single click. Support for OAS coming soon as well! With this release we are also giving our users improved headers for GQL APIs. It is now possible to use context variables in request headers and persist headers needed for introspection separately for improved security. Additionally we’ve added Dashboard support for introspection control on policy and key level. It is now possible to allow or block certain consumers from being able to introspect any graph while creating a policy or key via Dashboard.

​

Downloads

docker image to pull

​

Changelog

Added

• Numerous UX improvements
• New UI for custom middleware for Tyk OAS APIs
• Significantly improved Tyk OAS API versioning user experience
• It now possible to use PATCH method to modify Tyk OAS APIs via the Dashboard API
• Now you can turn a Kafka topic into a GraphQL subscription by simply importing your AsyncAPI definition
• Way to control access to introspection on policy and key level

Changed

• Universal Data Graph moved to a separate dashboard section

---

​

4.3 Release Notes

​

4.3.0 Release Notes

​

Release Highlights

Tyk OAS APIs - Versioning via the Dashboard

Tyk v4.3 adds API versioning to the Dashboard UI, including:

• Performing CRUD operations over API versions
• Navigate seamlessly between versions
• A dedicated manage versions screen
• easily identify the default version and the base API.

Importing OAS v3 via the Dashboard

Importing OpenAPI v3 documents in order to generate Tyk OAS API definition is now fully supported in our Dashboard UI. Our UI automatically detects the version of your OpenAPI Document, and will suggest options that you can pass or allow Tyk to read from the provided document, in order to configure the Tyk OAS API Definition. Such as:

• custom upstream URL
• custom listen path
• authentication mechanism
• validation request rules and limit access only to the defined paths.

Importing OAS v3 via the Dashboard

Updated the Tyk Dashboard version of Golang, to 1.16.

Our Dashboard is using Golang 1.16 version starting with 4.3 release. This version of the Golang release deprecates x509 commonName certificates usage. This will be the last release where it’s still possible to use commonName, users need to explicitly re-enable it with an environment variable. The deprecated, legacy behavior of treating the CommonName field on X.509 certificates as a host name when no Subject Alternative Names are present is now disabled by default. It can be temporarily re-enabled by adding the value x509ignoreCN=0 to the GODEBUG environment variable. Note that if the CommonName is an invalid host name, it’s always ignored, regardless of GODEBUG settings. Invalid names include those with any characters other than letters, digits, hyphens and underscores, and those with empty labels or trailing dots.

​

Changelog

Added

• Added an option for using multiple header/value pairs when configuring GraphQL API with a protected upstream and persisting those headers for future use.
• Added documentation on how edge endpoints Dashboard configuration can be used by users to add tags for their API Gateways.
• When retrieving the Tyk OAS API Definition of a versioned API, the base API ID is passed on the GET request as a header: x-tyk-base-api-id.
• If Edge Endpoints Dashboard configuration is present, when users add segment/tags to the Tyk OAS API Definition, their corresponding URLs are populated in the servers section of the OAS document.
• Listen path field is now hidden from the API Designer UI, when the screen presents a versioned or internal API.

Changed

• Extended existing x-tyk-gateway OAS documentation and improved the markdown generator to produce a better-formatted documentation for x-tyk-gateway schema.
• Complete change of Universal Data Graph configuration UI. New UI is now fully functional and allows configuration of all existing datasources (REST, GraphQL and Kafka).
• Changed look & feel of request logs for GraphQL Playground. It is now possible to filter the logs and display only the information the user is interested in.

Fixed

• Fixed: OAS API definition showing management gateway URL even if segment tags are present in cloud. From now on OAS servers section would be filled with edge endpoint URLs if configured.
• Adding a path that contains a path parameter, doesn’t throw an error anymore on the Dashboard UI, and creates default path parameter description in the OAS.

​

Updated Versions

Tyk Dashboard 4.3 (docker images)

​

Upgrade process

Follow the standard upgrade guide, there are no breaking changes in this release. If you want switch from MongoDB to SQL, you can use our migration tool, but keep in mind that it does not yet support the migration of your analytics data.

​

4.2 Release Notes

​

4.2.0 Release Notes

​

Release Highlights

GraphQL Federation improvements

Changed GUI in Universal Data Graph configuration section.

A new GUI introduces enhancements to the user experience and more consistent user journey for UDG. This change does not yet cover all possible use cases and is released with a feature flag. To enable the new GUI, analytics.conf needs the following setting: What’s possible with this change:

• Importing GraphQL schema created outside of Tyk (formats accepted .json, .graphql, .grahqls)
• Creating GraphQL schema in Tyk using schema editor
• Hide/Unhide schema editor to focus on graphical representation of the schema
• Resizing schema editor to adjust workspace look & feel to user preferences
• Improved search in schema editor (search and search & replace available)
• Quick link to UDG documentation from schema editor

Note: Full configuration of new Universal Data Graph is not yet possible in the GUI, however any UDGs created earlier will not be broken and will work as previously.

Changes to federation entities

Defining the base entity

Entities must be defined with the @key directive. The fields argument must reference a field by which the entity can be uniquely identified. Multiple primary keys are possible. For example: Subgraph 1 (base entity): Attempting to extend a non-entity with an extension that includes the @key directive or attempting to extend a base entity with an extension that does not include the @key directive will both result in errors.

Entity stubs

Entities cannot be shared types (be defined in more than one single subgraph). If one subgraph references a base entity (an entity defined in another subgraph), that reference must be declared as a stub (stubs look like an extension without any new fields in federation v1). This stub would contain the minimal amount of information to identify the entity (referencing exactly one of the primary keys on the base entity regardless of whether there are multiple primary keys on the base entity). For example, a stub for MyEntity from Subgraph 1 (defined above): Subgraph 2 (stub)

Supergraph extension orphans

It is now possible to define an extension for a type in a subgraph that does not define the base type. However, if an extension is unresolved (an extension orphan) after an attempted federation, the federation will fail and produce an error.

Improved Dashboard UI and error messages

GraphQL-related (for example when federating subgraphs into a supergraph) errors in the Dashboard UI will show a lean error message with no irrelevant prefixes or suffixes. Changed the look & feel of request logs in Playground tab for GraphQL APIs. New component presents all logs in a clearer way and is easier to read for the user

Shared types

Types of the same name can be defined in more than one subgraph (a shared type). This will no longer produce an error if each definition is identical. Shared types cannot be extended outside of the current subgraph, and the resolved extension must be identical to the resolved extension of the shared type in all other subgraphs (see subgraph normalization notes). Attempting to extend a shared type will result in an error. The federated supergraph will include a single definition of a shared type, regardless of how many times it has been identically defined in its subgraphs.

Subgraph normalization before federation

Extensions of types whose base type is defined in the same subgraph will be resolved before an attempt at federation. A valid example involving a shared type: Subgraph 1: Subgraph 2: The enum named “Example” defined in Subgraph 1 would resolve to be identical to the same-named enum defined in Subgraph 2 before federation takes place. The resulting supergraph would include a single definition of this enum.

Validation

Union members must be both unique and defined. Types must have bodies, e.g., enums must contain at least one value; inputs, interfaces, or objects must contain at least one field

OpenAPI

Added support for the Request Body Transform middleware, for new Tyk OAS API Definitions.

Universal Data Graph

Added support for Kafka as a data source in Universal Data Graph. Configuration allows the user to provide multiple topics and broker addresses.

​

Changelog

Added

• Added support for Kafka as a data source in Universal Data Graph.
• Added support for the Request Body Transform middleware for OAS based APIs

Changed

• Improved GraphQL Dashboard UI error messages
• Changed GUI in Universal Data Graph
• Changed look & feel of request logs in Playground tab for GraphQL APIs.

Fixed

• Fixed an issue with key lookup where keys were not being found when using the search field
• Fixed an issue with object types dropdown in Universal Data Graph config, where it wasn’t working correctly when object type UNION was chosen
• Fixed an issue in Universal Data Graph which prevented users from injecting an argument value or parameter value in the domain part of the defined data source upstream URL

​

Updated Versions

Tyk Dashboard 4.2

​

Upgrade process

Follow the standard upgrade guide, there are no breaking changes in this release. If you want switch from MongoDB to SQL, you can use our migration tool, but keep in mind that it does not yet support the migration of your analytics data.

​

4.1 Release Notes

​

4.1.0 Release Notes

​

Release Highlights

OpenAPI as a native API definition format

Tyk has always had a proprietary specification for defining APIs. From Tyk v4.1 we now support defining APIs using the Open API Specification (OAS) as well, which can offer significant time and complexity savings. This is an early access capability. As we extend our OAS support, we would very much like your feedback on how we can extend and update to best meet your needs: . This capability is available in both the open source and paid versions of Tyk. See our Tyk OAS documentation for more details.

MDCB Synchroniser

Tyk Gateway v4.1 enables an improved synchroniser functionality within Multi Data Center Bridge (MDCB) v2.0. Prior to this release, the API keys, certificates and OAuth clients required by worker Gateways were synchronised from the controller Gateway on-demand. With Gateway v4.1 and MDCB v2.0 we introduce proactive synchronisation of these resources to the worker Gateways when they start up. This change improves resilience in case the MDCB link or controller Gateway is unavailable, because the worker Gateways can continue to operate independently using the resources stored locally. There is also a performance improvement, with the worker Gateways not having to retrieve resources from the controller Gateway when an API is first called. Changes to keys, certificates and OAuth clients are still synchronised to the worker Gateways from the controller when there are changes and following any failure in the MDCB link.

Go Plugin Loader

When upgrading your Tyk Installation you need to re-compile your plugin with the new version. At the moment of loading a plugin, the Gateway will try to find a plugin with the name provided in the API definition. If none is found then it will fallback to search the plugin file with the name: {plugin-name}_{Gw-version}_{OS}_{arch}.so From v4.1.0 the plugin compiler automatically names plugins with the above naming convention. It enables you to have one directory with different versions of the same plugin. For example:

• plugin_v4.1.0_linux_amd64.so
• plugin_v4.2.0_linux_amd64.so

So, if you upgrade from Tyk v4.1.0 to v4.2.0 you only need to have the plugins compiled for v4.2.0 before performing the upgrade.

​

Changelog

Added

• Added support for new OAS api definition format, and new API creation screens
• Dashboard boostrap instalation script extended to support SQL databases
• Added TYK_DB_OMITCONFIGFILE option for Tyk Dashboard to ignore the values in the config file and load its configuration only from environment variables and default values
• Added a new config option identity_broker.ssl_insecure_skip_verify that will allow customers using the embedded TIB to use IDPs exposed with a self signed certificate. Not intended to be used in production, only for testing and POC purposes.
• Added option to configure certificates for Tyk Dashboard using environment variables.

Changed

• Detailed information about certificates can be viewed from certificates listing page
• Dashboard APIs GQL Playground now shows additional information about certificates
• Dashboard will now use default version of GraphiQL Playground which can switch between light and dark modes for more accessibility
• Banner for resyncing GraphQL schema has been given a new, more accessible look in line with the rest of Dashboard design

Fixed

• Fixed an issue with key lookup where keys were not being found when using the search field
• Fixed an issue with object types dropdown in Universal Data Graph config, where it wasn’t working correctly when object type UNION was chosen
• Fixed an issue in Universal Data Graph which prevented users from injecting an argument value or parameter value in the domain part of the defined data source upstream URL

​

Updated Versions

Tyk Dashboard 4.1 Tyk MDCB 2.0.1

​

Upgrade process

Follow the standard upgrade guide, there are no breaking changes in this release. If you want switch from MongoDB to SQL, you can use our migration tool, but keep in mind that it does not yet support the migration of your analytics data.

​

4.0 Release Notes

​

4.0.0 Release Notes

​

Release Highlights

GraphQL federation

As we know, ease-of-use is an important factor when adopting GraphQL. Modern enterprises have dozens of backend services and need a way to provide a unified interface for querying them. Building a single, monolithic GraphQL server is not the best option. It is hard to maintain and leads to a lot of dependencies and over-complication. To remedy this, Tyk 4.0 offers GraphQL federation that allows the division of GraphQL implementation across multiple backend services, while still exposing them all as a single graph for the consumers. Subgraphs represent backend services and define a distinct GraphQL schema. A subgraph can be queried directly, as a separate service or federated in the Tyk Gateway into a larger schema of a supergraph – a composition of several subgraphs that allows execution of a query across multiple services in the backend. Federation docs Subgraphs and Supergraphs docs

GraphQL subscriptions

Subscriptions are a way to push data from the server to the clients that choose to listen to real-time messages from the server, using the WebSocket protocol. There is no need to enable subscriptions separately; Tyk supports them alongside GraphQL as standard. With release 4.0, users can federate GraphQL APIs that support subscriptions. Federating subscriptions means that events pushed to consumers can be enriched with information from other federated graphs. Subscriptions docs

SQL database support

The other major capability in Tyk 4.0 is that the Tyk Dashboard can store its data in a SQL relational database. Until now, Tyk Dashboard has used MongoDB for storing everything from data such as APIs, policies and users through to analytics and logs. MongoDB is still a great storage choice for most projects. However, not all users have MongoDB as part of their tech stack. Some are in heavily regulated industries which means adding it would be a pain. For others, the document storage type and lack of proper ACID transaction support may not be the best solution. These users can now choose a SQL database solution instead. From version 4.0, Tyk Dashboard and Tyk Pump will support four data storage layers, which can be configured separately, each with a different officially supported database solution (if needed). All data stored in SQL databases will provide the same information in the Dashboard that MongoDB did. While SQL support for Tyk products does not depend on specific database features, with this release, we will provide official support for PostgreSQL DB for production purposes, and SQLite for development and PoC environments. Note that SQL support is available for self-managed setups only. As part of SQL support we are also providing tooling to perform seamless migration of your Dashboard data from Mongo to SQL. However, at the moment migration of analytics data is not supported. MongoDB to SQL migration docs

​

Changelog

• Now it is possible to configure GraphQL upstream authentication, in order for Tyk to work with its schema
• JWT scopes now support arrray and comma delimiters
• Go plugins can be attached on per-endpoint level, similar to virtual endpoints

​

Updated Versions

Tyk Dashboard 4.0 Tyk Pump 1.5

​

Upgrade process

Follow the standard upgrade guide, there are no breaking changes in this release. If you want switch from MongoDB to SQL, you can use our migration tool, but keep in mind that it does not yet support the migration of your analytics data.

​

3.2 Release Notes

​

3.2.0 Release Notes

​

Release Notes

Bring your own Identity Provider - Dynamic Client Registration now available!

DCR is a protocol of the Internet Engineering Task Force put in place to set standards in the dynamic registration of clients with authorization servers. This feature is a way for you to integrate your Tyk Developer Portal with an external identity provider such as Keycloak, Gluu, Auth0 or Okta. The portal developer won’t notice a difference. However, when they create the app via Tyk Developer portal, Tyk will dynamically register that client on your authorization server. This means that it is the Authorization Server that will issue the Client ID and Client Secret for the app. Check our DCR docs here We also took this opportunity to give a refresh to the portal settings UI so let us know if you like it!

GraphQL and UDG improvements

We’ve updated the GraphQL functionality of our Universal Data Graph. You’re now able to deeply nest GraphQL & REST APIs and stitch them together in any possible way. Queries are now possible via WebSockets and Subscriptions are coming in the next Release (3.3.0). You’re also able to configure upstream Headers dynamically, that is, you’re able to inject Headers from the client request into UDG upstream requests. For example, it can be used to access protected upstreams. We’ve added an easy to use URL-Builder to make it easier for you to inject object fields into REST API URLs when stitching REST APIs within UDG. Query-depth limits can now be configured on a per-field level. If you’re using GraphQL upstream services with UDG, you’re now able to forward upstream error objects through UDG so that they can be exposed to the client.

Extendable Tyk Dashboard permissions system

The Tyk Dashboard permission system can now be extended by writing custom rules using an Open Policy Agent (OPA). The rule engine works on top of the Tyk Dashboard API, which means you can control not only access rules, but also the behavior of all Dashboard APIs (except your public developer portal). You can find more details about OPA here. In addition, you can now create your own custom permissions using the Additional Permissions API or by updating security.additional_permissions map in the Tyk Dashboard config, and writing Opa rule containing logic for the new permission.

​

Changelog

In addition to the above, version 3.2 includes all the fixes that are part of 3.0.5 https://github.com/TykTechnologies/tyk/releases/tag/v3.0.5

​

Updated Versions

Tyk Dashboard 3.2

​

Upgrade process

If you already have GraphQL or UDG APIs you need to follow this upgrade guide.

​

3.1 Release Notes

​

3.1.0 Release Notes

​

Release Highlights

Identity Management UX and SAML support

You will notice that the experience for creating a new profile in the Identity management section of the dashboard was changed to a ‘wizard’ approach which reduces the time it takes to get started and configure a profile. In addition, users are now able to use SAML for the dashboard and portal login, whether you use TIB(Tyk Identity Broker) internally or externally of the dashboard. This follows the recent changes that we have made to embed TIB (Tyk Identity Broker)in the dashboard. See 3.0 release notes for more information regarding this. To learn more see the documentation

UDG (Universal Data Graph) & GraphQL

Schema Validation

For any GraphQL API that is created via Dashboard or through our API, the GraphQL schema is now validated before saving the definition. Instant feedback is returned in case of error.

Sync / Update schema with upstream API (Proxy Only Mode)

If you’ve configured just a proxy GraphQL API, you can now keep in sync the upstream schema with the one from the API definition, just by clicking on the Get latest version button on the Schema tab from API Designer Docs here

Debug logs

You can now see what responses are being returned by the data sources used while configuring a UDG (universal data graph). These can be seen by calling the /api/debug API or using the playground tab within API designer. The data that will be displayed will show information on the query before and after the request to a data source happens, as follows: Before the request is sent: Example log message: “`Query.countries: preSendHttpHook executed”. Along with this message, the log entry will contain the following set of fields: Typename, Fieldname and Upstream url; After the request is sent: Example log message: “Query.countries: postReceiveHttpHook executed”. Along with this message, the log entry will contain the following set of fields: Typename, Filename, response body, status code. Example: {"typename": "Query", "fielname": "countries", "response_body": "{\"data\":{}}", "status_code": 200} Docs here

Portal

GraphQL Documentation

Documentation for the GraphQL APIs that you are exposing to the portal is available now through a GraphQL Playground UI component, same as on the playground tab of API Designer. Also to overcome the CORS issues that you might encounter while testing documentation pages on the portal, we have pre-filled the CORS settings section in API Designer with explicit values from the start. All you need to do is to check the “Enable CORS” option.

Portal - API key is hidden in email

You now have the option to hide the API key in the email generated after you approve the key request for a developer. Docs here

​

Changelog

The 3.1 version includes the fixes that are part of 3.0.1. https://github.com/TykTechnologies/tyk/releases/tag/v3.0.1

​

Updated Versions

• Tyk Dashboard 3.1

​

3.0 Release Notes

​

3.0.0 Release Notes

​

Release Highlights

Version changes and LTS releases

We have bumped our major Tyk Gateway version from 2 to 3, a long overdue change as we’ve been on version 2 for 3 years. We have also changed our Tyk Dashboard major version from 1 to 3, and from now on it will always be aligned with the Tyk Gateway for major and minor releases. The Tyk Pump has also now updated to 1.0, so we can better indicate major changes in future. Importantly, such a big change in versions does not mean that we going to break backward compatibility. More-over we are restructuring our internal release strategy to guarantee more stability and to allow us to deliver all Tyk products at a faster pace. We aim to bring more clarity to our users on the stability criteria they can expect, based on the version number. Additionally we are introducing Long Term Releases (also known as LTS). Read more about this changes in our blog post: https://tyk.io/blog/introducing-long-term-support-some-changes-to-our-release-process-product-versioning/

New Look and Feel

We have a brand new look to our Tyk Dashboard. About half a year ago, we made some changes to our visual branding to better express our love for creativity and great UX. Those changes started with our website and now we are also incorporating these visual changes into the UI of our products. We do this to keep our brand consistent across the whole Tyk experience and to enhance your experience using our products. See our updated Tutorials section.

Universal Data Graph and GraphQL

Tyk now supports GraphQL natively. This means Tyk doesn’t have to use any external services or process for any GraphQL middleware. You can securely expose existing GraphQL APIs using our GraphQL core functionality. In addition to this you can also use Tyk’s integrated GraphQL engine to build a Universal Data Graph. The Universal Data Graph (UDG) lets you expose existing services as one single combined GraphQL API. All this without even have to build your own GraphQL server. If you have existing REST APIs all you have to do is configure the UDG and Tyk has done the work for you. With the Universal Data Graph (UDG), Tyk becomes the central integration point for all your internal and external APIs. It also benefits from the full set of capabilities included with your Tyk installation—meaning your data graph is secure from the start and can take advantage of a wide range of out-of-the-box middleware to power your graph. Read more about the GraphQL and Universal Data Graph

Policies and Keys UX changes

We have a lot to update you on with our UX & UI revamp, but one thing we want to highlight here are the updates to the policies and keys Dashboard pages. We know there was confusion in the way we set policies and keys up in the Tyk Dashboard, so we redesigned the UI workflow to make it less error-prone, simpler and more intuitive when you create, view and edit security policies and keys. When you create, view or edit a key the steps are in a more logical order. We’ve removed the long form that needed to be filled out and replaced it with tabs so you can find and enter information easily. We’ve also grouped all information within each API so you know the exact set up of each of your access rights without any confusion. The new workflow should allow tasks to be completed faster and more efficiently. See updated tutorials on how to create a policy and keys We also have a blog post that explains what we’ve done, and why we did it.

Tyk Identity broker now built-in to the Dashboard

Previously you had to run a separate process to setup SSO (single sign on). Now this functionality is built-in to the dashboard and got UI revamp. So now you can just start the dashboard, and via UI, create a SSO flow, without installing 3-rd party components. Including SSO via social logins, OpenID Connect and LDAP (with SAML coming very soon!) including integration with the Dashboards RBAC and your Identity Provider. See updated flow details

Using external secret management services

Want to reference secrets from a KV store in your API definitions? We now have native Vault & Consul integration. You can even pull from a tyk.conf dictionary or environment variable file. Read more

Co-Process Response Plugins

We added a new middleware hook allowing middleware to modify the response from the upstream. Using response middleware you can transform, inspect or obfuscate parts of the response body or response headers, or fire an event or webhook based on information received by the upstream service. At the moment the Response hook is supported for Python and gRPC plugins.

Enhanced Gateway health check API

Now the standard Health Check API response include information about health of the dashboard, redis and mdcb connections. You can configure notifications or load balancer rules, based on new data. For example, you can be notified if your Tyk Gateway can’t connect to the Dashboard (or even if it was working correctly with the last known configuration). Read More

Enhanced Detailed logging

Detailed logging is used in a lot of the cases for debugging issues. Now as well as enabling detailed logging globally (which can cause a huge overhead with lots of traffic), you can enable it for a single key, or specific APIs. New detailed logging changes are available only to our Self-Managed customers currently. Read More

Better Redis failover

Now, if Redis is not available, Tyk will be more gracefully handle this scenario, and instead of simply timing out the Redis connection, will dynamically disable functionality which depends on redis, like rate limits or quotas, and will re-enable it back once Redis is available. The Tyk Gateway can even be started without Redis, which makes possible scenarios, such as when the Gateway proxies Redis though itself, like in a Redis Sentinel setup.

Weight-Based Load Balancing

The Tyk Dashboard now allows you to control weighting of the upstreams, when using load balancing functionality. For example now you can configure Tyk to send 20% of traffic to one upstream, with 80% to another upstream service. This enables you to perform Canary or A/B tests of their APIs and services. Similarly, if caches require warming, then we can send a low % of traffic to these services, and when confident that they can handle the load, start incrementally sending a higher % of traffic to these services. Read More

Ability to shard analytics to different data-sinks

In a multi-org deployment, each organization, team, or environment might have their preferred analytics tooling. At present, when sending analytics to the Tyk Pump, we do not discriminate analytics by org - meaning that we have to send all analytics to the same database - e.g. MongoDB. Now the Tyk Pump can be configured to send analytics for different organizations to different places. E.g. Org A can send their analytics to MongoDB + DataDog. But Org B can send their analytics to DataDog + expose the Prometheus metrics endpoint. It also becomes possible to put a blocklist in-place, meaning that some data sinks can receive information for all orgs, whereas others will not receive OrgA’s analytics if blocked. This change requires updating to new Tyk Pump 1.0 Read More

404 Error logging - unmatched paths

Concerned that client’s are getting a 404 response? Could it be that the API definition or URL rewrites have been misconfigured? Telling Tyk to track 404 logs, will cause the Tyk Gateway to produce error logs showing that a particular resource has not been found. The feature can be enabled by setting the config track_404_logs to true in the gateway’s config file.

​

Changelog

• Fixed the bug when tokens created with non empty quota, and quota expiration set to Never, were treated as having unlimited quota. Now such tokens will stop working, once initial quota is reached.

​

Updated Versions

• Tyk Dashboard 3.0
• Tyk Pump 1.0

​

Upgrading From Version 2.9

No specific actions required. If you are upgrading from version 2.8, please read this guide

​

Further Information

​

Upgrading Tyk

Please refer to the upgrading Tyk page for further guidance on the upgrade strategy.

​

API Documentation

• OpenAPI Document
• Postman Collection

​

FAQ

Please visit our Developer Support page for further information relating to reporting bugs, upgrading Tyk, technical support and how to contribute.