Tyk Dashboard 5.5 Release Notes
Last updated: 6 minutes read.
This page contains all release notes for version 5.5.X displayed in a reverse chronological order
Support Lifetime
Our minor releases are supported until our next minor comes out.
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 |
3rd Party Dependencies & Tools
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
-
docker pull tykio/tyk-dashboard:v5.5.2
- Helm charts
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 |
3rd Party Dependencies & Tools
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
-
docker pull tykio/tyk-dashboard:v5.5.1
- Helm charts
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 |
3rd Party Dependencies & Tools
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
-
docker pull tykio/tyk-dashboard:v5.5.0
- Helm charts
Changelog
Added
-
Configure the new endpoint level rate limits in API Designer
Rate limits can now be configured at the endpoint level in Tyk OAS and Tyk Classic API definitions. Configure these new more granular controls from the API Designer.
-
Improved handling of requests to non-existent versions of APIs when using URL path versioning
When configuring API versioning settings for Tyk OAS APIs, you can now set a Version Identifier Pattern when using the URL path to indicate the API version (for example
/v1/my-api
). This will be used to avoid accidentally stripping part of the target URL (and failed upstream proxy) if the client doesn’t provide any version identifier. If you’re using Tyk Classic APIs you can set theurl_versioning_pattern
field in the API definition using the raw API editor. -
Improved schema editor functionality for GQL APIs
We’ve expanded the functionality of the schema editor for GQL APIs. Users can now easily import their schema from a file, export it, or quickly clean the entire editor if a mistake is made.
Changed
-
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
Addressed a problem where Response Plugins were not being invoked for Tyk OAS APIs.
-
Save API button now visible for SSO users
Addressed an issue for SSO users where user permissions were not correctly applied. This led to the Save API button not being visible to all appropriate users in the API Designer.
-
Public playground schema exposure fixed with Introspection disabled
Resolved an issue where the Public GQL Playground displayed schema information despite introspection being turned off. Now, schema details are hidden unless valid authentication credentials are provided, ensuring a secure and consistent user experience.
-
Resolved issue with no analytics data showing on Endpoint Popularity page
Addressed an issue where the Dashboard displayed a blank pane when accessing the Activity by Endpoint page after upgrading to Tyk 5.3.1.
Security Fixes
-
High priority CVEs fixed
Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:
Further Information
Upgrading Tyk
Please refer to the upgrading Tyk page for further guidance on the upgrade strategy.
API Documentation
FAQ
Please visit our Developer Support page for further information relating to reporting bugs, upgrading Tyk, technical support and how to contribute.