dashboard.mdx

---
title: "Tyk Dashboard Release Notes"
description: "Release notes documenting updates, enhancements, and changes for Tyk Dashboard."
keywords: "Tyk Dashboard, Release notes, changelog"
sidebarTitle: "Dashboard"
---

{/* Required. oss or licensed. Choose one of the following:
    **Licensed Protected Product**
    Or
    ****Open Source** ([Mozilla Public License](https://github.com/TykTechnologies/tyk/blob/master/LICENSE.md))** */}

**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.12 Release Notes 

### 5.12.0 Release Notes

#### Release Date 06 March 2026

#### Release Highlights

**OpenAPI Specification 3.1 is now supported**

In this release, we are delighted to bring initial support for OAS 3.1, covering:

- Import and validation of OpenAPI 3.1 descriptions using Tyk Dashboard to create Tyk OAS APIs
- OAS 3.1 features:
    - Full JSON Schema Support and $schema keyword
    - The single `example` keyword is deprecated in OAS 3.1
    - `type` can be an array
    - exclusiveMinimum and exclusiveMaximum keywords

We do not yet have support for all new features. For more details, see the [documentation](/api-management/gateway-config-tyk-oas#openapi-specification-3-1).

**Simplified Management of Versioned Tyk OAS APIs**

Managing versioned API hierarchies is now much easier and safer. We've introduced the ability to promote any child API version to become the new base (routing) API directly from the Dashboard UI, seamlessly transferring routing configurations without service disruption.

Additionally, we've improved the experience of deleting a base API. Instead of manually cleaning up orphaned child APIs, you are now presented with clear, intelligent options: promote a child to the new base, delete all associated child APIs together, or leave them as independent APIs. These enhancements eliminate manual cleanup work and give administrators full control over their API lifecycles.

**Enhanced Security with Client Certificate-Token Binding**

To provide an additional layer of security for your APIs, we've introduced Dashboard support for [Client Certificate-Token Binding](/api-management/authentication/bearer-token#client-certificate-token-binding). This feature allows you to form a strict binding association between an Auth Token issued to a client and their specific client certificate.

By ensuring that a token can be used only with its bound certificate, you can significantly reduce the risk of token theft or misuse. You can now easily manage these bindings directly from the Dashboard when creating or modifying keys, with full support for certificate rotation scenarios by allowing multiple certificates to be bound to a single key.

For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.12.0).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies
<a id="dependencies-5.12.0"></a>

| Dashboard Version | Recommended Releases | Backwards Compatibility |
|--------|-------------------|-------------|
| 5.12.0 | MDCB v2.9.0       | MDCB v2.9.0 |
|        | Operator v1.3.0   | Operator v0.17 |
|        | Sync v2.1.6       | Sync v2.1.0 |
|        | Helm Chart v5.1   | Helm all versions |
|        | EDP v1.17.0       | EDP all versions |
|        | Pump v1.14.0      | Pump all versions |
|        | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.11.1"></a>

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| ---------------------- | --------------- | ------------------- | -------- | 
| [GoLang](https://go.dev/dl/)          | 1.24 | 1.24 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x    |  5.x, 6.x, 7.x    | | 
| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 6, 7, 8  | 5, 6, 7, 8  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x  | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.1.2.html) | v3.1.x | v3.1.x | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions
<a id="upgrade-5.12.0"></a>

If you are upgrading to 5.12.0, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.12.0)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.12.0
    ```
- Helm charts
  - [tyk-charts v5.1.0](/developer-support/release-notes/helm-chart#5-1-0-release-notes)

<Note>
Tyk Helm Charts are configured to install the LTS version of Tyk Dashboard. You will need to modify them to install v5.12.0.
</Note>

#### Changelog
<a id="Changelog-v5.12.0" data-scroll-offset></a>

##### Added

<AccordionGroup>

<Accordion title='Added support for OpenAPI 3.1 (OAS v3.1.x)'>
This release introduces initial support for importing and validating OpenAPI 3.1 descriptions to create Tyk OAS APIs. The implementation maintains backward compatibility with OAS 3.0 while adding support for the new JSON Schema 2020-12 validator:

- Added full JSON Schema support, including the `$schema` keyword.
- Added support for defining `type` as an array (e.g., `["string", "null"]`).
- Updated `exclusiveMinimum` and `exclusiveMaximum` to support numeric values instead of booleans, aligning with OAS 3.1 standards.
- Deprecated the single `example` keyword in accordance with the OAS 3.1 specification.

Please note the following limitations in this initial release:
- Conversion from OAS 3.0 to OAS 3.1 is not yet supported.
- Reusable Path Item Objects and the new `mutualTLS` security scheme are not currently supported.
- Tyk Dashboard's API Editor does not yet validate the schema in real-time; validation is performed only when saving the API.
</Accordion>

<Accordion title='Added base API reassignment and intelligent deletion for versioned Tyk OAS APIs'>
This release introduces comprehensive UI and API support for restructuring versioned Tyk OAS API hierarchies, eliminating the manual work previously required to manage orphaned APIs:

- Added the ability to promote a child API to become the new base API directly from the versions table, automatically reassigning the existing base API as a child version.
- Enhanced the API Designer deletion workflow for base APIs to present three options: promote a child to base, delete all child versions (bulk deletion), or leave child APIs orphaned (previous behavior).
- Extended the Dashboard API with a new `PATCH /api/apis/oas/{current-base-api-id}/{next-base-api-id}` endpoint to programmatically convert a child API into the base API.
- Added an optional `purge` parameter to the `DELETE /api/apis/oas/{apiId}` endpoint to enable bulk deletion of all child APIs when a base API is deleted.
</Accordion>

<Accordion title='JSON Log Format Support for Dashboard'>
The Tyk Dashboard now supports [application logging](/api-management/logs#application-logs) in structured JSON format. To enable this feature, set the environment variable `TYK_DB_LOGFORMAT` to `json`.

This feature provides consistency with the Gateway's JSON log format option (introduced in Tyk 5.6.0) and enables better log ingestion by centralized logging systems, SIEM tools, and observability platforms. The configuration is case-insensitive and falls back to the standard text format for any invalid values, ensuring backward compatibility and reliable operation.
</Accordion>

<Accordion title='Full Support for Custom Policy IDs in Dashboard API'>
The Dashboard API's policy management endpoints now support the recommended Policy ID (`id`) for all operations. Previously the API only supported the Policy Database ID (`_id`) for some operations, which could cause problems when  migrating policies between environments. For reasons of backward compatibility, the Policy Database ID is still supported.

Users are advised to avoid duplicate Policy IDs to minimise the risk of ambiguous interpretation.

This enhancement streamlines policy management for users who prefer meaningful, custom identifiers over auto-generated database IDs, while ensuring existing workflows remain unaffected.
</Accordion>

<Accordion title='Added Dashboard support for Client Certificate-Token Binding'>
This release introduces Dashboard UI and API support for managing Client Certificate-Token bindings for APIs secured with a static mTLS allow list. This allows administrators to easily configure enhanced token security:

- Added the ability to bind one or more client certificates to a key (token) when creating or modifying it via the Dashboard.
- Supports binding multiple client certificates to a single key to facilitate certificate rotation scenarios.
- Maintains full backward compatibility with existing keys that do not specify certificate bindings.

Please note that bound certificates must also be present in the client certificate allow list within the API definition to ensure successful validation after the mTLS handshake.
</Accordion>

<Accordion title='Replaced Dynamic mTLS with Certificate Authentication'>
Renamed "Dynamic mTLS" to "Certificate Authentication" across the Tyk Classic and Tyk OAS API Designers and Key Management screens. It is now presented as a standalone authentication method rather than a sub-option of Auth Token, making it more intuitive to configure and aligning the UI with the Gateway's updated configuration structure.
</Accordion>

<Accordion title='Improved middleware visualization in the API Debugger'>
Enhanced the visual timeline in the API Designer's debug panel to make request tracing easier. The "Inspect" tab now clearly differentiates between Request and Response middleware chains with distinct labels and colors, and visually isolates the Reverse Proxy step so you can easily see exactly where the request was sent upstream.
</Accordion>

</AccordionGroup>

##### Fixed

<AccordionGroup>

<Accordion title='Fixed GeoIP Location Data Display in SQL Analytics Storage'>
Resolved issues preventing GeoIP location data from displaying correctly when using SQL storage for analytics. Previously, the Log Browser showed "GeoIP not recognized" for country codes, and geographic traffic filtering returned empty results, even though location data was properly captured and stored in the database. 

The Dashboard can now correctly read and display all geographic information, including country codes, city names, coordinates, and timezone data from SQL storage. Geographic traffic filtering by country code now works as expected, enabling users to analyze traffic patterns by location when using SQL-based analytics storage.
</Accordion>

<Accordion title='Fixed API-Specific Key Retrieval in Dashboard'>
Resolved an issue where the Dashboard's `GET /api/apis/{api_id}/keys` endpoint incorrectly returned all keys in the environment instead of only keys associated with the specified API. Users can now accurately retrieve and manage keys for individual APIs, eliminating confusion in multi-API environments. Note that adding this filtering can cause minor delays in responses to this endpoint when there are many APIs and keys.
</Accordion>

<Accordion title='Issues Associating Client Certificates with API Keys and Policy ID Display'>
Resolved multiple Dashboard UI issues affecting mTLS configuration and policy management:
- **Certificate Authentication Configuration**: Fixed an issue where the Create Key and Edit Key screens would incorrectly require the user to register a client certificate with the key when granting access to an API secured with static mTLS. Additionally, fixed a separate issue where the option to assign the client certificate was not possible when creating a key for an API which has the authentication method changed to use dynamic mTLS. 
- **Policy ID Display Consistency**: Updated the Dashboard UI to consistently display the policy `id` field instead of the MongoDB database `_id` field across all policy listings, detail views, and selection components. This ensures that policy IDs shown in the UI work reliably with JWT `pol` claims regardless of how policies were created (Dashboard UI vs. Operator) or Gateway configuration settings. Copy-to-clipboard functionality now copies the correct `id` field, and policy selection dropdowns use consistent identifiers.

These fixes eliminate confusing certificate linking requirements, ensure consistent dynamic mTLS key creation regardless of when certificate authentication is enabled, provide clearer separation between different mTLS authentication modes, and resolve JWT authentication failures caused by users copying database IDs from the UI instead of the proper policy identifiers.
</Accordion>

<Accordion title='Fixed Certificate Re-use After Swapping in Multi-Auth Keys'>
Resolved an issue where swapping certificates in multi-auth (mTLS + Basic auth) keys prevented the original certificate from being reused. Previously, when updating a key's certificate, the original certificate remained incorrectly associated with the key internally, causing "key with given certificate already found" errors when attempting to reuse that certificate. 

Tyk now properly detaches certificates during key updates, allowing certificates to be freely reused across different keys after being removed from their original association.
</Accordion>

<Accordion title='Improved Experience when License Missing or Expired'>
Fixed inaccurate wording and links on the screen presented on startup when the Dashboard license is missing or has expired.
</Accordion>


</AccordionGroup>

##### Security Fixes

<AccordionGroup>

<Accordion title='Security Vulnerabilities Fixed'> 
Multiple high-severity CVEs have been fixed. 
</Accordion>

</AccordionGroup>

## 5.11 Release Notes 

### 5.11.1 Release Notes 

#### Release Date 13th February 2026

In this release, we have fixed some priority CVEs. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.11.1).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies
<a id="dependencies-5.11.1"></a>

| Dashboard Version | Recommended Releases | Backwards Compatibility |
|--------|-------------------|-------------|
| 5.11.1 | MDCB v2.8.8       | MDCB v2.8.7 |
|        | Operator v1.2.0   | Operator v0.17 |
|        | Sync v2.1.5       | Sync v2.1.0 |
|        | Helm Chart v5.0   | Helm all versions |
|        | EDP v1.15.0       | EDP all versions |
|        | Pump v1.13.3      | Pump all versions |
|        | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.11.1"></a>

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| ---------------------- | --------------- | ------------------- | -------- | 
| [GoLang](https://go.dev/dl/)          | 1.24 | 1.24 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x    |  5.x, 6.x, 7.x    | | 
| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 6, 7, 8  | 5, 6, 7, 8  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x  | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x | v3.0.x | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions
<a id="upgrade-5.11.1"></a>

If you are upgrading to 5.11.1, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.11.1)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.11.1
    ```
- Helm charts
  - [tyk-charts v5.0.0](/developer-support/release-notes/helm-chart#5-0-0-release-notes)

Please note that the Tyk Helm Charts are configured to install the LTS version of Tyk Dashboard. You will need to modify them to install v5.11.1.

#### Changelog
<a id="Changelog-v5.11.1" data-scroll-offset></a>

##### Security Fixes

<AccordionGroup>

<Accordion title='CVE fixed'>
Addressed CVEs reported in dependent libraries, providing increased protection against security
vulnerabilities, including, but not limited to:

- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-15467" target="_blank">CVE-2025-15467</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-69419" target="_blank">CVE-2025-69419</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-61726" target="_blank">CVE-2025-61726</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-61728" target="_blank">CVE-2025-61728</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-68121" target="_blank">CVE-2025-68121</a>

</Accordion>

</AccordionGroup>

### 5.11.0 Release Notes 

#### Release Date 18 December 2025

#### Release Highlights

Tyk 5.11 delivers security enhancements, streamlined developer workflows, and deeper operational visibility - empowering teams to scale their API programs with confidence and efficiency.

**Strengthened API Security & Authentication**
This release advances our security foundation with enhanced JWT authentication capabilities. Teams can now leverage scope-to-policy mapping without requiring default policies, while new support for nested claims enables more granular policy and subject identification. We've also added IP spoofing protection through configurable depth selection in X-Forwarded-For headers, and introduced a new Dashboard API endpoint that allows admins to clear JWKS cache across all connected Gateways.

**Improved Certificate Management & Visibility**
Certificate management becomes more proactive with enhanced visibility showing which APIs are impacted by each certificate, plus highlighting certificates approaching expiry to prevent service disruptions before they occur.

**Enhanced Developer Experience**
API integration gets simpler with automatically populated OpenAPI descriptions that include all accessible URLs based on deployment targets and version identifiers. This reduces integration errors and accelerates time-to-value for API consumers.

**Advanced Operational Control**
Operations teams gain greater flexibility with the ability to temporarily remove targets from upstream load balancers during maintenance windows. Enhanced observability comes through OTel trace propagation to custom gRPC plugins, trace ID inclusion in API traffic logs, and dedicated Gateway latency metrics alongside upstream measurements.

**Stability & User Experience Improvements**
This release also includes important fixes for memory exhaustion issues when Redis logging is enabled, improved consistency between Dashboard and Gateway validation for JWT configurations, and streamlined policy management with standardized Policy ID usage across the platform. Multiple UI improvements enhance the user experience including fixes for API filtering, certificate search functionality, Quick Start onboarding flow, and various dashboard display issues - ensuring a smoother workflow for API management and configuration tasks.

These enhancements collectively strengthen Tyk's position as the platform of choice for organizations requiring enterprise-scale API management with robust security, operational excellence, and developer productivity.
For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.11.0).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies
<a id="dependencies-5.11.0"></a>

| Dashboard Version | Recommended Releases | Backwards Compatibility |
|--------|-------------------|-------------|
| 5.11.0 | MDCB v2.8.7       | MDCB v2.8.7 |
|        | Operator v1.2.0   | Operator v0.17 |
|        | Sync v2.1.5       | Sync v2.1.0 |
|        | Helm Chart v5.0   | Helm all versions |
|        | EDP v1.15.0       | EDP all versions |
|        | Pump v1.13.2      | Pump all versions |
|        | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.10.1"></a>

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| ---------------------- | --------------- | ------------------- | -------- | 
| [GoLang](https://go.dev/dl/)          | 1.24 | 1.24 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x    |  5.x, 6.x, 7.x    | | 
| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 6, 7, 8  | 5, 6, 7, 8  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x  | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x | v3.0.x | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

In this release we've deprecated the [policies.allow_explicit_policy_id](/tyk-oss-gateway/configuration#policies-allow_explicit_policy_id) configuration option. This was previously added to allow the use of custom policy IDs, which is now the default behaviour so this option is redundant.

#### Upgrade instructions
<a id="upgrade-5.11.0"></a>

If you are upgrading to 5.11.0, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.11.0)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.11.0
    ```
- Helm charts
  - [tyk-charts v5.0.0](/developer-support/release-notes/helm-chart#5-0-0-release-notes)

Please note that the Tyk Helm Charts are configured to install the LTS version of Tyk Dashboard. You will need to modify them to install v5.11.0.

#### Changelog
<a id="Changelog-v5.11.0" data-scroll-offset></a>

##### Added

<AccordionGroup>

<Accordion title='Improved Flexibility for Key Expiration Settings'>
We've improved key expiration flexibility in the Tyk Dashboard by adding support for custom expiration periods using human-readable time formats (e.g., "5h,34m,30s"). Users can now input custom timeframes supporting months, weeks, days, hours, and seconds in addition to the existing predefined options, eliminating the previous restriction and removing the need for API calls or manual key revocation for custom expiration times.
</Accordion>

<Accordion title='Open Policy Agent Support for Distinguishing Tyk OAS APIs'>
Added three new OPA helper functions (`isTykOas`, `isTykClassic`, and `isTykStreams`) that can be used in OPA rules to distinguish between different API types, ensuring that logic is only applied to the appropriate API types.
</Accordion>

<Accordion title='Added API Endpoint for Certificate Dependencies'>
Introduced a new Dashboard API endpoint `GET /certs/{certificateId}/apis` that retrieves all APIs linked to a specific certificate. The endpoint returns API names, IDs, and how they are used by each API (client, upstream, server) with proper pagination support, enabling the frontend to display certificate impact information without expensive client-side filtering across all APIs.
</Accordion>

<Accordion title='Improvements in the Dashboard UI'>
- **Proactive Certificate Expiry Notifications in Tyk Dashboard**: Added banner notification to inform the user if the Dashboard has received a certificate expiring soon/expired event from the Gateway. Such certificates are now highlighted on the certificates screen.
- **Improved Automatic Configuration Options for API Creation**: Enhanced the user experience when importing OpenAPI descriptions by replacing checkboxes with toggle switches and improving the wording of configuration options. The new interface provides clearer descriptions for Request Validation, Mock Responses, Authentication Detection, and Path Restrictions.
- **Enhanced Certificate Management with Impact Visibility**: Introduced a new Certificate Details page that displays user-friendly certificate metadata with a toggle between formatted and raw JSON views. The page now shows certificate status indicators (valid, expiring soon, expired) and lists all APIs using the certificate with clickable navigation to their API Designer pages.
</Accordion>

<Accordion title='Improved visibility of API base paths'>
Tyk has always added the base path to the `servers` section of an API's OpenAPI description. Until now, this has been constructed from the address of the local Gateway with the unique listen path for the API. This is not always accessible, for example for child API versions configured for internal access.

Now Tyk will calculate all the URLs where the API can be accessed, adding these to the `servers` section of the OpenAPI description. This takes into account the versioning identifier if URL location is in use (e.g. `<gateway_url>/<listen_path>/v1`) and, where `edge_endpoints` are defined in the Dashboard config, the data plane Gateways where the API is deployed.

We have introduced a new Dashboard API endpoint (`GET /api/apis/oas/{apiID}/urls`) that returns a list of all of these base paths, presented in a structured format including detailed components (protocol, domain, port, listen-path, versioning identifier).

The API Designer uses the data from this endpoint to display all known API URLs and also indicates how to select the specific API version (if applicable) using URL, query parameter or header.
</Accordion>

<Accordion title='Removed Default Policy Requirement for JWT Scope-to-Policy Mapping'>
We’ve removed the need to supply a default policy when using scope-to-policy mapping with JWT Authentication. Now, if you enable scope-to-policy mapping by configuring `scopes.claimName`, you do not need to provide a policy ID in `defaultPolicies`. If a request does not contain any valid scopes, it will be rejected with `HTTP 403 Forbidden` (default deny). You can still provide a default policy if you require a different behaviour.
</Accordion>

<Accordion title='Added JWKS cache flush to the Dashboard API and MDCB'>
Added JWKS cache invalidation endpoint `DELETE /api/cache/jwks/{apiID}` to the Dashboard API to flush JWKS cache for specific APIs across all connected Gateways. This extends the existing Gateway-level JWKS cache flush functionality to work through the Dashboard API with proper MDCB propagation to data plane Gateways. Access is restricted to admin users with API ownership validation, ensuring secure cache management across distributed Gateway deployments.
</Accordion>

</AccordionGroup>

##### Fixed

<AccordionGroup>

<Accordion title='Fixed Dashboard Memory Exhaustion When `use_redis_log` Is Enabled'>
Fixed an issue where enabling `use_redis_log` on a Tyk Gateway could cause the Dashboard to exhaust memory due to unbounded log accumulation from the UI notification endpoint.
</Accordion>

<Accordion title='Dashboard Now Corrects Padding for Base64-Encoded JWKS URLs'>
Fixed an issue where the Dashboard and Gateway had inconsistent validation for base64-encoded JWKS URIs when using JWT authentication. Previously, the Dashboard would accept a URI in the `source` (or `jwt_source` for Tyk Classic) field that was not correctly padded, while the Gateway required correct padding. This could cause an API to be saved successfully in the Dashboard but then fail when processed by the Gateway. The fix has been applied to the Dashboard, which now automatically adds the required padding to the base64-encoded string when the API definition is saved. This resolves the inconsistency and ensures the configuration is valid for the Gateway.
</Accordion>

<Accordion title='Fixed Certificate Filtering Not Working in Non-Detailed Mode'>
Fixed an issue where certificate filtering (`filter=with_pk`, `filter=without_pk`) was only applied in detailed mode, causing inconsistent behavior. Tyk now properly applies filtering in both detailed and non-detailed modes, ensuring consistent results regardless of the mode parameter used.
</Accordion>

<Accordion title='Fixed Policy Deletion Failure When Referenced API No Longer Exists'>
Fixed an issue where the user was unable to delete the policy if the referenced API didn't exist, even though the user had access to the policy before API deletion.
</Accordion>

<Accordion title='Renamed `XTykApiGateway` Schema to Avoid Case-Sensitive Conflicts'>
Renamed `XTykApiGateway` schema to `TykVendorExtension` to eliminate case-only naming conflicts with the existing `XTykAPIGateway` schema. Updated all corresponding $ref references throughout swagger.yml to prevent code generation ambiguity and ensure compatibility across case-insensitive file systems.
</Accordion>

<Accordion title='Standardised Use of Policy IDs Across Tyk Gateway and Dashboard'>
The Tyk Policy object has two identifiers `id` (Policy ID) and `_id` (Policy Database ID). All policy definitions will have a value in `_id` when loaded to the Dashboard, used to identify the object in the persistent storage. Historically, the Policy ID (`id`) has been optional (via the `allow_explicit_policy_id` Gateway configuration), and different Tyk components have used one or the other, leading to inconsistency and scenarios where a policy might be rejected due to the configuration of IDs.
We have simplified the Tyk Gateway to use the Policy ID exclusively, instead of the Policy Database ID, improving consistency across the platform. This means that the `allow_explicit_policy_id` Gateway configuration is now redundant and marked deprecated, as the Policy ID field is always used.
If a policy definition is loaded onto Tyk Dashboard that does not have a Policy ID set, Tyk will automatically set the `id` field to the value in `_id`. There are no changes to the Gateway or Dashboard APIs from this enhancement, ensuring backward compatibility.
</Accordion>

<Accordion title='Dashboard UI Fixes'>
- **Incorrect Data Range Display in Total API Traffic Dashboard Chart**: Fixed an issue where the **Total API Traffic** chart on the **Nodes & Licenses** screen displays data from the wrong time period.
- **TIB User Role Mappings Disappeared on Update**: Fixed a bug that caused TIB profiles to vanish on updates made to `Provider Configuration` advanced settings.
- **Access Tab Selection from Filtered Dropdown**: Fixed an issue where users and categories could not be selected from filtered dropdown lists in the Access tab of the Tyk OAS API designer.
- **Unable to Apply Multiple Filters to API List**: Resolved filtering issues where applying multiple filters (name + category) would drop previously applied filters instead of combining them. Users can now apply multiple filters that work together as expected, with all active filters preserved during pagination and sorting.
- **Data Graph Wizard Incorrectly Displayed**: Fixed an issue where the Data Graph onboarding wizard incorrectly appeared when filters returned zero results - it now only shows when no APIs actually exist in the system, keeping filters visible when results are empty.
- **Incomplete Certificate Search in API Designer**: Fixed an issue when selecting a TLS certificate to attach to a Tyk OAS API (for example, a client certificate for client-gateway mTLS). To improve performance when scrolling through the list of existing certificates, the UI uses pagination to load a subset of certificates at a time. The certificate ID search would only match against the currently loaded page of certificates, so a certificate might not appear to exist when it does, but just hasn't been loaded yet. Now the search functionality has been improved to look through the full list of certificates in the Tyk Certificate Store, rather than relying on the paginated data.
</Accordion>

<Accordion title='Fixed Quick Start API Testing Issues'>
Resolved multiple issues preventing successful API testing in the Quick Start onboarding flow. Users can now test APIs with any response type (JSON, HTML, XML) without encountering HTTP 500 errors or blank response displays.
Additionally, fixed URL handling issues that occurred when gateway endpoints were configured without URL schemas, ensuring the "Test your API" step works reliably regardless of configuration format. 
</Accordion>

<Accordion title='Removed Redundant Boolean Enums from OpenAPI Specification'>
Fixed redundant boolean enum definitions in OpenAPI specification by removing unnecessary enum: [true, false] declarations from boolean type fields in swagger.yml files. Boolean parameters now use only type: boolean, following OpenAPI best practices.
</Accordion>

</AccordionGroup>

## 5.10 Release Notes 

### 5.10.2 Release Notes 

#### Release Date 2 December 2025

#### Release Highlights

This patch release fixes an issue in the API Designer where JWKS cache timeout values could not be saved properly. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.10.2).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies
<a id="dependencies-5.10.2"></a>

| Dashboard Version | Recommended Releases | Backwards Compatibility |
|--------|-------------------|-------------|
| 5.10.2 | MDCB v2.8.6       | MDCB v2.8.6 |
|        | Operator v1.2.0   | Operator v0.17 |
|        | Sync v2.1.4       | Sync v2.1.0 |
|        | Helm Chart v4.1   | Helm all versions |
|        | EDP v1.15.0       | EDP all versions |
|        | Pump v1.13.1      | Pump all versions |
|        | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.10.2"></a>

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| ---------------------- | --------------- | ------------------- | -------- | 
| [GoLang](https://go.dev/dl/)          | 1.24 | 1.24 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x    |  5.x, 6.x, 7.x    | | 
| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 6, 7, 8  | 5, 6, 7, 8  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x  | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x | v3.0.x | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions
<a id="upgrade-5.10.2"></a>

If you are upgrading to 5.10.2, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.10.2)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.10.2
    ```
- Helm charts
  - [tyk-charts v4.1.0](/developer-support/release-notes/helm-chart#4-1-0-release-notes)

Please note that the Tyk Helm Charts are configured to install the LTS version of Tyk Dashboard. You will need to modify them to install v5.10.2.

#### Changelog
<a id="Changelog-v5.10.2" data-scroll-offset></a>

##### Fixed

<AccordionGroup>

<Accordion title='Fix JWKS Cache Timeout Setting in API Designer'>
Fixed an issue where JWKS cache timeout values when configuring JWT authentication could not be saved in the API Designer. The timeout field would appear to accept values, but would disappear after saving the API configuration. Users can now successfully configure and persist JWKS cache timeout settings as expected
</Accordion>

</AccordionGroup>

### 5.10.1 Release Notes 

#### Release Date 19 November 2025

#### Release Highlights

This patch release upgrades the Go build environment and delivers UI, analytics, and security fixes. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.10.1).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies
<a id="dependencies-5.10.1"></a>

| Dashboard Version | Recommended Releases | Backwards Compatibility |
|--------|-------------------|-------------|
| 5.10.1 | MDCB v2.8.5       | MDCB v2.8.5 |
|        | Operator v1.2.0   | Operator v0.17 |
|        | Sync v2.1.4       | Sync v2.1.0 |
|        | Helm Chart v4.0   | Helm all versions |
|        | EDP v1.14.1       | EDP all versions |
|        | Pump v1.13.0      | Pump all versions |
|        | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.10.1"></a>

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| ---------------------- | --------------- | ------------------- | -------- | 
| [GoLang](https://go.dev/dl/)          | 1.24 | 1.24 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x    |  5.x, 6.x, 7.x    | | 
| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 6, 7, 8  | 5, 6, 7, 8  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x  | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x | v3.0.x | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions
<a id="upgrade-5.10.1"></a>

If you are upgrading to 5.10.1, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.10.1)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.10.1
    ```
- Helm charts
  - [tyk-charts v4.0.0](/developer-support/release-notes/helm-chart#4-0-0-release-notes)

Please note that the Tyk Helm Charts are configured to install the LTS version of Tyk Dashboard. You will need to modify them to install v5.10.1.

#### Changelog
<a id="Changelog-v5.10.1" data-scroll-offset></a>

##### Changed

<AccordionGroup>
<Accordion title='Upgraded Go build environment to Debian 12 ("Bookworm")'>
We have updated the Go build environment from Debian 11 ("Bullseye") to Debian 12 ("Bookworm") across all pipelines. This change ensures that all builds use the latest Go 1.24 patch version, addressing recent CVEs and improving overall security and stability.
</Accordion>

</AccordionGroup>

##### Added

<AccordionGroup>

<Accordion title='Enabled Gzip Compression for Static Assets to Improve Dashboard Load Performance'>
Implemented gzip compression for static assets (JavaScript, CSS, images, etc.) when the browser client requests for gzip with the `Accepted-Encoding` header. This significantly reduces the file size transferred when loading the Dashboard, reducing bandwidth usage and improving page load times for users.
</Accordion>

</AccordionGroup>

##### Fixed

<AccordionGroup>

<Accordion title='API Editor UI Glitch When Scrolling in Import Mode'>
Fixed an issue introduced in 5.10.0 where there was a graphical glitch with the code editor in the API Designer.
</Accordion>

<Accordion title='Dashboard Analytics and Monitoring Fixes'>
- **Fixed non-clickable endpoint rows in the Activity page**: Fixed an issue where selecting an endpoint in the "Most Popular Endpoints" list on the "Activity Overview" screen did not direct the user to the "Activity by Endpoint" screen.
- **Fixed incorrect error code descriptions in API activity dashboard**: Error codes now display correct descriptions (409 shows "Conflict" instead of "Rate limit or quota exceeded", and missing descriptions for 502, 504, 499, and 422 have been added).
- **Fixed unicode character display in Activity Logs view**: Non-ASCII characters (Cyrillic, Arabic, Hindi, Telugu, Yoruba, etc.) now display correctly instead of showing garbled text when viewing request/response logs.
- **Fixed date range filtering showing extra day in analytics charts**: Date range selectors now accurately reflect the selected end date instead of automatically including the following day's data in charts and legends.
- **Fixed Log Browser querying wrong tables when SQL table sharding is enabled**: Dashboard now correctly queries sharded tables (tyk_analytics_YYYYMMDD) instead of the main tyk_analytics table when `TYK_DB_STORAGE_LOGS_TABLESHARDING=true` is configured, ensuring analytics data displays properly with SQL database sharding.
- **Fixed incorrect date labels and data aggregation in analytics charts**: Fixed multiple issues in the analytics aggregation layer when using PostgreSQL backend that caused incorrect chart rendering and service problems. Resolved problems, including hourly charts showing nonsensical dates like "30 Nov 1899", monthly charts displaying incorrect months, incomplete time-series data due to improper date padding, and API activity being incorrectly split across multiple rows.
</Accordion>
</AccordionGroup>

##### Security Fixes

<AccordionGroup>

<Accordion title='CVE fixed'>
Fixed the following high-priority CVEs, providing increased protection against security
vulnerabilities:

- <a href="https://www.cve.org/CVERecord?id=CVE-2025-47912" target="_blank">CVE-2025-47912</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58183" target="_blank">CVE-2025-58183</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58185" target="_blank">CVE-2025-58185</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58186" target="_blank">CVE-2025-58186</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58187" target="_blank">CVE-2025-58187</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58188" target="_blank">CVE-2025-58188</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58189" target="_blank">CVE-2025-58189</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-61723" target="_blank">CVE-2025-61723</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-61724" target="_blank">CVE-2025-61724</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-61725" target="_blank">CVE-2025-61725</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-63811" target="_blank">CVE-2025-63811</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-31133" target="_blank">CVE-2025-31133</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-52565" target="_blank">CVE-2025-52565</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-52881" target="_blank">CVE-2025-52881</a>

</Accordion>

</AccordionGroup>

### 5.10.0 Release Notes 

#### Release Date 13th October 2025

#### Release Highlights

For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.10.0).

##### Streamlined API Versioning Experience

The Tyk Dashboard now provides a completely redesigned versioning experience for Tyk OAS APIs, making API version management intuitive and efficient through guided workflows and centralized controls.

**Intuitive version creation**

- **Step-by-step wizard**: Guided process for creating new API versions with clear configuration options at each step
- **Smart configuration cloning**: Choose to inherit settings from existing versions or start fresh
- **Flexible publishing**: Control version activation and Gateway deployment during creation
- **Pre-configuration support**: Set up versioning parameters before creating any versions, preparing APIs for future versioning needs

**Centralized version management**

- **Unified "Versions" tab**: Single location to view and manage all aspects of API versioning
- **Clear configuration visibility**: Version identifier settings, proxy options, and version lists displayed in one organized interface
- **Inline editing**: Modify version names and configuration directly without navigating between screens
- **Consistent experience**: Same interface and capabilities whether working with base or child APIs

**Key benefits**

- Eliminate confusion around version setup and management
- Reduce time spent navigating between different configuration screens
- Enable proactive versioning preparation for future API evolution
- Provide clear visibility into version configuration and relationships

Perfect for teams managing multiple API versions or planning version rollout strategies, this enhancement makes API versioning accessible to users of all experience levels while maintaining the power and flexibility that advanced users require.


##### Certificate Expiry Monitoring and Notifications

The Tyk Dashboard now provides proactive certificate lifecycle management to help prevent service outages caused by expired mTLS certificates.

Proactive monitoring capabilities:
- **Event-driven alerts**: Certificate expiry events are now available in the Tyk OAS API Designer for webhook and event handler configuration
- **Dashboard API notifications**: New endpoint provides programmatic access to certificate status information
  - **Smart monitoring**: Automatic detection of certificates approaching expiry or already expired with configurable warning thresholds
  - **Duplicate prevention**: Intelligent notification system prevents alert flooding while ensuring visibility

**Key benefits**

- Prevent unexpected API outages due to expired certificates
- Enable automated certificate renewal workflows through event handlers
- Provide clear visibility into certificate health across your API infrastructure
- Support integration with existing monitoring and alerting systems

Perfect for organizations managing multiple certificates across complex API infrastructures where manual certificate tracking becomes impractical.

For more details, please see the dedicated [Gateway events](/api-management/gateway-events) section.

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies
<a id="dependencies-5.10.0"></a>

| Dashboard Version | Recommended Releases | Backwards Compatibility |
| :-------- | :------------------- | :------------- |
| 5.10.0 | MDCB v2.8.5       | MDCB v2.8.5 |
|        | Operator v1.2.0   | Operator v0.17 |
|        | Sync v2.1.3       | Sync v2.1.0 |
|        | Helm Chart v4.0   | Helm all versions |
|        | EDP v1.14.1       | EDP all versions |
|        | Pump v1.12.2      | Pump all versions |
|        | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.10.0"></a>

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| :---------------------- | :--------------- | :------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)          | 1.24 | 1.24 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x    |  5.x, 6.x, 7.x    | | 
| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 6, 7, 8  | 5, 6, 7, 8  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x  | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x | v3.0.x | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions
<a id="upgrade-5.10.0"></a>

If you are upgrading to 5.10.0, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.10.0)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.10.0
    ```
- Helm charts
  - [tyk-charts v4.0.0](/developer-support/release-notes/helm-chart#4-0-0-release-notes)

Please note that the Tyk Helm Charts are configured to install the LTS version of Tyk Dashboard. You will need to modify them to install v5.10.0.

#### Changelog
<a id="Changelog-v5.10.0" data-scroll-offset></a>

##### Added



<AccordionGroup>
<Accordion title='Enhanced versioning experience for Tyk OAS APIs'>
Completely redesigned the versioning experience for Tyk OAS APIs with an intuitive wizard-driven workflow and centralized version management interface.

**New version creation wizard**

- **Guided configuration process**: Step-by-step wizard for creating new API versions with clear decision points
- **Configuration cloning options**: Choose whether to clone settings from an existing version, with selection from available versions when multiple exist
- **Version identifier setup**: Configure version location (header, URL path, query parameter) and key name if not already set
- **Publishing controls**: Decide whether to immediately activate the new version and select target Gateways using segment tags

**Centralized version management**

- **New "Versions" tab**: Unified interface displaying version identifier configuration and complete version list for both base and child APIs
- **Pre-configuration support**: Set up version identifier location, key name, and proxy options before creating any child versions, preparing non-versioned APIs to become base APIs
- **Clear configuration visibility**: Version identifier and proxy settings prominently displayed above the version list
- **Inline editing capabilities**: Edit version names directly for any API version, and modify versioning configuration from the base API
- **Streamlined access**: Create new versions from any API (base or child) with direct access to the creation wizard

**Improved user experience**

- Removed legacy version management screens that were difficult to locate
- Consistent versioning interface across all Tyk OAS APIs
- Reduced complexity in version setup and management workflows

This enhancement significantly simplifies API versioning workflows and provides better visibility into version configuration and management.
</Accordion>

<Accordion title='Certificate expiry notifications and event handling'>
Added certificate expiry monitoring capabilities to help administrators proactively manage certificate lifecycles and prevent service outages.

**Event handling integration**

- Certificate expiry events (`CertificateExpiringSoon` and `CertificateExpired`) are now available as selectable options in the event handling section, enabling users to assign webhooks or other event handlers directly through the UI

**Dashboard notifications system**

- **Proactive notification endpoint**: New `GET /api/org/notifications` Dashboard API endpoint provides organization-specific notifications for expiring and expired certificates
- **Smart monitoring**: In-memory notification repository automatically checks certificate metadata storage and creates notifications for certificates approaching expiry or already expired
- **Configurable thresholds**: Dashboard configuration options for refresh intervals and warning thresholds:

**Notification details**

- **Severity classification**: Notifications marked as "warning" for soon-to-expire certificates or "critical" for expired certificates
- **Rich metadata**: Each notification includes certificate ID, expiry date, days remaining, and other relevant details
- **Duplicate prevention**: Hash-based system prevents duplicate notifications for the same certificate status

**Note:** This release provides the foundational API and event integration for certificate monitoring. Enhanced UI functionality for certificate management will be available in a future release.

This enhancement provides multiple layers of certificate expiry visibility through Gateway events and API-based notifications, ensuring administrators can maintain certificate health across their API infrastructure.
</Accordion>

<Accordion title='Enhanced JWT claims configuration for Tyk OAS APIs'>
Updated the Tyk OAS API Designer to support multiple claim sources for JWT authentication, enabling multi-Identity Provider scenarios where different providers use different claim names.

**UI enhancements**

- **Multiple subject claims**: Replace the single "Subject identity claim" field with support for multiple claim sources
- **Multiple policy claims**: Replace the single "Policy claim" field with support for multiple claim mapping sources
- **Multiple scope claims**: Replace the single "Scope claim" field with support for multiple scope claim sources

**Current implementation**

- Updated API editor schema to accept the new multi-value claim fields
- Multi-value claim configuration available through the API Designer interface
- Advanced JWT validation features (custom claims framework, issuer/audience/subject validation, JWT ID enforcement) must be configured directly in the API definition via the API editor or external API calls
- Existing single-value configurations remain functional for backward compatibility

This enhancement supports scenarios where different Identity Providers use different claim names (e.g., Keycloak's `scope` vs Okta's `scp`) within the same API configuration, laying the foundation for comprehensive JWT claim validation workflows.

**Note:** Full API Designer integration for these fields will be available in a future release.
</Accordion>

<Accordion title='OpenAPI compliant multi-authentication configuration for Tyk OAS APIs'>
Added initial support for OpenAPI Specification compliant multi-authentication configuration in Tyk OAS APIs, enabling flexible authentication workflows that follow standard OpenAPI security patterns.

**UI enhancements**

- We have added a new toggle in the Tyk OAS API Designer's *Server > Authentication* section to choose between "legacy" and "compliant" authentication processing modes when Multiple Authentication Methods is selected:
  - **Legacy mode**: Existing configuration interface remains available for legacy mode behavior (AND logic for all authentication methods)
  - **Compliant mode**: Users selecting compliant mode are directed to configure authentication directly in the API editor for full OpenAPI security specification support

**Current implementation**

- Manual configuration of compliant mode security settings available through the API definition editor
- OpenAPI import with automatic authentication configuration continues to configure legacy mode by default (no change to existing behavior)
- Advanced authentication combinations (OR logic between security entries) must be configured directly in the API definition

This enhancement provides the foundation for OpenAPI compliant authentication workflows while maintaining complete backward compatibility with existing authentication configurations.

**Note:** Full integration for compliant mode authentication configuration will be available in a future release.
</Accordion>
</AccordionGroup>




##### Changed



<Expandable title='Upgrade Tyk Dashboard to Golang 1.24'>
The Tyk Dashboard has been updated to [Golang 1.24](https://tip.golang.org/doc/go1.24), improving security by staying current with the latest Go versions.
</Expandable>





##### Fixed




<AccordionGroup>
<Accordion title='Fixed Policy and Key Management UI for versioned APIs'>
Fixed UI issues in policy and key management that caused confusion and unnecessary validation errors. The API Versions field in the Dashboard UI now appears only when relevant - specifically for versioned Tyk Classic APIs. 

The field is no longer displayed for Tyk OAS APIs or non-versioned Tyk Classic APIs, eliminating confusion about when version selection is required and preventing policies and keys from failing to save due to irrelevant validation requirements.
</Accordion>

<Accordion title='Fixed issues with Tyk OAS API Debugger'>
Fixed some issues in the Tyk OAS API Debugger (Test Your API panel) when inspecting API tests:

- The debugger only displayed request middleware execution, omitting response middleware from the debug output
- The debugger did not show the details of the transformations applied by Request Body Transform and Request Header Transform middleware
- The debugger incorrectly reported errors for endpoints using Response Body Transform middleware, even when API calls completed successfully

The test debugger now correctly shows both request and response middleware execution, accurately displays the execution status, and eliminates false error messages that could mislead developers during API testing and troubleshooting.
</Accordion>

<Accordion title='Fixed Dashboard default page_size behavior'>
Fixed an issue where the Tyk Dashboard did not correctly apply a default `page_size` value when none was specified in the Dashboard configuration, potentially causing unexpected pagination behavior. 

The Dashboard now properly defaults to a page size of 10 items as documented, ensuring consistent and predictable pagination across all Dashboard views.
</Accordion>

<Accordion title='Fixed multiple issues with the creation of child versions of Tyk OAS APIs'>
Fixed several issues that affected the creation of new child versions of Tyk OAS APIs to ensure reliable version creation and proper validation:

UI and API Creation:
- Resolved an issue that prevented users from creating new versions via the API Designer's Manage Versions screen
- Added validation for the `base_api_id` parameter - providing a non-existent ID would previously create the API successfully, but leave it invisible in the Dashboard UI
- Added stricter validation for version names - users can no longer create API versions without specifying a valid `new_version_name`, preventing unusable or empty version entries
- Improved error messaging when the `base_api_version_name` parameter is missing or incorrectly specified

Version Management:
- Fixed an issue where creating new child versions would incorrectly reset the default version back to the base API, overriding previously configured settings

The system now provides comprehensive validation with clear error responses (`HTTP 400 Bad Request` and `HTTP 422 Unprocessable Entity`), ensures that all API versions have meaningful identifiers, and maintains proper default version settings during the creation of child versions.
</Accordion>

<Accordion title='Fixed `/versions` endpoint to only accept valid Tyk OAS base APIs'>
Fixed an issue where the `/api/apis/oas/{apiId}/versions` endpoint incorrectly returned version data for Tyk Classic APIs and non-versioned Tyk OAS APIs. The endpoint now properly validates requests and returns `HTTP 422 Unprocessable Entity` when the target API is not a valid Tyk OAS base API, ensuring the endpoint only returns meaningful version information.
</Accordion>

<Accordion title='Fixed OpenAPI `servers` section handling for regex-based custom domains'>
Fixed an issue where custom domains containing regular expressions were not correctly parsed and stored in the `servers` section of OpenAPI descriptions for Tyk OAS APIs. The Dashboard now properly converts regex-based domains into valid OpenAPI `servers` entries with appropriate variables, ensuring accurate API documentation and preventing validation errors during API editing. 

This fix includes enhanced syntax validation for regular expression (regex) patterns and improved capture group handling, which previously could cause Gateway crashes.
</Accordion>

<Accordion title='Fixed delayed application of global webhook changes for Tyk OAS APIs'>
Fixed an issue where updates to [global webhooks](/api-management/gateway-events#local-and-global-webhooks) were not immediately applied to Tyk OAS APIs using those webhooks. When global webhook configurations were modified, the Gateway would continue using the previous settings for affected Tyk OAS APIs until a manual reload occurred. 

The system now automatically triggers a Gateway reload for all impacted Tyk OAS APIs when global webhook configurations are updated, ensuring that the new webhook settings take effect immediately.
</Accordion>

<Accordion title='Fixed cross-interface compatibility for keys and policies with Tyk OAS and non-versioned Tyk Classic APIs'>
Fixed an issue where keys and policies created or updated via the Dashboard API were sometimes rejected by the Dashboard UI, and vice versa, due to inconsistent handling of the `versions` field for non-versioned Tyk Classic APIs. The issue occurred because the API and UI used different formats when populating the versions list in access rights. 

Both interfaces now consistently accept either `null` or `[]` (empty array) values in the `versions` field of the access control list, ensuring seamless interoperability between API and UI workflows for policy and key management. Tyk OAS APIs use a [different approach](/api-management/api-versioning#how-api-versioning-works-with-tyk) to versioning, with each (base or child) version having a unique API ID that is added to the access list.
</Accordion>

<Accordion title='Fixed visibility of orphaned Tyk OAS API versions when using PostgreSQL'>
Fixed an issue where orphaned child versions of a Tyk OAS API would disappear from the Dashboard UI after their base API was deleted, specifically when using PostgreSQL as the datastore. 

Orphaned Tyk OAS API versions now remain visible in the Dashboard, ensuring consistent behavior across all supported datastores and preventing loss of access to existing API versions.
</Accordion>

<Accordion title='Fixed inconsistent ordering of Tyk OAS API versions in Dashboard UI'>
Fixed an issue where the child versions of a Tyk OAS API were sorted by creation date in the **Created APIs** and alphabetically by version name (e.g., v1, v2) in the **Versions** list. 

Now versions are always sorted alphabetically by version name, providing predictable and controllable ordering.
</Accordion>

<Accordion title='Fixed Dashboard API panic when accessing logs without timestamp parameters in PostgreSQL'>
Fixed an issue where the Tyk Dashboard API would panic and return `HTTP 500 Internal Server Error` when accessing the `/api/logs` endpoint without the required `start` and `end` timestamp parameters in PostgreSQL environments using table sharding. 

The API now properly handles missing parameters by returning `HTTP 400 Bad Request` with a descriptive error message, improving error handling and API reliability.
</Accordion>

<Accordion title='Fixed PATCH endpoint validation to reject Tyk OAS API definitions when expecting OpenAPI description'>
Fixed an inconsistency where the Dashboard API's `PATCH /api/apis/oas/{apiId}` endpoint incorrectly accepted full Tyk OAS API definitions containing Tyk Vendor Extensions, when it should only accept standard OpenAPI descriptions. 

The endpoint now properly validates incoming requests and returns `HTTP 400 Bad Request` if the Tyk Vendor Extension is present, ensuring consistent behavior with the Dashboard UI and maintaining the intended separation between OpenAPI description updates and full API configuration changes.
</Accordion>

<Accordion title='Fixed incorrect creation of duplicate or blank API categories'>
Fixed an issue where duplicate or blank API categories could be created for Tyk OAS APIs when using the Dashboard API's `PUT /api/apis/oas/{API_ID}/categories` endpoint. Now, if blank or duplicate category labels are provided in the body of the `PUT` request, these will be ignored. 

This matches the validation in the API Designer which does not allow blank or duplicated categories to be assigned to APIs.
</Accordion>

<Accordion title='Fixed GraphQL API creation via upstream introspection when OPA rules modify requests'>
Fixed an issue where creating GraphQL APIs using upstream introspection in the Dashboard could fail with `HTTP 502 Bad Gateway` errors when OPA rules (typically using `patch_request`) modified the introspection request body. 

The problem occurred because the Dashboard did not recalculate the `Content-Length` header after OPA modifications, causing length mismatches that resulted in proxy errors. The Dashboard now properly recalculates the content length for modified introspection requests, ensuring reliable GraphQL API creation regardless of OPA rule configurations.
</Accordion>
</AccordionGroup>





##### Security Fixes


<Expandable title='High priority CVEs fixed'>
Fixed the following high-priority CVEs identified in the Tyk Dashboard, providing increased protection against security
vulnerabilities:<br />
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2024-47875" target="_blank">CVE-2024-47875</a><br />
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2024-45801" target="_blank">CVE-2024-45801</a>
</Expandable>




## 5.9 Release Notes 

### 5.9.2 Release Notes

#### Release Date 5th September 2025

#### Release Highlights

This release fixes a compatibility issue between MDCB and Dashboard where APIs containing dots (.) in their paths were not handled correctly in MDCB. API definitions are now processed consistently with the Dashboard, ensuring middleware works as expected across all gateways.

For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.9.2).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies

| Dashboard Version | Recommended Releases | Backwards Compatibility |
| :-------- | :------------------- | :------------- |
| 5.9.2  | MDCB v2.8.4       | MDCB v2.8.4 |
|        | Operator v1.2.0   | Operator v0.17 |
|        | Sync v2.1.3       | Sync v2.1.0 |
|        | Helm Chart v4.0   | Helm all versions |
|        | EDP v1.14.1       | EDP all versions |
|        | Pump v1.12.1      | Pump all versions |
|        | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| :---------------------- | :--------------- | :------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)          | 1.23 | 1.23 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x    |  5.x, 6.x, 7.x    | | 
| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 6, 7, 8  | 5, 6, 7, 8  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x  | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x | v3.0.x | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions
<a id="upgrade-5.9.2"></a>

To resolve the compatibility issue between MDCB and Tyk Dashboard when Tyk OAS API definition paths contain dot (.) characters, you can choose **one** of the following upgrade paths:

##### Recommended Upgrade Paths

1. **Upgrade Dashboard (Preferred)**

   * Upgrade to Dashboard v5.9.2 to resolve the issue.
   * In this version, `escape_dots_in_oas_paths` defaults to `false`, and the Dashboard automatically unescapes dots in all API definitions.
   * **No MDCB upgrade is required.**

2. **Upgrade MDCB to v2.8.4 (Alternative if you cannot upgrade the Dashboard)**

    - Enable `escape_dots_in_oas_paths` in both Dashboard and MDCB configurations.
    - This ensures consistent escaping/decoding of dots across all components.

If you are upgrading to 5.9.2, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.9.2)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.9.2
    ```
- Helm charts
  - [tyk-charts v4.0.0](/developer-support/release-notes/helm-chart#4-0-0-release-notes)
Please note that the Tyk Helm Charts are configured to install the LTS version of Tyk Dashboard. You will need to modify them to install v5.9.2.

#### Changelog
<a id="Changelog-v5.9.2" data-scroll-offset></a>

##### Fixed



<Expandable title='Consistent Handling of Escaped Dots in OpenAPI Endpoint Paths'>
Resolved a compatibility issue introduced via a fix in Dashboard v5.9.0 (LTS v5.8.3) to account for DocumentDB's handling of endpoint paths containing dots (`.`). The Dashboard now escapes dot characters (e.g., `\u002e`) when storing Tyk OAS API definitions in the database, but MDCB failed to unescape them when reading from the database. This caused the [request validation](/api-management/traffic-transformation/request-validation) and [mock response](/api-management/traffic-transformation/mock-response) middleware configured on affected endpoints not to be applied. 

To align MDCB's dot handling mechanism with Tyk Dashboard, a new configuration option, `escape_dots_in_oas_paths`, has been introduced in both [Dashboard](/tyk-dashboard/configuration#escape_dots_in_oas_paths) and [MDCB](/tyk-multi-data-centre/mdcb-configuration-options#escape_dots_in_oas_paths):

* By Default, `escape_dots_in_oas_paths` is set to `false` in both MDCB and Dashboard, restoring the Dashboard behaviour before v5.9.0 (LTS v5.8.3), where dots are unescaped.
* When `escape_dots_in_oas_paths` is set to `true`, Dots are escaped for compatibility with specific databases. With this config set to `true`, MDCB and Dashboard encode/decode these paths consistently.

Check the [Upgrade and Compatibility section](#upgrade-5.9.2) for details on the recommended upgrade path.
</Expandable>




### 5.9.1 Release Notes

#### Release Date 14th August 2025

#### Release Highlights

For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.9.1).

#### Breaking Changes

Since 5.9.0, Tyk Dashboard automatically escapes dots (`.`) in OpenAPI endpoint paths (e.g., <code>/v1.0</code> becomes <code>/v1\u002e0</code>) before saving to the database. This was introduced to support DocumentDB users as explained in the [change log](#Changelog-v5.8.3). MDCB 2.8.3 and earlier fails to properly decode these escaped paths when reading from the database. This causes the Validate Request and Mock Response middleware to malfunction for endpoints where the path contains dots; other middleware continues to work. The issue affects all MDCB deployments with Dashboard 5.9.1 and will be fixed in version Dashboard version 5.9.2 and MDCB version 2.8.4.

#### Dependencies

| Dashboard Version | Recommended Releases | Backwards Compatibility |
| :-------- | :------------------- | :------------- |
| 5.9.1  | MDCB v2.8.3       | MDCB v2.8.3 |
|        | Operator v1.2.0   | Operator v0.17 |
|        | Sync v2.1.2       | Sync v2.1.0 |
|        | Helm Chart v4.0   | Helm all versions |
|        | EDP v1.14.0       | EDP all versions |
|        | Pump v1.12.0      | Pump all versions |
|        | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| :---------------------- | :--------------- | :------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)          | 1.23 | 1.23 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x    |  5.x, 6.x, 7.x    | | 
| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 6, 7, 8  | 5, 6, 7, 8  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x  | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x | v3.0.x | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions

If you are upgrading to 5.9.1, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.9.1)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.9.1
    ```
- Helm charts
  - [tyk-charts v4.0.0](/developer-support/release-notes/helm-chart#4-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.9.1" data-scroll-offset></a>

##### Fixed



<Expandable title='URL Rewrite Middleware UI Compatibility Fix'>
Resolved an issue in the URL Rewrite middleware UI where the absence of the `negate` field in OAS API definition configurations caused unexpected behavior. The UI now correctly interprets a missing `negate` field in URL rewrite rules as `false` by default, ensuring compatibility with APIs created in earlier versions.
</Expandable>



### 5.9.0 Release Notes

#### Release Date 4th August 2025

#### Release Highlights

This release builds on the recent release of [Tyk 5.8.3](/developer-support/release-notes/dashboard#5-8-3-release-notes), adding a collection of new capabilities. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.9.0).

##### Accept JSON Web Tokens (JWTs) Issued By Multiple Identity Providers

Tyk can now validate JWTs against multiple JSON Web Key Set (JWKS) endpoints, allowing you to use different IdPs to issue JWTs for the same API. Previously, we supported only a single JWKS endpoint in the `source` field, but now you can register multiple JWKS endpoints in the Tyk OAS API definition.

When a request is received bearing a JWT, Tyk will retrieve JWKS from all registered IdPs to check the token's validity. For full details of how to use this powerful feature see the improved [JWT Authentication](/api-management/authentication/jwt-signature-validation#remotely-stored-keys-jwks-endpoint) section.

**Please note that this functionality is not available for Tyk Classic APIs.**

##### Compatibility with Valkey

Tyk is now fully compatible with [Valkey](https://valkey.io/), the open-source (BSD) high-performance key/value datastore backed by the Linux Foundation, as an alternative to Redis.

#### Breaking Changes

1. We have implemented a [change](/developer-support/release-notes/dashboard#Fixed-v5.9.0) to the behaviour of the `GET /api/streams/{apiID}` endpoint, which now expects an `Accept` header, not `Content-Type`.

2. Tyk Dashboard now automatically escapes dots (`.`) in OpenAPI endpoint paths (e.g., <code>/v1.0</code> becomes <code>/v1\u002e0</code>) before saving to the database. This was introduced to support DocumentDB users as explained in the [change log](#Changelog-v5.9.0). MDCB 2.8.3 and earlier fails to properly decode these escaped paths when reading from the database. This causes the Validate Request and Mock Response middleware to malfunction for endpoints where the path contains dots; other middleware continues to work. The issue affects all MDCB deployments with Dashboard 5.9.0 and will be fixed in Dashboard version 5.9.2 and MDCB version 2.8.4. We strongly recommend that users upgrade to the latest versions of Tyk components.

#### Dependencies

| Dashboard Version | Recommended Releases | Backwards Compatibility |
| :-------- | :------------------- | :------------- |
| 5.9.0  | MDCB v2.8.2       | MDCB v2.8.2 |
|        | Operator v1.2.0   | Operator v0.17 |
|        | Sync v2.1.2       | Sync v2.1.0 |
|        | Helm Chart v4.0   | Helm all versions |
|        | EDP v1.14.0       | EDP all versions |
|        | Pump v1.12.0      | Pump all versions |
|        | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency | Tested Versions | Compatible Versions | Comments | 
| :---------------------- | :--------------- | :------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)          | 1.23 | 1.23 | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)   | 5.x, 6.x, 7.x    |  5.x, 6.x, 7.x    | | 
| [Valkey](https://valkey.io/download/) | 8.0.x, 8.1.x    | 7.2.x, 8.0.x, 8.1.x    | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 6, 7, 8  | 5, 6, 7, 8  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/) | 13.x - 17.x | 13.x - 17.x  | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x | v3.0.x | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions

If you are upgrading to 5.9.0, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.9.0)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.9.0
    ```
- Helm charts
  - [tyk-charts v4.0.0](/developer-support/release-notes/helm-chart#4-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.9.0" data-scroll-offset></a>

##### Added



<AccordionGroup>
<Accordion title='Authenticate with Multiple JWKS Providers'>
Added support for configuration of multiple JWKS (JSON Web Key Set) endpoints for Tyk OAS APIs. This enables the Gateway to authenticate JSON Web Tokens (JWTs) in multi-identity provider environments. The JWKS endpoints are configured in the new `jwksURIs` array in the JWT Auth `securityScheme`. This will take precedence over the existing `source` field, and existing API definitions will be automatically migrated to use the new field, while maintaining backward compatibility in case of rollback. Full support has been added to the Tyk OAS API Designer.
</Accordion>

<Accordion title='Valkey Database Compatibility'>
Added compatibility with Valkey database as an alternative to Redis. This is for fresh environments, with no migration support from Redis.
</Accordion>

<Accordion title='Experimental Access to Additional Input and Output Options for Tyk Streams APIs'>
We have introduced a new Dashboard configuration option, `TYK_DB_STREAMING_ENABLEALLEXPERIMENTAL`, to enable all experimental input and output options for Tyk Streams APIs. This is strictly provided for demos and MVPs and should not be enabled in production use.
</Accordion>
</AccordionGroup>



##### Changed



<Expandable title='Updated to use latest kin-openapi'>
Upgraded to use the latest upstream version of kin-openapi (v0.132.0). This ensures improved compatibility, full stack interoperability, and continued support for existing OpenAPI 3.0.x specifications.
</Expandable>



##### Fixed
<a id="Fixed-v5.9.0"></a>



<Expandable title='Tyk Streams Endpoint Incorrectly Expected `Content-Type` Header'>
Fixed an issue where the `/apis/streams/{apiID}` endpoint was expecting a `Content-Type` header instead of an `Accept` header for `GET` requests.
</Expandable>



---

## 5.8 Release Notes

### 5.8.14 Release Notes 

#### Release Date xx April 2026

#### Release Highlights

**JavaScript Unicode Regex Import**

Fixed an issue where Unicode regular expressions in JavaScript middleware were not properly imported from OpenAPI specifications. This resolves validation and pattern-matching errors that could occur when working with international character sets in API definitions.

**Dashboard Certificate Filtering**

Resolved a bug in the Dashboard's certificate filter functionality for APIs, ensuring that SSL/TLS certificates are correctly filtered and displayed when managing API configurations. This improvement enhances the reliability of certificate management workflows.

The Dashboard has also been updated to use Go 1.25, and CVEs have been fixed, providing improved performance and security enhancements.

For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.8.14) below.

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies
<a id="dependencies-5.8.14"></a>

##### Compatibility Matrix For Tyk Components

| Gateway Version | Recommended Releases | Backwards Compatibility |
| :---- | :---- | :---- |
| 5.8.14   | MDCB v2.10.0     | MDCB v2.10.0 |
|         | Operator v1.4.0 | Operator v0.17 |
|         | Sync v2.1.7     | Sync v2.1.1 |
|         | Helm Chart v5.2.0 | Helm all versions |
|         | EDP v1.17.1     | EDP all versions |
|         | Pump v1.15.0    | Pump all versions |
|         | TIB (if using standalone) v1.7.1 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                       | Tested Versions        | Compatible Versions    | Comments | 
| :------------------------------------------------------------ | :---------------------- | :---------------------- | :-------- | 
| [Go](https://go.dev/dl/)                                     | 1.25  |  1.25  | [Go plugins](/api-management/plugins/golang) must be built using Go 1.25 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | Used by Tyk Gateway | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3)| v3.0.x                 | v3.0.x                 | Supported by [Tyk OAS](/api-management/gateway-config-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
<a id="upgrade-5.8.14"></a>

If you are upgrading to 5.8.14, please follow the detailed [upgrade instructions](#upgrading-tyk).

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.14)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.14
    ```
- Helm charts
  - [tyk-charts v5.2.0](/developer-support/release-notes/helm-chart#5-2-0-release-notes)

#### Changelog
<a id="Changelog-v5.8.14" data-scroll-offset></a>

##### Changed

<AccordionGroup>

<Accordion title='Updated Dashboard to Go 1.25'>
Updated the Tyk Dashboard to use Go 1.25, ensuring compatibility with the latest Go runtime features and reducing exposure to potential security vulnerabilities in older versions.
</Accordion>

</AccordionGroup>

##### Fixed

<AccordionGroup>

<Accordion title='Fixed JavaScript Regex Unicode Escape Sequence Handling in OpenAPI Import'>
Resolved an issue where JavaScript-style Unicode regex patterns in OpenAPI specifications failed validation during API import. Previously, when regex patterns containing Unicode escape sequences (like `\u0000-\u017f`) were defined with single quotes in YAML, the YAML-to-JSON conversion process would double-escape the backslashes, transforming valid `\u` sequences into invalid `\\u` sequences that were rejected by Tyk's regex validator.

The system now automatically translates these escape sequences during API ingestion, ensuring that OpenAPI specifications with JavaScript regex patterns import successfully regardless of whether single or double quotes are used in the YAML definition.
</Accordion>

<Accordion title='Fixed Dashboard Certificate Filter for APIs'>
Resolved an issue where the Dashboard's "Filter by API" feature on the TLS/SSL Certificates page did not return all certificates linked to an API. Previously, the filter only displayed certificates used for client-to-gateway static mTLS, ignoring certificates used for gateway-to-upstream mTLS, custom domain certificates, and certificate pinning. This resulted in incomplete and misleading results for users trying to view all certificates actively used by a given API.

The Dashboard now correctly returns all certificate types when filtering by API.
</Accordion>

</AccordionGroup>

##### Security Fixes

<AccordionGroup>

<Accordion title='CVE fixed'>
Addressed CVEs reported in dependent libraries, providing increased protection against security
vulnerabilities, including, but not limited to:

- <a href="https://cvereports.com/reports/GHSA-6G7G-W4F8-9C9X" target="_blank">GHSA-6g7g-w4f8-9c9x</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2026-33186" target="_blank">CVE-2026-33186</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-29063" target="_blank">CVE-2025-29063</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2026-33487" target="_blank">CVE-2026-33487</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-15558" target="_blank">CVE-2025-15558</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2026-1229" target="_blank">CVE-2026-1229</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2026-39883" target="_blank">CVE-2026-39883</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2026-39882" target="_blank">CVE-2026-39882</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2026-33762" target="_blank">CVE-2026-33762</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2026-34165" target="_blank">CVE-2026-34165</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-62718" target="_blank">CVE-2025-62718</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2026-40175" target="_blank">CVE-2026-40175</a>

</Accordion>

</AccordionGroup>


---

### 5.8.12 Release Notes

#### Release Date 11 March 2026

#### Release Highlights

In this patch, we have fixed a number of small issues related to the management of API Keys (Auth Tokens) for APIs secured with mTLS in the Dashboard UI. We have also fixed the filtering applied when requesting the details of all keys that grant access to a specific API. 

For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.8.12).

#### Breaking Changes

A change has been made to improve security of the legacy [**Auth Token + Dynamic mTLS**](/api-management/implement-tls#legacy-dynamic-mtls-mode) method for securing access to APIs deployed on Tyk. This removes the option to authenticate using only the auth token and enforces the mTLS handshake.

Previously, API clients could authenticate without presenting the client certificate or holding the client's private key.

For any user relying on that behavior, we have added a new Gateway configuration option: `allow_unsafe_dynamic_mtls_token`. Unless deliberately configured in the config file or environment, this is set to `false` to ensure that Tyk is secure by default.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Gateway Version | Recommended Releases | Backwards Compatibility |
| :---- | :---- | :---- |
| 5.8.12   | MDCB v2.9.0     | MDCB v2.9.0 |
|         | Operator v1.3.0 | Operator v0.17 |
|         | Sync v2.1.6     | Sync v2.1.1 |
|         | Helm Chart v5.1.0 | Helm all versions |
|         | EDP v1.17.0     | EDP all versions |
|         | Pump v1.14.0    | Pump all versions |
|         | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                       | Tested Versions        | Compatible Versions    | Comments | 
| :------------------------------------------------------------ | :---------------------- | :---------------------- | :-------- | 
| [Go](https://go.dev/dl/)                                     | 1.24  |  1.24  | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | Used by Tyk Gateway | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3)| v3.0.x                 | v3.0.x                 | Supported by [Tyk OAS](/api-management/gateway-config-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

No deprecations in this release.

#### Upgrade instructions

If you are upgrading to 5.8.12, please follow the detailed [upgrade instructions](#upgrading-tyk).

#### Downloads

- [Docker image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.12)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.12
    ``` 
- Helm charts
  - [tyk-charts v5.1.0](/developer-support/release-notes/helm-chart#5-1-0-release-notes)


#### Changelog
<a id="Changelog-v5.8.12" data-scroll-offset></a>

##### Fixed

<AccordionGroup>

<Accordion title='Fixed GeoIP Location Data Display in SQL Analytics Storage'>
Resolved issues preventing GeoIP location data from displaying correctly when using SQL storage for analytics. Previously, the Log Browser showed "GeoIP not recognized" for country codes, and geographic traffic filtering returned empty results, even though location data was properly captured and stored in the database. 

The Dashboard can now correctly read and display all geographic information, including country codes, city names, coordinates, and timezone data from SQL storage. Geographic traffic filtering by country code now works as expected, enabling users to analyze traffic patterns by location when using SQL-based analytics storage.
</Accordion>

<Accordion title='Fixed Issues Associating Client Certificates with API Keys'>
We have addressed the following issues
- Create Key and Edit Key screens would incorrectly require the user to register a client certificate with the key when granting access to an API secured with static mTLS.
- The option to assign the client certificate was not possible when creating a key for an API that has the authentication method changed to use dynamic mTLS.
</Accordion>


<Accordion title='Improved Experience when License Missing or Expired'>
Fixed inaccurate wording and links on the screen presented on startup when the Dashboard license is missing or has expired.
</Accordion>

<Accordion title='Fixed API-Specific Key Retrieval in Dashboard'>
Resolved an issue where the Dashboard's `GET /api/apis/{api_id}/keys` endpoint incorrectly returned all keys in the environment instead of only keys associated with the specified API. Users can now accurately retrieve and manage keys for individual APIs, eliminating confusion when working with multi-API environments. Note that the addition of this filtering can lead to minor delays in the response to this endpoint when there are large numbers of APIs and keys.
</Accordion>

<Accordion title='Fixed Certificate Re-use After Swapping in Multi-Auth Keys'>
Resolved an issue where swapping certificates in multi-auth (mTLS + Basic auth) keys prevented the original certificate from being reused. Previously, when updating a key's certificate, the original certificate remained incorrectly associated with the key internally, causing "key with given certificate already found" errors when attempting to reuse that certificate. 

Tyk now properly detaches certificates during key updates, allowing certificates to be freely reused across different keys after being removed from their original association.
</Accordion>

</AccordionGroup>

##### Security Fixes

<AccordionGroup>

<Accordion title='Security Vulnerabilities Fixed'> 
Multiple high-severity CVEs have been fixed. 
</Accordion>

</AccordionGroup>

### 5.8.11 Release Notes

#### Release Date 12 February 2025

#### Release Highlights

In this release, we have fixed some priority CVEs. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.8.11).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Gateway Version | Recommended Releases | Backwards Compatibility |
| :---- | :---- | :---- |
| 5.8.11   | MDCB v2.8.8     | MDCB v2.8.7 |
|         | Operator v1.2.0 | Operator v0.17 |
|         | Sync v2.1.5     | Sync v2.1.1 |
|         | Helm Chart v5.0.0 | Helm all versions |
|         | EDP v1.16.0     | EDP all versions |
|         | Pump v1.13.3    | Pump all versions |
|         | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                       | Tested Versions        | Compatible Versions    | Comments | 
| :------------------------------------------------------------ | :---------------------- | :---------------------- | :-------- | 
| [Go](https://go.dev/dl/)                                     | 1.24  |  1.24  | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | Used by Tyk Gateway | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3)| v3.0.x                 | v3.0.x                 | Supported by [Tyk OAS](/api-management/gateway-config-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

No deprecations in this release.

#### Upgrade instructions

If you are upgrading to 5.8.11, please follow the detailed [upgrade instructions](#upgrading-tyk).

#### Downloads

- [Docker image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.11)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.11
    ``` 
- Helm charts
  - [tyk-charts v5.0.0](/developer-support/release-notes/helm-chart#5-0-0-release-notes)


#### Changelog
<a id="Changelog-v5.8.11" data-scroll-offset></a>

##### Security Fixes

<AccordionGroup>

<Accordion title='CVE fixed'>
Addressed CVEs reported in dependent libraries, providing increased protection against security
vulnerabilities, including, but not limited to:

- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-15467" target="_blank">CVE-2025-15467</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-69419" target="_blank">CVE-2025-69419</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-61726" target="_blank">CVE-2025-61726</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-61728" target="_blank">CVE-2025-61728</a>
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2025-68121" target="_blank">CVE-2025-68121</a>

</Accordion>

</AccordionGroup>

### 5.8.10 Release Notes

#### Release Date 23 December 2025

#### Release Highlights

This patch release addresses a CVE present in 5.8.9. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.8.10).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Gateway Version | Recommended Releases | Backwards Compatibility |
| :---- | :---- | :---- |
| 5.8.10   | MDCB v2.8.7     | MDCB v2.8.7 |
|         | Operator v1.2.0 | Operator v0.17 |
|         | Sync v2.1.5     | Sync v2.1.1 |
|         | Helm Chart v5.0.0 | Helm all versions |
|         | EDP v1.16.0     | EDP all versions |
|         | Pump v1.13.2    | Pump all versions |
|         | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                       | Tested Versions        | Compatible Versions    | Comments | 
| :------------------------------------------------------------ | :---------------------- | :---------------------- | :-------- | 
| [Go](https://go.dev/dl/)                                     | 1.24  |  1.24  | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | Used by Tyk Gateway | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3)| v3.0.x                 | v3.0.x                 | Supported by [Tyk OAS](/api-management/gateway-config-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

In this release we've deprecated the [policies.allow_explicit_policy_id](/tyk-oss-gateway/configuration#policies-allow_explicit_policy_id) configuration option. This was previously added to allow the use of custom policy IDs, which is now the default behaviour so this option is redundant.

#### Upgrade instructions

If you are upgrading to 5.8.10, please follow the detailed [upgrade instructions](#upgrading-tyk).

#### Downloads

- [Docker image to pull](https://hub.docker.com/r/tykio/tyk-gateway/tags?page=&page_size=&ordering=&name=v5.8.10)
  - ```bash
    docker pull tykio/tyk-gateway:v5.8.10
    ``` 
- Helm charts
  - [tyk-charts v5.0.0](/developer-support/release-notes/helm-chart#5-0-0-release-notes)

- [Source code tarball of Tyk Gateway v5.8.10](https://github.com/TykTechnologies/tyk/releases/tag/v5.8.10)

#### Changelog
<a id="Changelog-v5.8.10" data-scroll-offset></a>

##### Security Fixes

<AccordionGroup>

<Accordion title='CVE fixed'>
Fixed the following high-priority CVE, providing increased protection against security
vulnerabilities:

- <a href="https://nvd.nist.gov/vuln/detail/CVE-2021-41248" target="_blank">CVE-2021-41248</a>


</Accordion>

</AccordionGroup>


### 5.8.9 Release Notes

#### Release Date 12 December 2025

#### Release Highlights

This patch release contains various bug fixes and introduces new OPA helper functions to identify the type of API being processed (Tyk OAS, Tyk Streams, Tyk Classic). For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.8.9).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Dashboard Version | Recommended Releases | Backwards Compatibility |
| :---- | :---- | :---- |
| 5.8.9 | MDCB v2.8.7    | MDCB v2.8.7 |
|         | Operator v1.2.0  | Operator v0.17 |
|         | Sync v2.1.4    | Sync v2.1.1 |
|         | Helm Chart v5.0.0  | Helm all versions |
| | EDP v1.15.0 | EDP all versions |
| | Pump v1.13.1 | Pump all versions |
| | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                       | Tested Versions        | Compatible Versions    | Comments | 
| :------------------------------------------------------------ | :---------------------- | :---------------------- | :-------- | 
| [Go](https://go.dev/dl/)                                     | 1.24  |  1.24  | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3)| v3.0.x                 | v3.0.x                 | Supported by [Tyk OAS](/api-management/gateway-config-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

In this release we've deprecated the [allow_explicit_policy_id](/tyk-dashboard/configuration#allow_explicit_policy_id) configuration option. This was previously added to allow the use of custom policy IDs, which is now the default behaviour so this option is redundant.

#### Upgrade instructions

If you are upgrading to 5.8.9, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.9)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.9
    ``` 
- Helm charts
  - [tyk-charts v5.0.0](/developer-support/release-notes/helm-chart#5-0-0-release-notes)


#### Changelog
<a id="Changelog-v5.8.9" data-scroll-offset></a>

##### Added

<AccordionGroup>

<Accordion title='Open Policy Agent Functions to Identify API Style'>
Added three new OPA helper functions (`isTykOas`, `isTykClassic`, and `isTykStreams`) that can be used in OPA rules to distinguish between different API types, ensuring that only appropriate logic is applied.
</Accordion>

</AccordionGroup>

##### Fixed

<AccordionGroup>

<Accordion title='Fixed Dashboard Memory Exhaustion When `use_redis_log` Is Enabled in Gateway'>
Fixed an issue where enabling `use_redis_log` on a Tyk Gateway could cause the Dashboard to exhaust memory due to unbounded log accumulation from the UI notification endpoint.
</Accordion>

<Accordion title='Aligned Dashboard and Gateway Validation for Base64-Encoded JWKS URLs'>
Fixed an issue where the Gateway applied stricter validation than the Dashboard on the base64 encoded JWKS URI provided in the `source` (Tyk Classic: `jwt_source`) field when using JWT Auth. The Dashboard would accept a base64 encoded string that was not correctly padded, whereas the Gateway would require this padding.

The impact of this was that a JWKS URI could be successfully registered in an API definition via the Dashboard but then would be rejected when the Gateway handled requests to the API. Now the Gateway allows for lack of padding in the string, removing the inconsistency.
</Accordion>

<Accordion title='Fixed Policy Deletion Failure When Referenced API No Longer Exists'>
Fixed an issue where the user was unable to delete a policy if the referenced API didn't exist, even though the user had access to the policy before API deletion.
</Accordion>

<Accordion title='Fixed Certificate Filtering Not Working in Non-Detailed Mode'>
Fixed an issue where certificate filtering (`filter=with_pk`, `filter=without_pk`) was only applied in detailed mode, causing inconsistent behavior. Tyk now properly applies filtering in both detailed and non-detailed modes, ensuring consistent results regardless of the mode parameter used.
</Accordion>

<Accordion title='Removed Redundant Boolean Enums from OpenAPI Specification'>
Fixed redundant boolean enum definitions in OpenAPI specification by removing unnecessary enum: [true, false] declarations from boolean type fields in swagger.yml files. Boolean parameters now use only type: boolean, following OpenAPI best practices.
</Accordion>

<Accordion title='Renamed XTykApiGateway Schema to Avoid Case-Sensitive Conflicts'>
Renamed `XTykApiGateway` schema to `TykVendorExtension` to eliminate case-only naming conflicts with existing `XTykAPIGateway`
schema. Updated all corresponding $ref references throughout swagger.yml to prevent code generation ambiguity and ensure compatibility across case-insensitive file systems.
</Accordion>

<Accordion title='Standardised Use of Policy IDs Across Tyk Gateway and Dashboard'>
The Tyk Policy object has two identifiers: `id` (Policy ID) and `_id` (Policy Database ID). All policy definitions will have a value in `_id` when loaded to the Dashboard, used to identify the object in the persistent storage. Historically, the Policy ID (`id`) has been optional (via the `allow_explicit_policy_id` Gateway configuration), and different Tyk components have used one or the other, leading to inconsistency and scenarios where a policy might be rejected due to the configuration of IDs.

We have simplified the Tyk Gateway to use the Policy ID exclusively, instead of the Policy Database ID, improving consistency across the platform. This means that the `allow_explicit_policy_id` Gateway configuration is now redundant and marked deprecated, as the Policy ID field is always used.

If a policy definition is loaded onto the Tyk Dashboard that does not have a Policy ID set, Tyk will automatically set the `id` field to the value in `_id`. There are no changes to the Gateway or Dashboard APIs from this enhancement, ensuring backward compatibility.
</Accordion>

<Accordion title='Fixed Quick Start API Testing Issues'>
Resolved multiple issues preventing successful API testing in the Quick Start onboarding flow. Users can now test APIs with any response type (JSON, HTML, XML) without encountering HTTP 500 errors or blank response displays.

Additionally, fixed URL handling issues that occurred when gateway endpoints were configured without URL schemas, ensuring the "Test your API" step works reliably regardless of configuration format. 
</Accordion>

<Accordion title='Dashboard UI Fixes'>
- **Incorrect Data Range Display in Total API Traffic Dashboard Chart**: Fixed an issue where the **Total API Traffic** chart on the **Nodes & Licenses** screen displays data from the wrong time period.
- **TIB User Role Mappings Disappeared on Update**: Fixed a bug that caused TIB profiles to vanish on updates made to `Provider Configuration` advanced settings.
- **Access Tab Selection from Filtered Dropdown**: Fixed an issue where users and categories could not be selected from filtered dropdown lists in the Access tab of the Tyk OAS API designer.
- **Unable to Apply Multiple Filters to API List**: Resolved filtering issues where applying multiple filters (name + category) would drop previously applied filters instead of combining them. Users can now apply multiple filters that work together as expected, with all active filters preserved during pagination and sorting.
- **Data Graph Wizard Incorrectly Displayed**: Fixed an issue where the Data Graph onboarding wizard incorrectly appeared when filters returned zero results - it now only shows when no APIs actually exist in the system, keeping filters visible when results are empty.
- **Incomplete Certificate Search in API Designer**: Fixed an issue when selecting a TLS certificate to attach to a Tyk OAS API (for example, a client certificate for client-gateway mTLS). To improve performance when scrolling through the list of existing certificates, the UI uses pagination to load a subset of certificates at a time. The certificate ID search would only match against the currently loaded page of certificates, so a certificate might not appear to exist when it does, but just hasn't been loaded yet. Now the search functionality has been improved to look through the full list of certificates in the Tyk Certificate Store, rather than relying on the paginated data.
</Accordion>

</AccordionGroup>

### 5.8.8 Release Notes

#### Release 20th November 2025

#### Release Highlights

This patch release upgrades the Go build environment and fixes some high-priority CVEs. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.8.8).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Dashboard Version | Recommended Releases | Backwards Compatibility |
| :---- | :---- | :---- |
| 5.8.8 | MDCB v2.8.6    | MDCB v2.8.6 |
|         | Operator v1.2.0  | Operator v0.17 |
|         | Sync v2.1.4    | Sync v2.1.1 |
|         | Helm Chart v4.1.0  | Helm all versions |
| | EDP v1.15.0 | EDP all versions |
| | Pump v1.13.1 | Pump all versions |
| | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                       | Tested Versions        | Compatible Versions    | Comments | 
| :------------------------------------------------------------ | :---------------------- | :---------------------- | :-------- | 
| [Go](https://go.dev/dl/)                                     | 1.24  |  1.24  | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3)| v3.0.x                 | v3.0.x                 | Supported by [Tyk OAS](/api-management/gateway-config-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

If you are upgrading to 5.8.8, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.8)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.8
    ``` 
- Helm charts
  - [tyk-charts v4.0.0](/developer-support/release-notes/helm-chart#4-0-0-release-notes)


#### Changelog
<a id="Changelog-v5.8.8" data-scroll-offset></a>

##### Changed

<AccordionGroup>

<Accordion title='Updated Go build environment to Debian 12 ("Bookworm")'>
We have updated the Go build environment from Debian 11 ("Bullseye") to Debian 12 ("Bookworm") across all pipelines. This change ensures that all builds use the latest Go 1.24 patch version, addressing recent CVEs and improving overall security and stability.
</Accordion>

</AccordionGroup>

##### Security Fixes

<AccordionGroup>

<Accordion title='CVE fixed'>
Fixed the following high-priority CVEs, providing increased protection against security
vulnerabilities:

- <a href="https://www.cve.org/CVERecord?id=CVE-2025-47912" target="_blank">CVE-2025-47912</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58183" target="_blank">CVE-2025-58183</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58185" target="_blank">CVE-2025-58185</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58186" target="_blank">CVE-2025-58186</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58187" target="_blank">CVE-2025-58187</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58188" target="_blank">CVE-2025-58188</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-58189" target="_blank">CVE-2025-58189</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-61723" target="_blank">CVE-2025-61723</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-61724" target="_blank">CVE-2025-61724</a>
- <a href="https://www.cve.org/CVERecord?id=CVE-2025-61725" target="_blank">CVE-2025-61725</a>

</Accordion>

</AccordionGroup>

### 5.8.7 Release Notes

#### Release 29 October 2025

#### Release Highlights

This patch release contains various bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.8.7).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Dashboard Version | Recommended Releases | Backwards Compatibility |
| :---- | :---- | :---- |
| 5.8.7 | MDCB v2.8.5    | MDCB v2.8.5 |
|         | Operator v1.2.0  | Operator v0.17 |
|         | Sync v2.1.4    | Sync v2.1.1 |
|         | Helm Chart v4.0  | Helm all versions |
| | EDP v1.14.1 | EDP all versions |
| | Pump v1.13.0 | Pump all versions |
| | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                       | Tested Versions        | Compatible Versions    | Comments | 
| :------------------------------------------------------------ | :---------------------- | :---------------------- | :-------- | 
| [Go](https://go.dev/dl/)                                     | 1.24  |  1.24  | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3)| v3.0.x                 | v3.0.x                 | Supported by [Tyk OAS](/api-management/gateway-config-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

If you are upgrading to 5.8.7, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.7)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.7
    ``` 
- Helm charts
  - [tyk-charts v4.0.0](/developer-support/release-notes/helm-chart#4-0-0-release-notes)


#### Changelog
<a id="Changelog-v5.8.7" data-scroll-offset></a>

##### Added




<Expandable title='Enabled Gzip Compression for Static Assets to Improve Dashboard Load Performance'>
Implemented gzip compression for static assets (JavaScript, CSS, images, etc.) when the browser client requests for gzip with the `Accepted-Encoding` header. This significantly reduces the file size transferred when loading the Dashboard, reducing bandwidth usage and improving page load times for users.
</Expandable>




##### Fixed




<AccordionGroup>
<Accordion title='Fixed inconsistent sorting of Tyk OAS API versions'>
Fixed an issue where child versions of Tyk OAS APIs were sorted inconsistently between different Dashboard screens:
- chronologically by creation date on the APIs listing page
- alphabetically by version name on the Manage Versions page

All API version listings now consistently use alphabetical sorting by version name, providing a more predictable and user-friendly experience when navigating between different screens.
</Accordion>

<Accordion title='Improved logging of Request Transform middleware in Tyk OAS debugger'>
Fixed an issue where the API debugger did not display sufficient information about transformations applied by [Request Body Transform](/api-management/traffic-transformation/request-body) and [Request Header Transform](/api-management/traffic-transformation/request-headers) middleware. The debugger now shows detailed logs matching the format used for Response Transform middleware, including specific details about injected headers (e.g., "Adding: key: value") and body transformations, providing better visibility into request processing for debugging purposes.
</Accordion>

<Accordion title='Fixed GraphQL API creation via upstream introspection when OPA rules modify requests'>
Fixed an issue where creating GraphQL APIs using upstream introspection in the Dashboard could fail with `HTTP 502 Bad Gateway` errors when OPA rules (typically using `patch_request`) modified the introspection request body.

The problem occurred because the Dashboard did not recalculate the `Content-Length` header after OPA modifications, causing length mismatches that resulted in proxy errors. The Dashboard now properly recalculates the content length for modified introspection requests, ensuring reliable GraphQL API creation regardless of OPA rule configurations.
</Accordion>

<Accordion title='Fixed Category Validation for Tyk OAS APIs via Dashboard API'>
Resolved an issue where the [Dashboard API](/tyk-dashboard-api) allowed creation of empty or duplicate categories when updating Tyk OAS APIs through the `PUT /api/apis/oas/{API_ID}/categories` endpoint.
The API now properly validates category labels, automatically filtering out blank entries and duplicates to ensure data consistency. This update aligns the Dashboard API behavior with the existing validation rules in the API Designer interface.
</Accordion>

<Accordion title='Dashboard Analytics and Monitoring Fixes'>
- **Fixed non-clickable endpoint rows in the Activity page**: Fixed an issue where selecting an endpoint in the "Most Popular Endpoints" list on the "Activity Overview" screen did not direct the user to the      "Activity by Endpoint" screen.
- **Fixed incorrect error code descriptions in API activity dashboard**: Error codes now display correct descriptions (409 shows "Conflict" instead of "Rate limit or quota exceeded", and missing descriptions for 502, 504, 499, and 422 have been added).
- **Fixed unicode character display in Activity Logs view**: Non-ASCII characters (Cyrillic, Arabic, Hindi, Telugu, Yoruba, etc.) now display correctly instead of showing garbled text when viewing request/response logs.
- **Fixed date range filtering showing extra day in analytics charts**: Date range selectors now accurately reflect the selected end date instead of automatically including the following day's data in charts and legends.
- **Fixed incorrect data tables being queried when SQL table sharding is enabled**: Dashboard now correctly queries sharded tables (tyk_analytics_YYYYMMDD) instead of the main tyk_analytics table when `TYK_DB_STORAGE_LOGS_TABLESHARDING=true` is configured, ensuring analytics data displays properly with SQL database sharding.
- **Fixed incorrect date labels and data aggregation in analytics charts**: Fixed multiple issues in the analytics aggregation layer when using PostgreSQL backend that caused incorrect chart rendering and service problems. Resolved problems, including hourly charts showing nonsensical dates like "30 Nov 1899", monthly charts displaying incorrect months, incomplete time-series data due to improper date padding, and API activity being incorrectly split across multiple rows.
</Accordion>
</AccordionGroup>




### 5.8.6 Release Notes

#### Release Date 25th September 2025

#### Release Highlights

This patch release contains various bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.8.6).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Gateway Version | Recommended Releases | Backwards Compatibility |
| :---- | :---- | :---- |
| 5.8.6 | MDCB v2.8.4    | MDCB v2.8.4 |
|         | Operator v1.2.0  | Operator v0.17 |
|         | Sync v2.1.3    | Sync v2.1.1 |
|         | Helm Chart v4.0  | Helm all versions |
| | EDP v1.14.1 | EDP all versions |
| | Pump v1.12.2 | Pump all versions |
| | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                       | Tested Versions        | Compatible Versions    | Comments | 
| :------------------------------------------------------------ | :---------------------- | :---------------------- | :-------- | 
| [Go](https://go.dev/dl/)                                     | 1.24  |  1.24  | [Go plugins](/api-management/plugins/golang) must be built using Go 1.24 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3)| v3.0.x                 | v3.0.x                 | Supported by [Tyk OAS](/api-management/gateway-config-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

If you are upgrading to 5.8.6, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.6)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.6
    ``` 
- Helm charts
  - [tyk-charts v4.0.0](/developer-support/release-notes/helm-chart#4-0-0-release-notes)

- [Source code tarball of Tyk Gateway v5.8.6](https://github.com/TykTechnologies/tyk/releases/tag/v5.8.6)

#### Changelog
<a id="Changelog-v5.8.6" data-scroll-offset></a>

##### Changed



<Expandable title='Upgrade Tyk Dashboard to Golang 1.24'>
The Tyk Dashboard has been updated to [Golang 1.24](https://tip.golang.org/doc/go1.24), improving security by staying current with the latest Go versions.
</Expandable>




##### Fixed



<AccordionGroup>
<Accordion title='Fixed Missing Response Middleware in Tyk OAS API Debugger'>
Fixed an issue where the Tyk OAS API Debugger (Test Your API panel) only displayed request middleware execution, omitting response middleware from the debug output. The test debugger now correctly shows both request and response middleware execution, providing complete visibility into the entire request-response cycle for better API testing and troubleshooting.
</Accordion>

<Accordion title='Fixed OpenAPI `servers` section handling for regex-based custom domains'>
Fixed an issue where custom domains containing regular expressions were not correctly parsed and stored in the `servers` section of OpenAPI descriptions for Tyk OAS APIs. The Dashboard now properly converts regex-based domains into valid OpenAPI `servers` entries with appropriate variables, ensuring accurate API documentation and preventing validation errors during API editing. This fix includes enhanced syntax validation for regular expression (regex) patterns and improved capture group handling, which previously could cause Gateway crashes.
</Accordion>

<Accordion title='Fixed false error reporting for Response Body Transform middleware in API Debugger'>
Fixed an issue where the Tyk OAS API Debugger (Test Your API panel) incorrectly reported errors for endpoints using Response Body Transform middleware, even when API calls completed successfully. The debugger now accurately displays the execution status and eliminates false error messages that could mislead developers during API testing and troubleshooting.
</Accordion>

<Accordion title='Fixed PATCH endpoint validation to reject Tyk OAS API definitions when expecting OpenAPI description'>
Fixed an inconsistency where the Dashboard API's `PATCH /api/apis/oas/{apiId}` endpoint incorrectly accepted full Tyk OAS API definitions containing Tyk Vendor Extensions, when it should only accept standard OpenAPI descriptions. The endpoint now properly validates incoming requests and returns `HTTP 400 Bad Request` if the Tyk Vendor Extension is present, ensuring consistent behavior with the Dashboard UI and maintaining the intended separation between OpenAPI description updates and full API configuration changes.
</Accordion>

<Accordion title='Fixed Dashboard API panic when accessing logs without timestamp parameters in PostgreSQL'>
Fixed an issue where the Tyk Dashboard API would panic and return `HTTP 500 Internal Server Error` when accessing the `/api/logs` endpoint without the required `start` and `end` timestamp parameters in PostgreSQL environments using table sharding. The API now properly handles missing parameters by returning `HTTP 400 Bad Request` with a descriptive error message, improving error handling and API reliability.
</Accordion>

<Accordion title='Fixed orphaned Tyk OAS API versions visibility when using PostgreSQL'>
Fixed an issue where orphaned child versions of a Tyk OAS API would disappear from the Dashboard UI after their base API was deleted, specifically when using PostgreSQL as the datastore. Orphaned Tyk OAS API versions now remain visible in the Dashboard, ensuring consistent behavior across all supported datastores and preventing loss of access to existing API versions.
</Accordion>

<Accordion title='Fixed cross-interface compatibility for keys and policies with Tyk OAS and non-versioned Tyk Classic APIs'>
Fixed an issue where keys and policies created or updated via the Dashboard API were sometimes rejected by the Dashboard UI, and vice versa, due to inconsistent handling of the `versions` field for non-versioned Tyk Classic APIs. The issue occurred because the API and UI used different formats when populating the versions list in access rights. Both interfaces now consistently accept either `null` or `[]` (empty array) values in the `versions` field of the access control list, ensuring seamless interoperability between API and UI workflows for policy and key management. Tyk OAS APIs use a [different approach](/api-management/api-versioning#how-api-versioning-works-with-tyk) to versioning, with each (base or child) version having a unique API ID that is added to the access list.
</Accordion>

<Accordion title='Fixed Policy and Key Management UI for versioned APIs'>
Fixed UI issues in policy and key management that caused confusion and unnecessary validation errors. The API Versions field in the Dashboard UI now appears only when relevant - specifically for versioned Tyk Classic APIs. The field is no longer displayed for Tyk OAS APIs or non-versioned Tyk Classic APIs, eliminating confusion about when version selection is required and preventing policies and keys from failing to save due to irrelevant validation requirements.
</Accordion>

<Accordion title='Fixed `/versions` endpoint to only accept valid Tyk OAS base APIs'>
Fixed an issue where the `/api/apis/oas/{apiId}/versions` endpoint incorrectly returned version data for Tyk Classic APIs and non-versioned Tyk OAS APIs. The endpoint now properly validates requests and returns `HTTP 422 Unprocessable Entity` when the target API is not a valid Tyk OAS base API, ensuring the endpoint only returns meaningful version information.
</Accordion>

<Accordion title='Fixed multiple issues with the creation of child versions of Tyk OAS APIs'>
Fixed several issues that affected the creation of new child versions of Tyk OAS APIs to ensure reliable version creation and proper validation:

UI and API Creation:
- Resolved an issue that prevented users from creating new versions via the API Designer's Manage Versions screen
- Added validation for the `base_api_id` parameter - providing a non-existent ID would previously create the API successfully, but leave it invisible in the Dashboard UI
- Added stricter validation for version names - users can no longer create API versions without specifying a valid `new_version_name`, preventing unusable or empty version entries
- Improved error messaging when the `base_api_version_name` parameter is missing or incorrectly specified

Version Management:
- Fixed an issue where creating new child versions would incorrectly reset the default version back to the base API, overriding previously configured settings

The system now provides comprehensive validation with clear error responses (`HTTP 400 Bad Request` and `HTTP 422 Unprocessable Entity`), ensures that all API versions have meaningful identifiers, and maintains proper default version settings during the creation of child versions.
</Accordion>

<Accordion title='Fixed Dashboard default page_size behavior'>
Fixed an issue where the Tyk Dashboard did not correctly apply a default `page_size` value when none was specified in the Dashboard configuration, potentially causing unexpected pagination behavior. The Dashboard now properly defaults to a page size of 10 items as documented, ensuring consistent and predictable pagination across all Dashboard views.
</Accordion>

<Accordion title='Fixed delayed application of global webhook changes for Tyk OAS APIs'>
Fixed an issue where updates to [global webhooks](/api-management/gateway-events#local-and-global-webhooks) were not immediately applied to Tyk OAS APIs using those webhooks. When global webhook configurations were modified, the Gateway would continue using the previous settings for affected Tyk OAS APIs until a manual reload occurred. The system now automatically triggers a Gateway reload for all impacted Tyk OAS APIs when global webhook configurations are updated, ensuring that the new webhook settings take effect immediately.
</Accordion>
</AccordionGroup>





##### Security Fixes



<Expandable title='High priority CVEs fixed'>
Fixed the following high-priority CVEs identified in the Tyk Dashboard, providing increased protection against security
vulnerabilities:<br />
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2024-47875" target="_blank">CVE-2024-47875</a><br />
- <a href="https://nvd.nist.gov/vuln/detail/CVE-2024-45801" target="_blank">CVE-2024-45801</a>
</Expandable>



### 5.8.5 Release Notes

#### Release Date 18th August 2025

#### Release Highlights

This release fixes a compatibility issue between MDCB and Dashboard where APIs containing dots (.) in their paths were not handled correctly in MDCB. API definitions are now processed consistently with the Dashboard, ensuring middleware works as expected across all gateways.

For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.8.5).

#### Breaking Changes

There are no breaking changes in this release.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Gateway Version | Recommended Releases | Backwards Compatibility |
| :---- | :---- | :---- |
| 5.8.5 | MDCB v2.8.4     | MDCB v2.8.4 |
|         | Operator v1.2.0  | Operator v0.17 |
|         | Sync v2.1.1    | Sync v2.1.1 |
|         | Helm Chart v3.0  | Helm all versions |
| | EDP v1.14 | EDP all versions |
| | Pump v1.12.1 | Pump all versions |
| | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                       | Tested Versions        | Compatible Versions    | Comments | 
| :------------------------------------------------------------ | :---------------------- | :---------------------- | :-------- | 
| [Go](https://go.dev/dl/)                                     | 1.23  |  1.23  | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3)| v3.0.x                 | v3.0.x                 | Supported by [Tyk OAS](/api-management/gateway-config-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
<a id="upgrade-5.8.5"></a>

To resolve the compatibility issue between MDCB and Tyk Dashboard when OAS API definition paths contain dot (.) characters, you can choose **one** of the following upgrade paths:

##### Recommended Upgrade Paths

1. **Upgrade Dashboard (Preferred)**

   * Upgrade to Dashboard v5.8.5 to resolve the issue.
   * In this version, `escape_dots_in_oas_paths` defaults to `false`, and the Dashboard automatically unescapes dots in all API definitions.
   * **No MDCB upgrade is required.**

2. **Upgrade MDCB to v2.8.4 (Alternative if you cannot upgrade the Dashboard)**

    - Enable `escape_dots_in_oas_paths` in both Dashboard and MDCB configurations.
    - This ensures consistent escaping/decoding of dots across all components.

If you are upgrading to 5.8.5, please follow the detailed [upgrade instructions](#upgrading-tyk).

#### Downloads

- [Docker image to pull](https://hub.docker.com/r/tykio/tyk-gateway/tags?page=&page_size=&ordering=&name=v5.8.5)
  - ```bash
    docker pull tykio/tyk-gateway:v5.8.5
    ``` 
- Helm charts
  - [tyk-charts v3.0.0](/developer-support/release-notes/helm-chart#3-0-0-release-notes)

- [Source code tarball of Tyk Gateway v5.8.5](https://github.com/TykTechnologies/tyk/releases/tag/v5.8.5)

#### Changelog
<a id="Changelog-v5.8.5" data-scroll-offset></a>

##### Fixed



<Expandable title='Consistent Handling of Escaped Dots in OpenAPI Endpoint Paths'>
Resolved a compatibility issue introduced via a fix in Dashboard v5.8.3 to account for DocumentDB's handling of endpoint paths containing dots (`.`). The Dashboard now escapes dot characters (e.g., `\u002e`) when storing Tyk OAS API definitions in the database, but MDCB failed to unescape them when reading from the database. This caused the [request validation](/api-management/traffic-transformation/request-validation) and [mock response](/api-management/traffic-transformation/mock-response) middleware configured on affected endpoints not to be applied. 

To align MDCB's dot handling mechanism with Tyk Dashboard, a new configuration option, `escape_dots_in_oas_paths`, has been introduced in both Dashboard and MDCB:

* By Default, `escape_dots_in_oas_paths` is set to `false` in both MDCB and Dashboard, restoring the Dashboard behaviour before v5.8.3, where dots are unescaped.
* When `escape_dots_in_oas_paths` is set to `true`, Dots are escaped for compatibility with specific databases. With this config set to `true`, MDCB and Dashboard encode/decode these paths consistently.

Check the [Upgrade and Compatibility section](#upgrade-5.8.5) for details on the recommended upgrade path.
</Expandable>



### 5.8.4 Release Notes

#### Release Date 13th August 2025

#### Release Highlights

For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.8.4).

#### Breaking Changes

Since 5.8.3, Tyk Dashboard automatically escapes dots (`.`) in OpenAPI endpoint paths (e.g., <code>/v1.0</code> becomes <code>/v1\u002e0</code>) before saving to the database. This was introduced to support DocumentDB users as explained in the [change log](#Changelog-v5.8.3). MDCB 2.8.3 and earlier fails to properly decode these escaped paths when reading from the database. This causes the Validate Request and Mock Response middleware to malfunction for endpoints where the path contains dots; other middleware continues to work. The issue affects all MDCB deployments with Dashboard 5.8.4 and is fixed in version Dashboard version 5.8.5 and MDCB version 2.8.4. We strongly recommend that users upgrade to the latest versions of Tyk components.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Dashboard Version | Recommended Releases | Backwards Compatibility |
| :---- | :---- | :---- |
| 5.8.4 | MDCB v2.8.3     | MDCB v2.8.3 |
|         | Operator v1.2.0  | Operator v0.17 |
|         | Sync v2.1.1    | Sync v2.1.1 |
|         | Helm Chart v3.0  | Helm all versions |
| | EDP v1.14 | EDP all versions |
| | Pump v1.12.0| Pump all versions |
| | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.23       | 1.23       | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions

If you are upgrading to 5.8.4, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.4)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.4
    ```
- Helm charts
  - [tyk-charts v3.0.0](/developer-support/release-notes/helm-chart#3-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.8.4" data-scroll-offset></a>

##### Fixed



<Expandable title='URL Rewrite Middleware UI Compatibility Fix'>
Resolved an issue in the URL Rewrite middleware UI where the absence of the `negate` field in OAS API definition configurations caused unexpected behavior. The UI now correctly interprets a missing `negate` field in URL rewrite rules as `false` by default, ensuring compatibility with APIs created in earlier versions.
</Expandable>



---

### 5.8.3 Release Notes

#### Release Date 15th July 2025

#### Release Highlights

This patch release contains various bug fixes. For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.8.3) below.

#### Breaking Changes

Tyk Dashboard now automatically escapes dots (`.`) in OpenAPI endpoint paths (e.g., <code>/v1.0</code> becomes <code>/v1\u002e0</code>) before saving to the database. This was introduced to support DocumentDB users as explained in the [change log](#Changelog-v5.8.3). MDCB 2.8.3 and earlier fails to properly decode these escaped paths when reading from the database. This causes the Validate Request and Mock Response middleware to malfunction for endpoints where the path contains dots; other middleware continues to work. The issue affects all MDCB deployments with Dashboard 5.8.3 and is fixed in version Dashboard version 5.8.5 and MDCB version 2.8.4. We strongly recommend that users upgrade to the latest versions of Tyk components.

#### Dependencies

##### Compatibility Matrix For Tyk Components

| Dashboard Version | Recommended Releases | Backwards Compatibility |
| :---- | :---- | :---- |
| 5.8.3 | MDCB v2.8.2     | MDCB v2.8.2 |
|         | Operator v1.2.0  | Operator v0.17 |
|         | Sync v2.1.1    | Sync v2.1.1 |
|         | Helm Chart v3.0  | Helm all versions |
| | EDP v1.14 | EDP all versions |
| | Pump v1.12.0| Pump all versions |
| | TIB (if using standalone) v1.7.0 | TIB all versions |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.23       | 1.23       | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | |
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions

If you are upgrading to 5.8.3, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.3)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.3
    ```
- Helm charts
  - [tyk-charts v3.0.0](/developer-support/release-notes/helm-chart#3-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.8.3" data-scroll-offset></a>

##### Fixed



<AccordionGroup>
<Accordion title='Fixed Automatic Configuration of Middleware when Importing OpenAPI Description'>
Fixed an issue where the automatic configuration options (authentication, mock response, etc) had no effect when creating an API from an OpenAPI document if the `listenPath` was not also specified via query parameter.
</Accordion>

<Accordion title='Fixed the Search Function on the Traffic Activity by Key page when using MongoDB'>
Fixed an issue where the Search function did not work correctly on the Traffic Activity by Key page that was observed only when using MongoDB for analytics storage. This was due to the specific syntax required by MongoDB for regular expressions.
</Accordion>

<Accordion title='Fixed an Incompatibility with DocumentDB for Certain Endpoint Names'>
Fixed an issue where endpoints that contain dots in the path name failed with an error when creating or updating an API. The issue was caused by the underlying storage not accepting dots as valid URI characters and was observed only with DocumentDB.
</Accordion>

<Accordion title='Preserve Categories and Ownership on Tyk OAS Update'>
Fixed an issue where API Categories and Ownership could be lost when applying an updated OpenAPI description to a Tyk OAS API.
</Accordion>

<Accordion title='Fixed Middleware Not Triggering in Tyk OAS Debugger'>
Fixed an issue where some middleware (API-level rate limit and mock response) were not triggered correctly when using the Tyk OAS API designer's built in debugger to test APIs.
</Accordion>

<Accordion title='Removed Empty Fields in Tyk Classic to Tyk OAS Conversion'>
Fixed an issue that occurred when converting Tyk Classic API definitions to Tyk OAS format, which could result in unnecessary empty fields in the Tyk OAS API definition.
</Accordion>

<Accordion title='Certificate API Filtering Added so that Relevant Certificates are Available when Configuring Upstream mTLS in Tyk OAS API Designer'>
Fixed an issue where the Tyk OAS API designer did not always display all of the appropriate certificates for use in Gateway to Upstream connections. In this scenario Tyk is the client and so requires the private key to sign requests to the upstream server. The full list of certificates with private keys registered in the Tyk Certificate Store will now be available when configuring your API.

For Dashboard API users, we’ve added a new optional `filter` query parameter to the `/api/certs` endpoint that will can be used to retrieve a subset of the certificate based on the presence of a Private Key (PK):

- `omit`: (Default) Returns all certificates.
- `with_pk`: Returns only certificates that include a Private Key.
- `without_pk`: Returns only certificates that do not include a Private Key.

For example:

- To retrieve the first page of certificates: `/api/certs?mode=detailed&p=1`
- To retrieve the first page of certificates with a Private Key: `/api/certs?mode=detailed&p=1&filter=with_pk`
- To retrieve the first page of certificates without a Private Key: `/api/certs?mode=detailed&p=1&filter=without_pk`

This new filtering capability provides more granular control over which certificates you retrieve from the Tyk Certificate Store. There is no change in behaviour if the `filter` parameter is omitted.
</Accordion>

<Accordion title='Use YAML Formatted OpenAPI Description to Update a Tyk OAS API'>
We’ve fixed an issue when importing OpenAPI descriptions using the PATCH method, so you can now update your Tyk OAS APIs using either YAML or JSON formatted OpenAPI descriptions.
</Accordion>

<Accordion title='Improved Validation When Importing Tyk Streams API Definitions'>
Fixed an issue where Dashboard did not correctly import Tyk Streams API definitions, skipping validation of the configuration.
</Accordion>

<Accordion title='Fixed Incorrect Auth Configuration when Importing OpenAPI Description'>
Fixed an error in the Tyk OAS API Designer that added invalid config to the API definition when enabling Tyk OAuth 2.0 authentication method for an API that has an OAuth configuration in the OpenAPI description's securitySchemes.
</Accordion>

<Accordion title='Improved Experience for Tyk Streams APIs in API Definition Editor'>
Fixed some issues when using the API Definition Editor to view and modify Tyk Streams APIs.
</Accordion>

<Accordion title='Various fixes to the Dashboard UI'>
We have implemented various fixes and improvements in the Dashboard UI to enhance usability.

- The Tyk OAS API designer now fully supports the use of Key-Value storage [references](/tyk-configuration-reference/kv-store#from-api-definitions) that are valid in the API definition.
- Improved the error messages displayed in the Dashboard UI when there are problems importing OpenAPI documents - now they clearly explain the issue and provide guidance on how to resolve it.
- Fixed an issue where users couldn't register Event Handlers in Tyk OAS API Designer.
</Accordion>
</AccordionGroup>



---

### 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 |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.23       | 1.23       | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions

If you are upgrading to 5.8.2, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.2)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.2
    ```
- Helm charts
  - [tyk-charts v3.0.0](/developer-support/release-notes/helm-chart#3-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.8.2" data-scroll-offset></a>

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](#Changelog-v5.8.1) 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 |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.23       | 1.23       | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | |
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions

If you are upgrading to 5.8.1, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.1)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.1
    ```
- Helm charts
  - [tyk-charts v3.0.0](/developer-support/release-notes/helm-chart#3-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.8.1" data-scroll-offset></a>

##### Fixed



<AccordionGroup>
<Accordion title='License allocation now works across multiple dashboards'>
Fixed an issue where the Dashboard might not allow the correct number of Gateways to connect. This was due to a conflict with license management in deployments with multiple Dashboards which has now been resolved.
</Accordion>

<Accordion title='Admin permissions correctly assigned during SSO login'>
Fixed an issue where existing admin users could have their permissions overwritten by SSO group settings during login. Admin users now retain their original permissions when `sso_enable_user_lookup` is enabled. Group permissions are only applied to new or non-admin users.
</Accordion>

<Accordion title='Fixed import of Tyk OAS API definitions in YAML format'>
Fixed an issue that prevented creation of an API from a YAML format Tyk OAS API definition. You can now export your Tyk OAS API definition in YAML or JSON format and use the content of this file to create a new API.
</Accordion>

<Accordion title='Fixed broken cancel button in Tyk Classic to Tyk OAS flow'>
Fixed an issue when using API Designer to migrate an API from Tyk Classic to Tyk OAS. Previously the cancel button did not work in the pop-up when promoting a staged API.
</Accordion>

<Accordion title='Multi-part OpenAPI descriptions in YAML format can now be imported'>
Fixed an issue that prevented import of multi-part OpenAPI descriptions in YAML format.
</Accordion>

<Accordion title='Various fixes to the Dashboard UI'>
We have implemented various fixes and improvements in the Dashboard UI to enhance usability.
</Accordion>
</AccordionGroup>



##### Security Fixes 



<Expandable title='High priority CVEs fixed'>
Fixed the following high priority [CVEs](https://www.cve.org/) identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:
- [CVE-2025-46569](https://nvd.nist.gov/vuln/detail/CVE-2025-46569)
</Expandable>



### 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](#Changelog-v5.8.0) 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](/api-management/gateway-config-tyk-oas).

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](/api-management/migrate-from-tyk-classic).

##### 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](/api-management/upstream-authentication).

##### 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 |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.23       | 1.23       | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions

If you are upgrading to 5.8.0, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.8.0)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.8.0
    ```
- Helm charts
  - [tyk-charts v3.0.0](/developer-support/release-notes/helm-chart#3-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.8.0" data-scroll-offset></a>

##### Added



<AccordionGroup>
<Accordion title='YAML Support for Tyk OAS'>
Tyk Dashboard's API and UI now support both YAML and JSON for Tyk OAS CRUD operations, giving users greater flexibility in managing their APIs.
</Accordion>

<Accordion title='Added Support for External References in OpenAPI Descriptions'>
We've enhanced Tyk's OpenAPI handling to allow the import of multi-part OpenAPI documents. This allows users to import OpenAPI descriptions that are split across multiple files, making it easier to manage complex API specifications.
</Accordion>

<Accordion title='API Testing & Debugging with Tyk OAS'>
We’ve added built-in testing and debugging capabilities to the Tyk OAS API Designer, making validating and troubleshooting your APIs easier. With a floating debugging panel and an endpoint dropdown, you can test your endpoints within the Dashboard UI.
</Accordion>

<Accordion title='Support for Read/Write Endpoints on RDS for Analytics and Logs'>
Users can now configure separate RDS endpoints for read and write operations, optimizing database performance by handling reads on replicas and writes on the primary instance.

New Configuration Fields:

- **ReadConnectionString**: Defines the connection string for read operations. It is only used if `ConnectionString` is not set.
- **WriteConnectionString**: Defines the connection string for write operations. It is only used if `ConnectionString` is not set.

For backward compatibility, if `ConnectionString` is set, it will take precedence over the new fields.
</Accordion>

<Accordion title='Certificate Support for GraphQL Introspection During API Creation'>
When creating a GraphQL API in the API designer, you can now attach certificates to be used during introspection of mTLS-protected upstream services. This simplifies the creation of GraphQL APIs by reducing the number of steps, as previously you had to use a dummy upstream during the initial creation and then reconfigure the API to perform introspection later.
</Accordion>

<Accordion title='Convert Tyk Classic API Definitions to Tyk OAS'>
Introduced a new [API migration facility](/api-management/migrate-from-tyk-classic) to the Tyk Dashboard API and API Designer enabling a seamless transition from Tyk Classic to Tyk OAS. Both methods offer direct and staged conversions of individual APIs. The Tyk Dashboard API also supports bulk API conversions.

Note that there is a known issue where the Cancel button in the Promote Staged API confirmation modal does not function. If you select Promote Staged API but decide not to proceed, you will need to use your browser’s Back button to exit the modal. This issue will be resolved in the next patch.
</Accordion>

<Accordion title='Upstream Authentication Support in Tyk Dashboard'>
Tyk Dashboard now supports integration with upstream services secured using Basic Auth, OAuth 2.0 Client Credentials, and OAuth 2.0 Password Grant in Tyk OAS APIs, providing flexibility in securing upstream authentication flows.
</Accordion>

<Accordion title='Quick Start Wizard for New Dashboard Users on Tyk Cloud'>
We have introduced a guided onboarding experience for Tyk Cloud users to help new users start effortlessly. Our step-by-step guide walks you through creating your first API, setting up policies and keys, testing endpoints, and exploring analytics - ensuring you can navigate the Dashboard and unlock its full potential from day one.
</Accordion>

<Accordion title='View Audit Logs in the Dashboard UI'>
Tyk Dashboard now provides enhanced visibility into user activity by allowing audit logs to be stored in a database and viewed directly in the Dashboard UI. Previously, these logs were only written to local files, limiting accessibility. With this update, admins can filter and review user actions more easily, improving security, and compliance tracking.
</Accordion>
</AccordionGroup>




##### Changed



<AccordionGroup>
<Accordion title='Support for PostgreSQL 17'>
The Dashboard now supports PostgreSQL 17, ensuring compatibility with the latest database version.
</Accordion>

<Accordion title='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
- updates to X509KeyPair handling.

**You may need to adjust your setup for compatibility**. For more details, please see the official Go [release notes](https://go.dev/doc/go1.23).
</Accordion>

<Accordion title='Improved Dashboard Code Editor'>
Upgraded the code editor component library and enhanced its styling for a better user experience. With this upgrade comes the facility to work in YAML or JSON and to switch seamlessly between formats.
</Accordion>

<Accordion title='Improved Labelling in Tyk Dashboard'>
We have made minor adjustments to labels within the Dashboard UI to enhance clarity.
</Accordion>

<Accordion title='"Manage Account" Link from Dashboard'>
The "Manage Account" link in the Tyk Dashboard, which previously directed users to an outdated cloud login page, has been removed. This improves the user experience by eliminating confusion around account management and ensuring a more cohesive navigation flow between the Dashboard and Tyk Cloud.
</Accordion>

<Accordion title='Improved Form Performance in API Designer'>
We’ve optimized form validation in the API Designer to enhance user experience. Forms are now validated on blur instead of during every keystroke, preventing cursor jumps and improving typing responsiveness.
</Accordion>

<Accordion title='Updated Default Configuration for Tyk Operator and Sync Compatibility'>
Modified the default values of `allow_explicit_policy_id` and `enable_duplicate_slugs` to `true` in the example Dashboard configuration file, to eliminate config problems when deploying Tyk Sync and Tyk Operator. This has no impact on existing deployments.
</Accordion>

<Accordion title='Removed unsupported TLS options in Tyk Classic API Designer'>
Removed unsupported TLS versions 1.0 and 1.1 from the Tyk Classic API Designer selector, improving clarity around supported TLS versions and enhancing security.
</Accordion>
</AccordionGroup>



##### Fixed



<Expandable title='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.
</Expandable>


<Expandable title='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.
</Expandable>



---

## 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 |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins](/api-management/plugins/golang) must be built using Go 1.22 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-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](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.7.3)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.7.3
    ```
- Helm charts
  - [tyk-charts v2.2.0](/developer-support/release-notes/helm-chart#2-2-0-release-notes)

#### Changelog
<a id="Changelog-v5.7.3" data-scroll-offset></a>

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](#Changelog-v5.7.2) 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 |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins](/api-management/plugins/golang) must be built using Go 1.22 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-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](#upgrading-tyk). 

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.7.2)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.7.2
    ```
- Helm charts
  - [tyk-charts v2.2.0](/developer-support/release-notes/helm-chart#2-2-0-release-notes)

#### Changelog
<a id="Changelog-v5.7.2" data-scroll-offset></a>

No changes have been implemented in this release.

##### Fixed



<Expandable title='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.
</Expandable>



##### Security Fixes



<Expandable title='Critical Priority CVE Fixed'>
- Fixed the following critical-priority CVE identified in the Dashboard UI, providing increased protection and improved security:
    - [CVE-2025-21613](https://nvd.nist.gov/vuln/detail/CVE-2025-21613)
</Expandable>


<Expandable title='High Priority CVE Fixed'>
- Fixed the following CVE:
    - [CVE-2025-21614](https://nvd.nist.gov/vuln/detail/CVE-2025-21614)
</Expandable>



---

### 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](#Changelog-v5.7.1) 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 |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.22 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-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](#upgrading-tyk). 

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.7.1)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.7.1
    ```
- Helm charts
  - [tyk-charts v2.2.0](/developer-support/release-notes/helm-chart#2-2-0-release-notes)

#### Changelog
<a id="Changelog-v5.7.1" data-scroll-offset></a>

##### Fixed



<Expandable title='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.
</Expandable>


<Expandable title='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.
</Expandable>



---

### 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](#Changelog-v5.7.0) 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
{/* Required. Use the following statement if there are no breaking changes, or explain if there are */}

There are no breaking changes in this release.

#### Dependencies
{/* Required. Use this section to announce the following types of dependencies compatible with the release:
Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
3rd party dependencies and tools */}
##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |

##### 3rd Party Dependencies & Tools
{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.

Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.

An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.22 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas)|

#### Deprecations

This section highlights features and dependencies that have been deprecated.

##### Authentication Methods

We’ve deprecated the following authentication methods in this release:

* **[External OAuth](/api-management/client-authentication#integrate-with-external-authorization-server-deprecated)**

  * Tyk Classic: `external_oauth`
  * Tyk OAS: `server.authentication.securitySchemes.externalOAuth`

* **[OpenID Connect (OIDC)](/api-management/client-authentication#integrate-with-openid-connect-deprecated)**

  * Tyk Classic: `auth_configs.oidc`
  * Tyk OAS: `server.authentication.oidc`

We recommend migrating to **[JWT Authentication](/basic-config-and-security/security/authentication-authorization/json-web-tokens)** for improved flexibility and long-term support.

##### SQLite End of Life

SQLite has reached **End of Life** for the Tyk Dashboard in this release. It was previously intended for **proof-of-concept** use only and is no longer supported.

We now recommend using **PostgreSQL** or **MongoDB** for both development and production deployments, as they provide greater scalability and long-term support.

**Why This Matters**

* SQLite is written in **C**, and using it in Go projects typically requires [**CGO**](https://golang.org/cmd/cgo/), which enables Go code to call C libraries.
* As long as the Dashboard had support for SQLite, CGO was required.
* With SQLite removed, the Tyk Dashboard can now be compiled with `CGO_ENABLED=0`, resulting in a **fully static binary**.

This change enables:

* Easier cross-platform builds
* Better compatibility with **RHEL8**
* Fewer dependencies and improved portability

#### Upgrade instructions
If you are upgrading to 5.7.0, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.7.0)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.7.0
    ```
- Helm charts
  - [tyk-charts v2.2.0](/developer-support/release-notes/helm-chart#2-2-0-release-notes)

#### Changelog
<a id="Changelog-v5.7.0" data-scroll-offset></a>

##### Added



<AccordionGroup>
<Accordion title='Added confirmation prompt for Stream deletion'>
Introduced a confirmation prompt when deleting a stream, notifying users that this action will stop all data streaming and cannot be undone. This change ensures users are fully aware of the impact before proceeding with deletion.
</Accordion>

<Accordion title='Displayed Streaming API in API overview table'>
Added "Streams" as an API type in the API Overview table, making it easier for API developers to identify APIs categorised as Streams & Events.
</Accordion>

<Accordion title='Implemented logic for config framework selection in Streaming API creation'>
Added logic for the Streaming API creation process, allowing users to select config frameworks for inputs, processors, and outputs. An 'Advanced' option is also available, which leaves the code editor empty while generating and displaying the YAML Bento config based on the user's selections.
</Accordion>

<Accordion title='Enhanced info messages for securing Streaming & Events APIs in policies & keys'>
Included new info messages and tooltips in the Policies & Keys section to guide users on securing Streaming & Events APIs. Updated messaging clarifies the combination of API types and revised copy in the Global Rate Limiting and Quota sections to better explain usage limits for keys and plans.
</Accordion>

<Accordion title='Enabled URL view and copy functionality in external playgrounds tab'>
Enabled URL view and copy functionality in the External Playgrounds tab, supporting scenarios with multiple organisations and URLs for playgrounds.
</Accordion>

<Accordion title='Introduced /streams endpoint to Tyk Dashboard API'>
Rolled out the `/streams` endpoint to the Tyk Dashboard API, dedicated to creating Stream and Events APIs in Tyk Streams. Documentation for the endpoint and its methods is available in the Tyk Docs.
</Accordion>

<Accordion title='Split Streaming API into new type in API designer'>
Separated Streaming API into its own type in the API Designer, introducing a new selection card for easier creation and configuration. Navigation enhancements, including a shortcut menu item, provide quicker access to the streaming configuration UI.
</Accordion>

<Accordion title='Integrated step-by-step UI for Config framework selection in Streaming API creation'>
Developed a step-by-step UI for Streaming API creation, enabling users to select a config framework for inputs, processors, and outputs. The dynamic wizard steps are integrated into the Tyk UI library to prefill configurations based on selections and prevent the combination of 'Custom' with other frameworks.
</Accordion>

<Accordion title='Easily contact Tyk Support during Tyk Cloud trial'>
Introduced a form on the Tyk Dashboard that allows users to easily contact Tyk support during their trial period.
</Accordion>

<Accordion title='Support for JWE in OIDC SSO'>
We have enhanced security for customers in highly regulated industries by introducing JSON Web Encryption (JWE) support for OIDC single sign-on (SSO). This ensures that tokens used in authentication flows are securely encrypted, providing an additional layer of protection.

[Setup guide for JWE OIDC SSO](/api-management/single-sign-on-social-idp#log-into-an-app-with-github-oauth)
</Accordion>

<Accordion title='Store Audit Logs in a Database'>
Users can now choose to store Dashboard Audit Logs directly in a database, enabling efficient and reliable log storage. This feature is particularly beneficial for organizations needing persistent audit log retention to meet compliance requirements or for forensic purposes.
</Accordion>

<Accordion title='Access Audit Logs via /audit-logs endpoint'>
A new API endpoint, `/audit-logs`, has been introduced to provide programmatic access to audit logs stored in database. This allows users to retrieve, filter, and analyze logs more effectively. The API supports filtering logs by key attributes like action, IP address, URL accessed, date range, user, and page number.

For detail usage of the `/audit-logs` endpoint, please see [Dashboard API documentation](/tyk-dashboard-api).
</Accordion>

<Accordion title='New Role-Based Access Control (RBAC) for Audit Logs'>
To secure access to audit logs, we’ve added a new Audit Log RBAC group. This ensures that only authorized users can view or retrieve sensitive log information. Administrators can assign this permission as part of their security and compliance strategy.
</Accordion>
</AccordionGroup>



##### Changed



<AccordionGroup>
<Accordion title='Removed AJV validation for Streams config editor'>
Eliminated AJV validation in the Streams Config Editor to prevent false positives on valid YAML configurations. The frontend now solely checks the YAML structure, providing users with greater flexibility without enforcing strict Bento-specific schema rules
</Accordion>

<Accordion title='Hide unnecessary field from API Designer page for Streams'>
Removed an unnecessary field from the API Designer page under the Streams section to enhance clarity. This update impacts the Event Handlers, Detailed Activity Logs, Caching, and Endpoints tabs.
</Accordion>

<Accordion title='Automatic configuration of request validation for path-level parameters during import of OpenAPI description'>
Tyk will now detect path-level parameters in the OpenAPI description and can be set to enable and configure the [Request Validation](/api-management/traffic-transformation/request-validation#request-validation-using-tyk-oas) middleware automatically for these. Previously this automatic detection only worked for method-level parameters in the OpenAPI description.
</Accordion>

<Accordion title='Deprecated SQLite support from Dashboard for RHEL8 compatibility'>
Removed SQLite support to enhance portability and security, ensuring the released binary can now be built statically and no longer relies on system libraries. This change supports continued compatibility with RHEL8.
</Accordion>

<Accordion title='Deprecated External OAuth and OpenID Connect Options in Tyk Dashboard'>
The External OAuth and OpenID Connect authentication options have been deprecated in the Tyk Dashboard. Users are advised to utilize JWT Auth with external IDPs for a more complete integration, while existing functionality remains operational to avoid breaking changes.
</Accordion>

<Accordion title='Updated NPM package dependencies'>
Updated NPM package dependencies of Dashboard, to address security vulnerabilities.
</Accordion>
</AccordionGroup>



##### Fixed



<AccordionGroup>
<Accordion title='Fixed navigation issue with "Back to APIs Page" Button on Streams API page'>
Resolved an issue where the "Back to APIs Page" button was unresponsive on the Streams API page. The button now correctly redirects users to the main APIs page for all API types.
</Accordion>

<Accordion title='Resolved search box limitation on Tyk OAS and Streams API pages'>
Corrected an issue where the search box on the Tyk OAS and Streams API pages only accepted a single character. Users can now input complete search terms, allowing for more accurate searches.
</Accordion>

<Accordion title='Unable to see all *user groups* in Dashboard dropdown'>
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.
</Accordion>
</AccordionGroup>






## 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
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |

##### 3rd Party Dependencies & Tools
{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.

Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.

An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.22 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-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](#upgrading-tyk). 

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.6.1)
- ```bash
  docker pull tykio/tyk-dashboard:v5.6.1
  ```
- Helm charts
  - [Tyk Charts v2.0.0](/developer-support/release-notes/helm-chart#2-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.6.1" data-scroll-offset></a>

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](#Changelog-v5.6.0) below.

##### Per endpoint Rate Limiting for clients

Now you can configure rate limits at the [endpoint level per client](/api-management/rate-limit#key-level-rate-limiting), using new configuration options in the access key. Use Tyk's powerful [security policies](/api-management/policies#what-is-a-security-policy) 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
{/* Required. Use the following statement if there are no breaking changes, or explain if there are */}

There are no breaking changes in this release.

#### Dependencies
{/* Required. Use this section to announce the following types of dependencies compatible with the release:
Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
3rd party dependencies and tools */}
##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |

##### 3rd Party Dependencies & Tools
{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.

Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.

An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.22 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas)|

#### Deprecations
{/* Required. Use the following statement if there are no deprecations, or explain if there are */}

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](/api-management/client-authentication#integrate-with-openid-connect-deprecated)


{/* Optional section!
Used to share and notify users about our plan to deprecate features, configs etc.
Once you put an item in this section, we must keep this item listed in all the following releases till the deprecation happens. */}
{/* ###### Future deprecations */}
#### Upgrade instructions
If you are upgrading to 5.6.0, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.6.0)
- ```bash
  docker pull tykio/tyk-dashboard:v5.6.0
  ```
- Helm charts
  - [tyk-charts v2.1.0](/developer-support/release-notes/helm-chart#2-1-0-release-notes)

#### Changelog
<a id="Changelog-v5.6.0" data-scroll-offset></a>

{/* Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" */}
##### Added
{/* This section should be a bullet point list of new features. Explain:
- The purpose of the new feature
- How does the new feature benefit users?
- Link to documentation of the new feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<Expandable title='Per endpoint client rate limiting'>
Building on the [per-endpoint upstream rate limits](/api-management/rate-limit#api-level-rate-limiting) introduced in Tyk 5.5.0 we have now added [per-endpoint client rate limits](/api-management/rate-limit#key-level-rate-limiting). 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.
</Expandable>



##### Changed

{/* This should be a bullet-point list of updated features. Explain:

- Why was the update necessary?
- How does the update benefit users?
- Link to documentation of the updated feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.

Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='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.
</Accordion>

<Accordion title='Improved documentation and schema for Tyk Dashboard API'>
We have updated the swagger.yml schema for Tyk Dashboard API to reflect the latest changes in product endpoints, payloads, and responses. This update includes new fields and endpoints, improved examples, documentation adjustments, and fixes for schema issues. These enhancements aim to improve usability and ensure that the documentation accurately represents the current code state.
</Accordion>

<Accordion title='Renamed GraphQL "Playground" tab to "Playgrounds"'>
The "Playground" tab in the GraphQL API Designer has been renamed to "Playgrounds." This change consolidates access to both internal and external playgrounds within a single section, offering a more streamlined and intuitive experience for API design and testing.
</Accordion>
</AccordionGroup>



##### Fixed
{/* This section should be a bullet point list that describes the issues fixed in the release. For each fixed issue explain:
- What problem the issue caused
- How was the issue fixed
- Link to (new) documentation created as a result of a fix. For example, a new configuration parameter may have been introduced and documented for the fix
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='Addressed some display issues in Dashboard Analytics and Classic Portal when using PostgreSQL storage'>
- Resolved an issue where HTTP 429 status codes were not being displayed on the Activity Overview page.
- Fixed portal graphs by adding a default "day" grouping resolution to the query.
- Corrected issues with the Error Breakdown related to date parameters, ensuring accurate date handling and display.
</Accordion>

<Accordion title="Dashboard didn't display correctly if more than 10 policies assigned to a key">
We have resolved an issue where the Keys page would display a blank screen if a key was associated with more than 10 policies. The UI has been fixed to display the page properly, regardless of the number of policies attached to a key.
</Accordion>

<Accordion title='Dashboard UI did not prevent multiple versions of a Tyk Classic API from being assigned to a policy'>
When working with Tyk Classic APIs, you cannot permit access to multiple versions of the same API from a single policy. We have fixed an issue in the Dashboard UI where users were able to attach multiple versions to a policy leading to an unusable policy. The UI now correctly prevents the addition of multiple versions of an API to a single policy.
</Accordion>

<Accordion title="Dashboard didn't correctly record scope to policy mappings for JWTs">
We have fixed an issue in the Dashboard UI when assigning multiple claim to policy mappings while configuring JWT auth for an API. The scope name was incorrectly recorded instead of the policy ID for the second and subsequent JWT scope mappings. The UI now correctly associates the defined claim with the appropriate policy, ensuring accurate JWT scope to policy mappings.
</Accordion>

<Accordion title='Gateway logs page not displaying correctly'>
We have fixed an issue in the Monitoring section of the Dashboard UI where the *Gateway logs* page was not displaying correctly. The page is now rendered properly, ensuring users with appropriate permissions can view and manage *Gateway logs* as expected.
</Accordion>
</AccordionGroup>




---

## 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 |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.21       | 1.21       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.21 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-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](#upgrading-tyk). 

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.5.2)
- ```bash
  docker pull tykio/tyk-dashboard:v5.5.2
  ```
- Helm charts
  - [Tyk Charts v2.0.0](/developer-support/release-notes/helm-chart#2-0-0-release-notes)

#### 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](https://go.dev/dl/)                               | 1.21       | 1.21       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.21 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-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](#upgrading-tyk). 

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.5.1)
- ```bash
  docker pull tykio/tyk-dashboard:v5.5.1
  ```
- Helm charts
  - [Tyk Charts v2.0.0](/developer-support/release-notes/helm-chart#2-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.5.1" data-scroll-offset></a>

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](#Changelog-v5.5.0) 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](/api-management/rate-limit#tyk-oas-api-definition) and [Tyk Classic APIs](/api-management/rate-limit#tyk-classic-api-definition), providing granular protection for upstream services against overloading and abuse.

#### Breaking Changes
{/* Required. Use the following statement if there are no breaking changes, or explain if there are */}

There are no breaking changes in this release.

#### Dependencies
{/* Required. Use this section to announce the following types of dependencies compatible with the release:
Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
3rd party dependencies and tools */}
##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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
{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.

Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.

An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.21       | 1.21       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.21 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas)|

#### Deprecations
{/* Required. Use the following statement if there are no deprecations, or explain if there are */}
There are no deprecations in this release.
{/* Optional section!
Used to share and notify users about our plan to deprecate features, configs etc.
Once you put an item in this section, we must keep this item listed in all the following releases till the deprecation happens. */}
{/* ###### Future deprecations */}
#### Upgrade instructions
If you are upgrading to 5.5.0, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.5.0)
- ```bash
  docker pull tykio/tyk-dashboard:v5.5.0
  ```
- Helm charts
  - [tyk-charts v1.6](/developer-support/release-notes/helm-chart#1-6-0-release-notes)

#### Changelog
<a id="Changelog-v5.5.0" data-scroll-offset></a>

{/* Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" */}
##### Added
{/* This section should be a bullet point list of new features. Explain:
- The purpose of the new feature
- How does the new feature benefit users?
- Link to documentation of the new feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='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.
</Accordion>

<Accordion title='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 the `url_versioning_pattern` field in the API definition using the raw API editor.
</Accordion>

<Accordion title='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.
</Accordion>
</AccordionGroup>



##### Changed



<Expandable title='Updated NPM packages dependencies'>
Updated npm package dependencies of Dashboard, to address security vulnerabilities.
</Expandable>



##### Fixed
{/* This section should be a bullet point list that describes the issues fixed in the release. For each fixed issue explain:
- What problem the issue caused
- How was the issue fixed
- Link to (new) documentation created as a result of a fix. For example, a new configuration parameter may have been introduced and documented for the fix
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='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.
</Accordion>

<Accordion title='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.
</Accordion>

<Accordion title='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.
</Accordion>

<Accordion title='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.
</Accordion>
</AccordionGroup>
 


##### Security Fixes
{/* This section should be a bullet point list that should be included when any security fixes have been made in the release, e.g. CVEs. For CVE fixes, consideration needs to be made as follows:
1. Dependency-tracked CVEs - External-tracked CVEs should be included on the release note.
2. Internal scanned CVEs - Refer to the relevant engineering and delivery policy.
For agreed CVE security fixes, provide a link to the corresponding entry on the NIST website. For example:
- Fixed the following CVEs:
    - [CVE-2022-33082](https://nvd.nist.gov/vuln/detail/CVE-2022-33082) */}


<Expandable title='High priority CVEs fixed'>
Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:
- [CVE-2023-39325](https://nvd.nist.gov/vuln/detail/CVE-2023-39325)
- [CVE-2023-45283](https://nvd.nist.gov/vuln/detail/CVE-2023-45283)
</Expandable>



---

## 5.4 Release Notes
### 5.4.0 Release Notes
#### Release Date 2 July 2024
#### Breaking Changes
{/* Required. Use the following statement if there are no breaking changes, or explain if there are */}
**Attention: Please read this section carefully**
There are no breaking changes in this release.

#### Dependencies
{/* Required. Use this section to announce the following types of dependencies compatible with the release:
Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
3rd party dependencies and tools */}
##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |

##### 3rd Party Dependencies & Tools
{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.

Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.

An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.21       | 1.21       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.21 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas)|

#### Deprecations
{/* Required. Use the following statement if there are no deprecations, or explain if there are */}
There are no deprecations in this release.
{/* Optional section!
Used to share and notify users about our plan to deprecate features, configs etc.
Once you put an item in this section, we must keep this item listed in all the following releases till the deprecation happens. */}
{/* ###### Future deprecations */}
#### Upgrade instructions
If you are upgrading to 5.4.0, please follow the detailed [upgrade instructions](#upgrading-tyk).
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](/api-management/gateway-events#event-handling-with-webhooks).

#### 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](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.4.0)
- ```bash
  docker pull tykio/tyk-dashboard:v5.4.0
  ```
- Helm charts
  - [tyk-charts v1.5](/developer-support/release-notes/helm-chart#1-5-0-release-notes)

#### Changelog
{/* Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" */}
##### Added
{/* This section should be a bullet point list of new features. Explain:
- The purpose of the new feature
- How does the new feature benefit users?
- Link to documentation of the new feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='Introduced Rate Limit Smoothing for Redis Rate Limiter'>
Implemented a [rate limit smoothing mechanism](/api-management/rate-limit#rate-limit-smoothing) to gradually adjust the rate limit as the request rate increases and decreases between an intermediate threshold and the maximum rate limit. New `RateLimitSmoothingUp` and `RateLimitSmoothingDown` events will be triggered as this smoothing occurs, supporting auto-scaling of upstream capacity. The smoothing process gradually increases the rate, thereby unblocking clients that exceed the current request rate in a staggered manner.
</Accordion>

<Accordion title='Updated API designer toolbar for GraphQL and Universal Data Graph'>
Revamped the API designer toolbar for GraphQL and Universal Data Graph, consolidating all relevant actions for each API type under a single menu dropdown for improved usability.
</Accordion>

<Accordion title='Updated API designer toolbar for HTTP and TCP'>
Revamped the API designer toolbar for HTTP and TCP, consolidating all relevant actions for each API type under a single menu dropdown for improved usability.
</Accordion>

<Accordion title='New Tyk OAS features'>
We’ve added some more features to the Tyk OAS API, moving closer to full parity with Tyk Classic. In this release we’ve added controls that allow you: to enable or prevent generation of traffic logs at the API-level; to enable or prevent the availability of session context to middleware and to pin public key certificates to an API. We’ve also added the facility to register webhooks that will be fired in response to Gateway events.
</Accordion>

<Accordion title='New Dashboard API endpoints'>
We have added a new `/oas/dry-run` endpoint to the Tyk Dashboard API. This uses the Dashboard’s logic to create or update a Tyk OAS API definition using an OpenAPI document without instantiating the API on the Tyk platform.
</Accordion>
</AccordionGroup>



##### Fixed
{/* This section should be a bullet point list that describes the issues fixed in the release. For each fixed issue explain:
- What problem the issue caused
- How was the issue fixed
- Link to (new) documentation created as a result of a fix. For example, a new configuration parameter may have been introduced and documented for the fix
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='Fixed template inheritance issue in API Designer'>
Resolved a bug in the API Designer where certain properties, such as `use_immutable_headers`, were not correctly inherited from the new API template. This fix ensures all default settings from the template are properly applied when creating a new API.
</Accordion>

<Accordion title='Corrected assignment issue for API Templates in Tyk organizations'>
Fixed an issue where API Templates were not correctly assigned to Tyk Organizations, preventing potential accidental sharing of secret data between Organizations through the use of incorrect templates.
</Accordion>

<Accordion title='Addressed keyboard shortcut issues in Universal Data Graph URL field configuration'>
Fixed an issue where common keyboard shortcuts (Cmd + X, A, C, V) were not functioning correctly when configuring the URL field for a UDG data source.
</Accordion>

<Accordion title='Streamlined data source import endpoint in Dashboard API'>
Improved the data source import endpoint in the Dashboard API by removing the need for users to convert OpenAPI/AsyncAPI documents into strings before submission. Users can now provide the documents directly, enhancing the overall user experience.
</Accordion>

<Accordion title='Enhanced password reset security'>
Modified default OPA rules to fix an issue where admins were unable to reset their own password. Tyk Dashboard clients using custom OPA rules should update their rule set accordingly. Contact your assigned Tyk representative for assistance.
</Accordion>

<Accordion title='Corrected filtering for Dashboard Analytics with PostgreSQL'>
Addressed an issue in the api/usage endpoint where Dashboard analytics with PostgreSQL returned unfiltered results. The endpoint now correctly filters results, eliminating the need for duplicating parameters to handle multiple tags.
</Accordion>

<Accordion title='Minor Dashboard UI fixes and improvements'>
We have made some improvements to the wording used in the Dashboard user interface and fixed some minor usability issues.
</Accordion>
</AccordionGroup>



##### Security Fixes
{/* This section should be a bullet point list that should be included when any security fixes have been made in the release, e.g. CVEs. For CVE fixes, consideration needs to be made as follows:
1. Dependency-tracked CVEs - External-tracked CVEs should be included on the release note.
2. Internal scanned CVEs - Refer to the relevant engineering and delivery policy.
For agreed CVE security fixes, provide a link to the corresponding entry on the NIST website. For example:
- Fixed the following CVEs:
    - [CVE-2022-33082](https://nvd.nist.gov/vuln/detail/CVE-2022-33082) */}


<Expandable title='High priority CVEs fixed'>
Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:
- [CVE-2023-39325](https://nvd.nist.gov/vuln/detail/CVE-2023-39325)
- [CVE-2023-45283](https://nvd.nist.gov/vuln/detail/CVE-2023-45283)
</Expandable>



---
{/*  */}


## 5.3 Release Notes

### 5.3.12 Release Notes

#### Release Date 12th September 2025

#### Release Highlights

This is a version bump to align with Gateway v5.3.12, 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.12 | MDCB v2.8.4     | 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 |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.23       | 1.23       | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | Used by Tyk Dashboard | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | Used by Tyk Dashboard | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | Used by Tyk Dashboard | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions

If you are upgrading to 5.3.12, please follow the detailed [upgrade instructions](#upgrading-tyk).

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.12)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.3.12
    ```

- Helm charts
  - [tyk-charts v3.0.0](/developer-support/release-notes/helm-chart#3-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.3.12" data-scroll-offset></a>

No changes in this release.

---

### 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](#Changelog-v5.3.11) 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 |

##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.23       | 1.23       | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 13.x - 17.x        | 13.x - 17.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas#tyk-vendor-extension-reference)|

#### Deprecations

There are no deprecations in this release.

#### Upgrade instructions

If you are upgrading to 5.3.11, please follow the detailed [upgrade instructions](#upgrading-tyk). 

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.11)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.3.11
    ```
- Helm charts
  - [tyk-charts v3.0.0](/developer-support/release-notes/helm-chart#3-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.3.11" data-scroll-offset></a>

##### Fixed



<AccordionGroup>
<Accordion title='License allocation now works across multiple dashboards'>
Fixed an issue where the Dashboard might not allow the correct number of Gateways to connect. This was due to a conflict with license management in deployments with multiple Dashboards which has now been resolved.
</Accordion>

<Accordion title='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
</Accordion>

<Accordion title='Enhanced OPA Rules for Token Reset and User Data Access'>
Updated OPA rules in the Dashboard to allow all users to reset their access tokens and view their user data, improving self-service while maintaining security.

Users with custom OPA rules are <b>strongly advised</b> to add the `is_self_key_reset` and `is_me` helper rules to their configuration. They should then modify existing relevant rules to exclude cases where `is_self_key_reset` or `is_me` apply, to enable this functionality.
</Accordion>

<Accordion title='Various fixes to the Dashboard UI'>
We have implemented various fixes and improvements in the Dashboard GUI to enhance usability.
</Accordion>
</AccordionGroup>



#### Security Fixes 



<Expandable title='High priority CVEs fixed'>
Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:
- [CVE-2025-46569](https://nvd.nist.gov/vuln/detail/CVE-2025-46569)
</Expandable>



### 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](https://nvd.nist.gov/vuln/detail/CVE-2025-21613). For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.3.10) 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 |


##### 3rd Party Dependencies & Tools

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments |
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- |
| [GoLang](https://go.dev/dl/)                               | 1.23       | 1.23       | [Go plugins](/api-management/plugins/golang) must be built using Go 1.23 |
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-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](#upgrading-tyk).

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.10)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.3.10
    ```
- Helm charts
  - [tyk-charts v2.0.0](/developer-support/release-notes/helm-chart#2-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.3.10" data-scroll-offset></a>

##### Fixed



<Expandable title='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.
</Expandable>



##### Security Fixes



<Expandable title='Critical Priority CVEs Fixed'>
Fixed the following critical priority CVE identified in the Dashboard UI, providing increased protection and improved security:
    - [CVE-2025-21613](https://nvd.nist.gov/vuln/detail/CVE-2025-21613)
</Expandable>


<Expandable title='High Priority CVE Fixed'>
- Fixed the following CVE:
    - [CVE-2025-21614](https://nvd.nist.gov/vuln/detail/CVE-2025-21614)
</Expandable>



---

### 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](#Changelog-v5.3.9) below.

#### Breaking Changes

This release has no breaking changes.

#### Dependencies

##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |


##### 3rd Party Dependencies & Tools
{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.
Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.
An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments |
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- |
| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.22 |
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-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](#upgrading-tyk).

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.9)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.3.9
    ```
- Helm charts
  - [tyk-charts v2.0.0](/developer-support/release-notes/helm-chart#2-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.3.9" data-scroll-offset></a>

{/* Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" */}

##### Fixed
{/* This section should be a bullet point list of new features. Explain:

- The purpose of the new feature
- How does the new feature benefit users?
- Link to documentation of the new feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.

Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}



<AccordionGroup>
<Accordion title='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.
</Accordion>

<Accordion title='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.
</Accordion>

<Accordion title='CVE-2020-8911 resolved in Tyk Dashboard'>
Resolved CVE-2020-8911 by updating the Tyk Dashboard's email driver to use AWS SDK v2, addressing a medium-severity security vulnerability identified in version 5.3.8. This update ensures enhanced security for the Dashboard while maintaining functionality.
</Accordion>
</AccordionGroup>



---

### 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](#Changelog-v5.3.8) below.

#### Breaking Changes

This release has no breaking changes.

#### Dependencies

##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |


##### 3rd Party Dependencies & Tools
{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.
Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.
An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments |
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- |
| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.22 |
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-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](/api-management/client-authentication#integrate-with-external-authorization-server-deprecated) and [OpenID Connect](/api-management/client-authentication#integrate-with-openid-connect-deprecated) methods migrate to Tyk's dedicated [JWT Auth](/basic-config-and-security/security/authentication-authorization/json-web-tokens) 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](#upgrading-tyk).


#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.8)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.3.8
    ```
- Helm charts
  - [tyk-charts v2.0.0](/developer-support/release-notes/helm-chart#2-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.3.8" data-scroll-offset></a>

{/* Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" */}
##### Added



<Expandable title='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](/api-management/client-authentication#integrate-with-external-authorization-server-deprecated) and [OpenID Connect (OIDC)](/api-management/client-authentication#integrate-with-openid-connect-deprecated) 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](/basic-config-and-security/security/authentication-authorization/json-web-tokens) method, which supports integration with both OAuth and OIDC providers, in preparation for future upgrade.
</Expandable>



##### Fixed
{/* This section should be a bullet point list of new features. Explain:

- The purpose of the new feature
- How does the new feature benefit users?
- Link to documentation of the new feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.

Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<Expandable title='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.
</Expandable>


<Expandable title='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
</Expandable>



---
### 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
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |


##### 3rd Party Dependencies & Tools
{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.
Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.
An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments |
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- |
| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.22 |
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-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](#upgrading-tyk). 

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.7)
- ```bash
  docker pull tykio/tyk-dashboard:v5.3.7
  ```
- Helm charts
  - [Tyk Charts v2.0.0](/developer-support/release-notes/helm-chart#2-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.3.7" data-scroll-offset></a>

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](#Changelog-v5.3.6) below.

#### Breaking Changes
**Attention**: Please read this section carefully.
Docker images are now based on [distroless](https://github.com/GoogleContainerTools/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](#TykOAS-v5.3.0).

#### Deprecations
There are no deprecations in this release.

#### Upgrade Instructions
When upgrading to 5.3.6, please follow the [detailed upgrade instructions](#upgrading-tyk).

#### Dependencies
{/* Required. Use this section to announce the following types of dependencies compatible with the release:
Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
3rd party dependencies and tools */}

With MongoDB 4.4 reaching [EOL](https://www.mongodb.com/legal/support-policy/lifecycles) in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are [using MongoDB](/planning-for-production/database-settings#mongodb) we recommend that you upgrade to a version that we have tested with, as indicated [below](#3rdPartyTools-v5.3.6).


With PostgreSQL v11 reaching [EOL](https://www.postgresql.org/support/versioning/) in November 2023, we can no longer guarantee full compatibility with this version of the database. If you are [using PostgreSQL](/planning-for-production/database-settings#postgresql) we recommend that you upgrade to a version that we have tested with, as indicated [below](#3rdPartyTools-v5.3.6).


##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |


##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.3.6"></a>

{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.
Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.
An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments |
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- |
| [GoLang](https://go.dev/dl/)                               | 1.22       | 1.22       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.22 |
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas)|

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.6)
 - ```bash
   docker pull tykio/tyk-dashboard:v5.3.6
   ```
- Helm charts
 - [tyk-charts v2.0](/developer-support/release-notes/helm-chart#2-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.3.6" data-scroll-offset></a>

{/* Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" */}

##### Changed
{/* This should be a bullet-point list of updated features. Explain:
- Why was the update necessary?
- How does the update benefit users?
- Link to documentation of the updated feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<Expandable title='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.
</Expandable>


 <Expandable title='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](https://github.com/GoogleContainerTools/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.
</Expandable>
 


##### Fixed
{/* This section should be a bullet point list of new features. Explain:

- The purpose of the new feature
- How does the new feature benefit users?
- Link to documentation of the new feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.

Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='Gateway secret could be exposed in debug logs'>
Resolved an issue where the Gateway secret was inadvertently included in the log generated by the Dashboard for a call to the `/api/keys` endpoint when in debug mode. This issue has been fixed to prevent sensitive information from appearing in system logs.
</Accordion>

<Accordion title="Dashboard didn't display correctly if more than 10 policies assigned to a key">
We have resolved an issue where the Keys page would display a blank screen if a key was associated with more than 10 policies. The UI has been fixed to display the page properly, regardless of the number of policies attached to a key.
</Accordion>

<Accordion title='Dashboard UI did not prevent multiple versions of a Tyk Classic API from being assigned to a policy'>
When working with Tyk Classic APIs, you cannot permit access to multiple versions of the same API from a single policy. We have fixed an issue in the Dashboard UI where users were able to attach multiple versions to a policy leading to an unusable policy. The UI now correctly prevents the addition of multiple versions of an API to a single policy.
</Accordion>

<Accordion title="Dashboard didn't correctly record scope to policy mappings for JWTs">
We have fixed an issue in the Dashboard UI when assigning multiple claim to policy mappings while configuring JWT auth for an API. The scope name was incorrectly recorded instead of the policy ID for the second and subsequent JWT scope mappings. The UI now correctly associates the defined claim with the appropriate policy, ensuring accurate JWT scope to policy mappings.
</Accordion>
</AccordionGroup>




##### Security Fixes
{/* This section should be a bullet point list that should be included when any security fixes have been made in the release, e.g. CVEs. For CVE fixes, consideration needs to be made as follows:
1. Dependency-tracked CVEs - External-tracked CVEs should be included on the release note.
2. Internal scanned CVEs - Refer to the relevant engineering and delivery policy.
For agreed CVE security fixes, provide a link to the corresponding entry on the NIST website. For example:
- Fixed the following CVEs:
    - [CVE-2022-33082](https://nvd.nist.gov/vuln/detail/CVE-2022-33082) */}


<Expandable title='High priority CVEs fixed'>
Fixed the following high-priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:
- [CVE-2024-6104](https://nvd.nist.gov/vuln/detail/CVE-2024-6104)
</Expandable>

   


---

### 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](#TykOAS-v5.3.0).


#### Deprecations

There are no deprecations in this release.


#### Upgrade Instructions

When upgrading to 5.3.5, please follow the [detailed upgrade instructions](#upgrading-tyk).


#### Dependencies

{/* Required. Use this section to announce the following types of dependencies compatible with the release:
Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
3rd party dependencies and tools */}

With MongoDB 4.4 reaching [EOL](https://www.mongodb.com/legal/support-policy/lifecycles) in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are [using MongoDB](/planning-for-production/database-settings#mongodb) we recommend that you upgrade to a version that we have tested with, as indicated [below](#3rdPartyTools-v5.3.5).


With PostgreSQL v11 reaching [EOL](https://www.postgresql.org/support/versioning/) in November 2023, we can no longer guarantee full compatibility with this version of the database. If you are [using PostgreSQL](/planning-for-production/database-settings#postgresql) we recommend that you upgrade to a version that we have tested with, as indicated [below](#3rdPartyTools-v5.3.5).


##### Compatibility Matrix For Tyk Components

{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |


##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.3.5"></a>

{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.
Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.
An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments |
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- |
| [GoLang](https://go.dev/dl/)                               | 1.21       | 1.21       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.21 |
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas)|

#### Downloads

- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.5)
 - ```bash
   docker pull tykio/tyk-dashboard:v5.3.5
   ```
- Helm charts
 - [tyk-charts v2.0.0](/developer-support/release-notes/helm-chart#2-0-0-release-notes)

#### Changelog
<a id="Changelog-v5.3.5" data-scroll-offset></a>

 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](#TykOAS-v5.3.0).

#### Deprecations
There are no deprecations in this release.

#### Upgrade Instructions
When upgrading to 5.3.4 please follow the [detailed upgrade instructions](#upgrading-tyk).


#### Release Highlights
For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.3.4) below.

#### Dependencies
{/* Required. Use this section to announce the following types of dependencies compatible with the release:
Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
3rd party dependencies and tools */}

With MongoDB 4.4 reaching [EOL](https://www.mongodb.com/legal/support-policy/lifecycles) in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are [using MongoDB](/planning-for-production/database-settings#mongodb) we recommend that you upgrade to a version that we have tested with, as indicated [below](#3rdPartyTools-v5.3.3).


With PostgreSQL v11 reaching [EOL](https://www.postgresql.org/support/versioning/) in November 2023, we can no longer guarantee full compatibility with this version of the database. If you are [using PostgreSQL](/planning-for-production/database-settings#postgresql) we recommend that you upgrade to a version that we have tested with, as indicated [below](#3rdPartyTools-v5.3.3).


##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |


##### 3rd Party Dependencies & Tools
{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.
Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.
An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments |
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- |
| [GoLang](https://go.dev/dl/)                               | 1.21       | 1.21       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.21 |
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas)|

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.4)
 - ```bash
   docker pull tykio/tyk-dashboard:v5.3.4
   ```
- Helm charts
 - [tyk-charts v1.4](/developer-support/release-notes/helm-chart#1-4-0-release-notes)

#### Changelog
<a id="Changelog-v5.3.4" data-scroll-offset></a>

{/* Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" */}

##### Fixed
{/* This section should be a bullet point list of new features. Explain:

- The purpose of the new feature
- How does the new feature benefit users?
- Link to documentation of the new feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.

Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='Fixed display issue for API stats'>
Fixed API’s stats not being shown when adding 2 or more tags in the Activity page and using Postgres
</Accordion>

<Accordion title='Fixed display issue of 429 status codes on the Activity page'>
Fixed 429 status codes not being shown on the Activity page when using Postgres
</Accordion>

<Accordion title='Fixed display of graphs and requests counter on Portal'>
Fixed wrong graphs and incorrect requests counter on Portal when using Postgres
</Accordion>

<Accordion title='Fixed Error Breakdown display issues with dates'>
Fixed Error Breakdown issues with dates (it was showing errors that happened on different dates than the one that was actually displayed)
</Accordion>
</AccordionGroup>


   
---
### 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](#TykOAS-v5.3.0).

#### Deprecations
There are no deprecations in this release.

#### Upgrade Instructions
When upgrading to 5.3.3 please follow the [detailed upgrade instructions](#upgrading-tyk).

#### Release Highlights

For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.3.3) below.

#### Dependencies
{/* Required. Use this section to announce the following types of dependencies compatible with the release:
Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
3rd party dependencies and tools */}

With MongoDB 4.4 reaching [EOL](https://www.mongodb.com/legal/support-policy/lifecycles) in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are [using MongoDB](/planning-for-production/database-settings#mongodb) we recommend that you upgrade to a version that we have tested with, as indicated [below](#3rdPartyTools-v5.3.3).


With PostgreSQL v11 reaching [EOL](https://www.postgresql.org/support/versioning/) in November 2023, we can no longer guarantee full compatibility with this version of the database. If you are [using PostgreSQL](/planning-for-production/database-settings#postgresql) we recommend that you upgrade to a version that we have tested with, as indicated [below](#3rdPartyTools-v5.3.3).


##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |


##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.3.3"></a>

{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.
Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.
An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments |
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- |
| [GoLang](https://go.dev/dl/)                               | 1.21       | 1.21       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.21 |
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x        | 12.x - 16.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas)|

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.3)
 - ```bash
   docker pull tykio/tyk-dashboard:v5.3.3
   ```
- Helm charts
 - [tyk-charts v1.4](/developer-support/release-notes/helm-chart#1-4-0-release-notes)

#### Changelog
<a id="Changelog-v5.3.3" data-scroll-offset></a>

{/* Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" */}

##### Added
{/* This section should be a bullet point list of new features. Explain:

- The purpose of the new feature
- How does the new feature benefit users?
- Link to documentation of the new feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.

Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<Expandable title='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.
</Expandable>



---

##### Fixed
{/* This section should be a bullet point list that describes the issues fixed in the release. For each fixed issue explain:
- What problem the issue caused
- How was the issue fixed
- Link to (new) documentation created as a result of a fix. For example, a new configuration parameter may have been introduced and documented for the fix
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='Save API button now visible for all users'>
Addressed an issue in SSO where user permissions were not correctly applied, ensuring the Save API button is visible to all users in the Dashboard UI.
</Accordion>

<Accordion title='Dashboard blank page issue when retrieving key for API with mTLS and dynamic JWT Auth fixed'>
Resolved a bug causing the Dashboard UI to display a blank page when creating a key for an API using static mTLS with dynamic JWT authentication.
</Accordion>

<Accordion title='Empty Endpoint popularity page issue resolved in version 5.3.1'>
Addressed an issue where the Dashboard displayed an empty page when accessing Activity by Endpoint information after upgrading to Tyk 5.3.1. Users can now see all necessary information.
</Accordion>
</AccordionGroup>



---

### 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](#TykOAS-v5.3.0).


#### Deprecations
There are no deprecations in this release.


#### Upgrade Instructions
When upgrading to 5.3.2 please follow the [detailed upgrade instructions](#upgrading-tyk).


#### Release Highlights
This release primarily focuses on bug fixes.
For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.3.2) below.


#### Dependencies
{/* Required. Use this section to announce the following types of dependencies compatible with the release:


Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.


3rd party dependencies and tools */}


With MongoDB 4.4 reaching [EOL](https://www.mongodb.com/legal/support-policy/lifecycles) in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are [using MongoDB](/planning-for-production/database-settings#mongodb) we recommend that you upgrade to a version that we have tested with, as indicated [below](#3rdPartyTools-v5.3.2).

With PostgreSQL v11 reaching [EOL](https://www.postgresql.org/support/versioning/) in November 2023, we can no longer guarantee full compatibility with this version of the database. If you are [using PostgreSQL](/planning-for-production/database-settings#postgresql) we recommend that you upgrade to a version that we have tested with, as indicated [below](#3rdPartyTools-v5.3.2).

##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |


##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.3.2"></a>

{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.


Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.


An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}


| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments |
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- |
| [GoLang](https://go.dev/dl/)                               | 1.21       | 1.21       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.21 |
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | Used by Tyk Dashboard |
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | Used by Tyk Dashboard |
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | Used by Tyk Dashboard | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 12.x - 16.x LTS        | 12.x - 16.x            | Used by Tyk Dashboard |
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas)|


#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.2)
  - ```bash
    docker pull tykio/tyk-dashboard:v5.3.2
    ```
- Helm charts
  - [tyk-charts v1.4](/developer-support/release-notes/helm-chart#1-4-0-release-notes)


#### Changelog
<a id="Changelog-v5.3.2" data-scroll-offset></a>

{/* Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.
Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" */}

##### Fixed
{/* This section should be a bullet point list that describes the issues fixed in the release. For each fixed issue explain:
- What problem the issue caused
- How was the issue fixed
- Link to (new) documentation created as a result of a fix. For example, a new configuration parameter may have been introduced and documented for the fix
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.
Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='Fixed Dashboard Analytics for PostgreSQL'>
Resolved an issue in the `api/usage` endpoint where the Dashboard with PostgreSQL integration returned unfiltered results when one valid tag was used. Corrected the need for duplicating the same parameter as a workaround for filtering by multiple tags. Results are now properly filtered as expected, improving the accuracy and reliability of analytics data.
</Accordion>

<Accordion title='Enhanced Password Reset security'>
Modified default OPA rules to prevent unauthorized admins from modifying other admins' passwords, mitigating potential 'rogue admin' behavior. Tyk Dashboard clients using custom OPA rules should update their rule set accordingly. Contact your assigned Tyk representative for assistance.
</Accordion>

<Accordion title='Fixed Universal Data Graph Schema Editor Import Issue'>
Resolved an issue in the GQL schema editor for Data Graphs, where users couldn't utilize the 'Import Schema' button. Now, it's possible to import files containing GQL schemas into the Dashboard.
</Accordion>

<Accordion title='Enhanced Dashboard UI language'>
Adjusted wording in Tyk's Dashboard UI to ensure inclusivity and clarity, removing any potentially oppressive language.
</Accordion>

<Accordion title='API Template not associated with Tyk Organization'>
Fixed an issue where API Templates were not correctly assigned to Tyk Organizations allowing the potential for accidental sharing of secret data between Organizations through use of the incorrect template.
</Accordion>

<Accordion title='Added control over access to context variables from middleware when using Tyk OAS APIs'>
Addressed a potential issue when working with Tyk OAS APIs where request context variables are automatically made available to relevant Tyk and custom middleware. We have introduced a control in the Tyk OAS API definition to disable this access if required.
</Accordion>

<Accordion title='Resolved PostgreSQL Dashboard Analytics issue'>
Fixed an issue in the api/usage endpoint where Dashboard+Postgres returned unfiltered results with one valid tag, requiring duplication of the parameter as a workaround for multiple tags. Analytics now correctly filter results as expected.
</Accordion>
</AccordionGroup>



---

### 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](#TykOAS-v5.3.0).

#### Deprecations
There are no deprecations in this release.

#### Upgrade Instructions
When upgrading to 5.3.1, please follow the [detailed upgrade instructions](#upgrading-tyk).


#### Release Highlights
This release primarily focuses on bug fixes.
For a comprehensive list of changes, please refer to the detailed [changelog](#Changelog-v5.3.1) below.

#### Dependencies
{/* Required. Use this section to announce the following types of dependencies compatible with the release:

Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.

3rd party dependencies and tools */}

With MongoDB 4.4 reaching [EOL](https://www.mongodb.com/legal/support-policy/lifecycles) in February 2024, we can no longer guarantee full compatibility with this version of the database. If you are [using MongoDB](/planning-for-production/database-settings#mongodb) we recommend that you upgrade to a version that we have tested with, as indicated [below](#3rdPartyTools-v5.3.1).

##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |

##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.3.1"></a>

{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.

Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.

An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.21       | 1.21       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.21 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | | 
| [DocumentDB](https://aws.amazon.com/documentdb/)  | 4, 5  | 4, 5  | | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 11.x - 15.x        | 11.x - 15.x            | | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-tyk-oas)|

#### Downloads
- [Docker Image to pull](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.1)
- ```bash
  docker pull tykio/tyk-dashboard:v5.3.1
  ```
- Helm charts
  - [tyk-charts v1.3](/developer-support/release-notes/helm-chart#1-3-0-release-notes)

#### Changelog
<a id="Changelog-v5.3.1" data-scroll-offset></a>

##### Fixed



<AccordionGroup>
<Accordion title='Improved security: user search method transitioned to POST'>
Improved the behavior of the Dashboard when searching for users to avoid transmitting sensitive information (user email addresses) in the request query parameters. Deprecated the `GET` method for the `/api/users/search` endpoint in favor of a `POST` method with the same logic but with parameters supplied in the request body.
</Accordion>

<Accordion title='Improved security: removal of Access-Control-Allow-Credentials header'>
As Tyk Dashboard and Tyk Classic Portal do not accept cross origin requests we have removed the `Access-Control-Allow-Credentials` header from Dashboard API responses to prevent any potential misuse of the header by attackers. This allows simplification of the web application's security configuration.
</Accordion>

<Accordion title='Improved security: mitigation against brute force attacks based on login response time analysis'>
Implemented a randomised delay to obscure login response times, mitigating brute force attacks that rely on response time analysis.
</Accordion>

<Accordion title='Improved security: now unable to log into deleted Orgs'>
Fixed a bug where a user was still able to log into an Organization on the Tyk Dashboard after that Organization had been deleted. Now, when an Organization is deleted, it will not be offered as an option when logging in.
</Accordion>

<Accordion title='Improved security: suppressed accidental exposure of access keys to stdout'>
Fixed an issue where access keys could accidentally also be printed to the Dashboard's stdout when a call was made to `/api/keys` to retrieve the keys. This has now been suppressed.
</Accordion>

<Accordion title='Endpoint Designer does not handle wildcards in GraphQL policy allow/block lists'>
The Endpoint Designer did not correctly display a GraphQL policy's allow or block list if a wildcard character (`*`) was used in the list's definition. This has been fixed and now, if the wildcard (`*`) is present in the allow/block list definition, the UI correctly displays the list of allowed/blocked fields.
</Accordion>

<Accordion title='Open Policy Agent editor fails to open on Windows platform'>
Fixed an issue that was preventing the OPA editor from being visible using the keyboard shortcut when using Microsoft Windows.
</Accordion>

<Accordion title='Common keyboard shortcuts not working with UDG URL field in Data Graph Designer'>
Fixed an issue where common keyboard shortcuts (Cmd + X, A, C, V) were not working correctly when configuring the URL field for a UDG data source.
</Accordion>

<Accordion title='Unexplained HTTP 400 error reported in Tyk OAS API Designer'>
Fixed an issue in the Tyk OAS API Designer where there was no input validation of the OAuth Introspection URL. The Gateway reported an HTTP 400 error when attempting to save an API with an illegal value, however the API Designer did not guide the user to the source of the error. Now there is automatic validation of the text entered in the Introspection URL field.
</Accordion>

<Accordion title='Replaced the text editor used in Tyk Dashboard to address cursor issues'>
Fixed an issue with the text editor in the Tyk OAS API Designer where the cursor was misaligned with where characters would be entered. We have replaced the text editor module throughout the Tyk Dashboard to use a more modern, supported library.
</Accordion>

<Accordion title='Activity by Graph chart sometimes had display issues'>
The 'Top 5 Errors by Graph' bar chart in the Activity by Graph dashboard experienced display issues with long graph names and sometimes showed empty bars. This has been resolved, and the chart now displays accurately.
</Accordion>

<Accordion title='Analytics screens fail when too many requests are aggregated'>
Fixed a bug where some Tyk Dashboard analytics screens stopped working when the analytics aggregates collection grew too large.
</Accordion>

<Accordion title='Unable to delete APIs from DocumentDB storage'>
In [Tyk 5.2.2](#Changelog-v5.2.2) we fixed an issue when using MongoDB and Tyk Security Policies where Tyk could incorrectly grant access to an API after that API had been deleted from the associated policy. This introduced an unintended side-effect for users of DocumentDB such that they were unable to delete APIs from the persistent storage. We identified that this was due to the use of the `$expr` operator in the solution - and discovered that this is supported by MongoDB but not by DocumentDB. We have now reimplemented the fix and removed the limitation introduced for DocumentDB users.
</Accordion>

<Accordion title='Unable to clear the API cache in distributed data plane Gateways from the control plane Dashboard'>
Addressed a bug where clearing the API cache from the Tyk Dashboard failed to invalidate the cache in distributed data plane gateways.
</Accordion>
</AccordionGroup>



---

### 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
<a id="TykOAS-v5.3.0"></a>

This upgrade transitions Tyk OAS APIs out of [Early Access](/developer-support/release-types/early-access-feature).

- **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](https://tinyurl.com/3xy966xn). 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](#upgrade-instructions) 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](https://tinyurl.com/t3zz88ep) 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](#upgrade-instructions) section for essential instructions on how to backup before upgrading to v5.3.0
 
#### Dependencies
{/* Required. Use this section to announce the following types of dependencies compatible with the release:

Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.

3rd party dependencies and tools */}

With MongoDB 4.4 reaching [EOL](https://www.mongodb.com/legal/support-policy/lifecycles) 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](#3rdPartyTools-v5.3.0).

##### Compatibility Matrix For Tyk Components
{/* Required. Version compatibility with other components in the Tyk stack. This takes the form of a compatibility matrix and is only required for Gateway and Portal.
An illustrative example is shown below. */}
| 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 |

##### 3rd Party Dependencies & Tools
<a id="3rdPartyTools-v5.3.0"></a>

{/* Required. Third-party dependencies encompass tools (GoLang, Helm etc.), databases (PostgreSQL, MongoDB etc.) and external software libraries. This section should be a table that presents the third-party dependencies and tools compatible with the release. Compatible is used in the sense of those versions tested with the releases. Such information assists customers considering upgrading to a specific release.

Additionally, a disclaimer statement was added below the table, for customers to check that the third-party dependency they decide to install remains in support.

An example is given below for illustrative purposes only. Tested Versions and Compatible Versions information will require discussion with relevant squads and QA. */}

| Third Party Dependency                                     | Tested Versions        | Compatible Versions    | Comments | 
| :---------------------------------------------------------- | :---------------------- | :---------------------- | :-------- | 
| [GoLang](https://go.dev/dl/)                               | 1.21       | 1.21       | [Go plugins](/api-management/plugins/golang#) must be built using Go 1.21 | 
| [Redis](https://redis.io/download/)  | 6.2.x, 7.x  | 6.2.x, 7.x  | Used by Tyk Dashboard | 
| [MongoDB](https://www.mongodb.com/try/download/community)  | 5.0.x, 6.0.x, 7.0.x  | 5.0.x, 6.0.x, 7.0.x  | Used by Tyk Dashboard | 
| [PostgreSQL](https://www.postgresql.org/download/)         | 11.x - 15.x LTS        | 11.x - 15.x            | Used by Tyk Dashboard | 
| [OpenAPI Specification](https://spec.openapis.org/oas/v3.0.3) | v3.0.x      | v3.0.x          | Supported by [Tyk OAS](/api-management/gateway-config-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](/developer-support/upgrading#tyk-upgrade-guides-for-different-deployment-models) 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](/developer-support/upgrading#backup-apis-and-policies).
   - For Self-Managed deployments -  To perform the backup please use [Tyk Sync](/api-management/automations/sync).
4. Performing the upgrade - For all deployments, follow the instructions in the [upgrade guide](#upgrading-tyk) 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](#Changelog-v5.3.0) below.

##### Tyk OAS Feature Maturity

Tyk OAS is now out of [Early Access](/developer-support/release-types/early-access-feature) 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](https://github.com/redis/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](https://github.com/mongodb/mongo-go-driver/releases/tag/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](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=&page_size=&ordering=&name=v5.3.0)
- ```bash
  docker pull tykio/tyk-dashboard:v5.3.0
  ```
- Helm charts
  - [tyk-charts GH Repo](https://github.com/TykTechnologies/tyk-charts/releases)

#### Changelog
<a id="Changelog-v5.3.0" data-scroll-offset></a>

{/* Required. The change log should include the following ordered set of sections below that briefly summarise the features, updates and fixed issues of the release.

Here it is important to explain the benefit of each changelog item. As mentioned by James in a previous Slack message (https://tyktech.slack.com/archives/C044R3ZTN6L/p1686812207060839?thread_ts=1686762128.651249&cid=C044R3ZTN6L):
"...it is important to document the customer impact for the work delivered, so we can share it with prospects/install base. For example:
"New Chart delivers x and y benefit to a and b customer use cases. The business impact for them will be this and that" */}

##### Added
{/* This section should be a bullet point list of new features. Explain:

- The purpose of the new feature
- How does the new feature benefit users?
- Link to documentation of the new feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.

Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='Additional features now supported in Tyk OAS API Designer when working with Tyk OAS APIs'>
The following features have been added in 5.3.0 to bring Tyk OAS to feature maturity:
  - Detailed log recording (include payload in the logs)
  - Enable Open Telemetry tracing
  - API-level header transforms (request and response)
  - Endpoint-level cache
  - Circuit breakers
  - Track endpoint logs for inclusion in Dashboard aggregated data
  - Do-not-track endpoint
  - Enforced upstream timeouts
  - Configure endpoint as Internal (not available externally)
  - URL rewrite
  - Per-endpoint request size limit
  - Request transformation - method, header
  - Response transformation - header
  - Custom domain certificates
</Accordion>

<Accordion title='Implemented Design Elements for GraphQL Permissions'>
Support for field-based permissions allow list has been added in the Dashboard. Users can now define which types and fields from a GraphQL schema an API key holder can access by simply putting a tick next to them in the policy/key definition screens.
</Accordion>

<Accordion title='Added API Categories support for Tyk OAS APIs'>
In this update, we've added support for API Categories for Tyk OAS APIs in the Tyk Dashboard, enhancing portfolio management by enabling efficient categorization and organization of APIs.
</Accordion>

<Accordion title='Added API Ownership support for Tyk OAS APIs'>
We’ve extended the API ownership capabilities of Tyk Dashboard to Tyk OAS APIs. This feature allows you to manage visibility of APIs deployed on the Dashboard, streamlining governance processes and enhancing internal security.
</Accordion>

<Accordion title='Added API Templates for Tyk OAS APIs'>
Extended Tyk Dashboard API to support CRUD operations on API Templates, enabling users to create, apply, and manage templates programmatically.

Added Dashboard UI functionality for creation and management of API Templates, including the ability to create templates from existing Tyk OAS APIs. You can apply templates during API creation, including when importing OpenAPI documents. Access to API templates is controlled through the introduction of a new user permission.
</Accordion>

<Accordion title='Import OpenAPI Documents from File or URL'>
Now you can import the OpenAPI description from a file or URL when creating or updating your Tyk OAS APIs.
</Accordion>

<Accordion title='Introduced Global Header Management for GraphQL'>
Access the new Global Header Management feature directly through the Headers Management tab. Swiftly add and configure multiple global headers or remove them with a single click, ensuring they're forwarded to all GraphQL data sources. This enhancement streamlines header management, providing a more user-friendly experience.
</Accordion>

<Accordion title='Added monitoring capabilities for GraphQL APIs in the Dashboard'>
We’ve enabled basic Graph monitoring in the Dashboard. Due to the specificity of GQL APIs, monitoring them as you would REST, is not enough. One endpoint vs multiple endpoints, multiple queries/mutations vs HTTP methods, errors that happen not only in HTTP layer but also come back in response body - that all makes monitoring GQL slightly more complex than just looking at request and error rates.

A new section of the Dashboard offers the following information:
- top 5 most popular graphs and operations requested within them within a specified period of time
- top 5 graphs with errors within a specified period of time
- summary of number of requests, number of successful responses, number of errors, average latency and last access date within a specified period of time for all graphs
</Accordion>

<Accordion title='Support MongoDB v7.0.x'>
Tyk 5.3 integrates with [storage v1.2.2](https://github.com/TykTechnologies/storage), which updated mongo-go driver we use from v1.11.2 to [mongo-go v1.13.1](https://github.com/mongodb/mongo-go-driver/releases/tag/v1.13.1). It allows us to benefit from the bug fixes and enhancements released by MongoDB. We have also tested that Tyk 5.0.x+ is compatible with MongoDB v7.0.x
</Accordion>

<Accordion title='Support Redis v7.0.x'>
Tyk 5.3 refactors Redis connection logic by using [storage v1.2.2](https://github.com/TykTechnologies/storage/releases/tag/v1.2.2), which integrates with [go-redis](https://github.com/redis/go-redis) v9. Subsequently, support now exists for Redis v7.0.x.
</Accordion>
</AccordionGroup>



  
##### Changed
{/* This should be a bullet-point list of updated features. Explain:

- Why was the update necessary?
- How does the update benefit users?
- Link to documentation of the updated feature
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.

Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='Enhanced Dashboard Navigation: Introducing Favorite Screens'>
Every Dashboard menu item can now be flagged as a favorite so that it is pinned to the top of the menu navigation bar for easier access. We've also made a few changes in styling, so that the navigation menu is nicer to look at.
</Accordion>

<Accordion title='Improved UI for GraphQL Data Source Headers Management'>
We have moved data source header management to a separate tab, so that it is easy to configure global headers that will be forwarded to all data sources by default. The data source configuration screen displays all headers that will be sent with the upstream request in read-only mode now and changes can be made by switching to Headers Management tab.
</Accordion>

<Accordion title='Go 1.21 upgrade for Dashboard'>
We have updated Tyk Dashboard to use Go 1.21, matching the upgrade in Tyk Gateway 1.21. Remember to recompile any custom Go plugins with the matching version of Go to avoid incompatibility problems.
</Accordion>

<Accordion title='The internal TIB session secret defaults to admin_secret if it is not set explicitly'>
If internal TIB is enabled in Dashboard and the TYK_IB_SESSION_SECRET environment variable is not set, it will be default to Dashboard admin_secret. It provides better security and user experience because SSO flow would not work if TYK_IB_SESSION_SECRET is not set.
</Accordion>

<Accordion title='Set default MongoDB driver to mongo-go'>
Tyk uses `mongo-go` as the default MongoDB driver from v5.3. This provides support for MongoDB 4.4.x, 5.0.x, 6.0.x and 7.0.x. If you are using older MongoDB versions e.g. 3.x, please set MongoDB driver to `mgo`. The [MongoDB supported versions](/planning-for-production/database-settings#supported-versions) page provides details on how to configure MongoDB drivers in Tyk.
</Accordion>
</AccordionGroup>


 
##### Fixed
{/* This section should be a bullet point list that describes the issues fixed in the release. For each fixed issue explain:

- What problem the issue caused
- How was the issue fixed
- Link to (new) documentation created as a result of a fix. For example, a new configuration parameter may have been introduced and documented for the fix
- For OSS - Link to the corresponding issue if possible on GitHub to allow the users to see further info.

Each change log item should be expandable. The first line summarises the changelog entry. It should be then possible to expand this to reveal further details about the changelog item. This is achieved using HTML as shown in the example below. */}


<AccordionGroup>
<Accordion title='Resolved OPA rule restriction on UDG OAS import endpoint'>
We fixed an issue where OPA rules were preventing users from importing an OpenAPI document as a UDG data source using the /api/data-graphs/data-sources/import endpoint. The endpoint has now been included into the correct user permission group and will be accessible for users who have `api:write` permissions.
</Accordion>

<Accordion title='Optimized Policy Creation Endpoint'>
Fixed an issue where applying security policies to large numbers of APIs took a long time. We’ve implemented bulk processing in the validation step at the api/portal/policies/POLICY_ID endpoint, resulting in an 80% reduction in the time taken to apply a policy to 2000 APIs.
</Accordion>

<Accordion title='Improved Security for Classic Portal'>
Moved all HTML inline scripts to their own script files, to accommodate the content security policies that have been enabled, to increase security.
</Accordion>

<Accordion title='Errors importing larger OpenAPI Documents'>
Fixed an issue when importing reasonably large OpenAPI documents via the Dashboard would fail due to MongoDB storage limitation of 16 MB per document.
</Accordion>

<Accordion title='Removed the need for a Description to be provided in the OpenAPI schema when autogenerating a Tyk OAS mock response'>
Relaxed the strict validation for mock response so that the `Description` field is now optional for `response`, `responses` and `schema` within the OpenAPI description. Automatically configuring mock responses when using [Tyk OAS APIs](/api-management/traffic-transformation/mock-response#mock-responses-using-openapi-metadata) is now even easier.
</Accordion>

<Accordion title='Fixed SSO flow for Classic Developer Portal'>
For Classic Portal cookies and Dashboard, use `SameSite = SameSiteLaxMode` so that SSO flows can be performed
</Accordion>

<Accordion title='Remove unnecessary warning output from `tyk-dashboard --version`'>
Remove the following unnecessary warning output when users use the `tyk-dashboard --version` command to check dashboard version. 
> `WARN toth/tothic: no TYK_IB_SESSION_SECRET environment variable is set. The default cookie store is not available and any calls will fail. Ignore this warning if you are using a different store.`
</Accordion>
</AccordionGroup>
  


##### Security Fixes
{/* This section should be a bullet point list that should be included when any security fixes have been made in the release, e.g. CVEs. For CVE fixes, consideration needs to be made as follows:
1. Dependency-tracked CVEs - External-tracked CVEs should be included on the release note.
2. Internal scanned CVEs - Refer to the relevant engineering and delivery policy.

For agreed CVE security fixes, provide a link to the corresponding entry on the NIST website. For example:

- Fixed the following CVEs:
    - [CVE-2022-33082](https://nvd.nist.gov/vuln/detail/CVE-2022-33082) */}


<Expandable title='High priority CVEs fixed'>
Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:
- [CVE-2023-39325](https://nvd.nist.gov/vuln/detail/CVE-2023-39325)
- [CVE-2023-45283](https://nvd.nist.gov/vuln/detail/CVE-2023-45283)
</Expandable>





---

{/*  */}




## 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](/developer-support/release-types/early-access-feature) 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](#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](/developer-support/release-notes/gateway) 

#### Downloads
- [Docker image to pull](https://hub.docker.com/layers/tykio/tyk-gateway/v5.2.5/images/sha256-c09cb03dd491e18bb84a0d9d4e71177eb1396cd5debef694f1c86962dbee10c6?context=explore)

#### Changelog
<a id="Changelog-v5.2.5" data-scroll-offset></a>

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](/developer-support/release-types/early-access-feature) 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](#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](#Changelog-v5.2.4) below.

#### Downloads
- [Docker image to pull](https://hub.docker.com/layers/tykio/tyk-dashboard/v5.2.4/images/sha256-8862e98c6ffd67d47b496275b228f4f8faae4359b9c8e42bcd8bd8a47d0c45e4?context=explore)

#### Changelog
<a id="Changelog-v5.2.4" data-scroll-offset></a>

##### Fixed


 
 <AccordionGroup>
<Accordion title='Poor experience when using the Open Policy Agent (OPA) editor'>
Fixed two UI issues with the [OPA editor](/api-management/dashboard-configuration#using-the-open-policy-agent-in-the-dashboard) in the Tyk Dashboard to improve experience when using this feature. Scrolling beyond the end of the OPA window does not now start to scroll the API Designer window, and minimizing then re-expanding the OPA editor no longer limits the text to one line.
</Accordion>

<Accordion title='Annoying bugs when setting Dashboard user access controls'>
Fixed minor issues in the Dashboard UI when configuring the user access controls for the Identity Management (TIB) and Real Time Notifications permissions.
</Accordion>

<Accordion title='Unable to select Mutual TLS version 1.3 from the API Designer dropdown'>
Fixed an issue where TLS 1.3 was not offered as an option in the "Minimum TLS version" dropdown in the API Designer. Also we gave better (human readable) names to the options, like TLS 1.0, TLS 1.1 etc. instead of their corresponding numbers 769, 770 etc.
</Accordion>

<Accordion title='Tyk Dashboard panic when using mongo-go driver'>
Fixed a situation where Tyk Dashboard could panic when using the mongo-go driver.
</Accordion>

<Accordion title='Confusing error message if user tries to modify Tyk OAS API using a Tyk Classic API endpoint'>
Improved the error message that is returned when user tries to update a Tyk OAS API using a Tyk Classic API endpoint when `allow_unsafe_oas` is not enabled.
</Accordion>
</AccordionGroup>
 


##### Added


 
 <Expandable title='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.
</Expandable>
 


---

### 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](/developer-support/release-types/early-access-feature) 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](#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](#Changelog-v5.2.3) below.

#### Downloads
- [Docker image to pull](https://hub.docker.com/layers/tykio/tyk-dashboard/v5.2.3/images/sha256-7d61ed3ee3f03ff0e2f91be71a9113b90ef6637b1cef1f30d4c3e04ead09fa6a?context=explore)

#### Changelog
<a id="Changelog-v5.2.3" data-scroll-offset></a>

##### Fixed



<AccordionGroup>
<Accordion title='Unable to resize OPA editor in Tyk Dashboard'>
Fixed an issue where the [OPA editor](/api-management/dashboard-configuration#using-the-open-policy-agent-in-the-dashboard) was not resizable. The fix ensures the floating OPA editor is now resizable and the resizing operation is smooth, improving user experience.
</Accordion>

<Accordion title='User Search not working unless you enter the full email address'>
Fixed an issue where the [User Search](/api-management/user-management#search-users) was not working unless the full email address was entered. The fix restores the functionality of showing suggestions for names as they are typed in, improving user experience and search efficiency.
</Accordion>

<Accordion title='Dashboard 4.1.0+ cannot retrieve certificates from downrev gateways'>
Fixed an issue where Dashboard 4.1.0+ was unable to retrieve certificates from a Tyk Gateway with a version lower than 4.1.0. This was due to a change made in the 4.1 versions relating to the way certificate details are retrieved in the dashboard; in the newer versions, we can view more details of the certificates. Now you can use Tyk Dashboard with any version of the Tyk Gateway and still retrieve and view certificate details; the fix ensures smooth staged upgrades and prevents potential issues for customers who have weeks or months between upgrading components.
</Accordion>

<Accordion title='Authentication Mode changes after changing API Protocol in API Designer'>
Fixed an issue in the Tyk Classic API Designer where if you changed the protocol for an API (for example from HTTP to HTTPS) then the authentication mechanism would be automatically set to Authentication Token.
</Accordion>

<Accordion title='Unable to configure external OAuth flow using Raw API editor'>
Fixed an issue in the Classic API Designer where the 'use_standard_auth' value was constantly reverting to 'true' when editing an API with an [external OAuth flow](/api-management/client-authentication#integrate-with-external-authorization-server-deprecated). This fix ensures the 'use_standard_auth' value remains consistent, enabling the use of external OAuth via the Raw API editor.
</Accordion>

<Accordion title='If the GraphQL subscription upstream disconnects, the UI is unaware of the reconnection event'>
Fixed an issue with failed GraphQL subscriptions between the upstream and the Dashboard. When an upstream subscription was disconnected and later reconnected, the UI did not update to reflect the reconnection, preventing the seamless consumption of messages. Now the Dashboard can continue consuming messages after upstream reconnects.
</Accordion>
</AccordionGroup>



---

### 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](/developer-support/release-types/early-access-feature) 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](#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](#Changelog-v5.2.2) below.

#### Downloads
- [Docker image to pull](https://hub.docker.com/layers/tykio/tyk-dashboard/v5.2.2/images/sha256-c6e701e270ebb2fed815483723375c454d0479ae41b5be2e1a6198b8d1e1a154?context=explore)

#### Changelog
<a id="Changelog-v5.2.2" data-scroll-offset></a>

##### Added



<Expandable title='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](/developer-support/release-types/early-access-feature). This is provided for early adopters and will be deprecated later, once Tyk OAS reaches full maturity.
</Expandable>



##### Fixed


<AccordionGroup>
<Accordion title='Fixed security policy grant permissions issue encountered with MongoDB'>
Fixed an issue when using MongoDB and [Tyk Security Policies](/api-management/policies#what-is-a-security-policy) where Tyk could incorrectly grant access to an API after that API had been deleted from the associated policy. This was due to the policy cleaning operation that is triggered when an API is deleted from a policy in a MongoDB installation. With this fix, the policy cleaning operation will not remove the final (deleted) API from the policy; Tyk recognizes that the API record is invalid and denies granting access rights to the key.
</Accordion>

<Accordion title='User might not correctly inherit all permissions from their user group'>
Fixed an issue in the Tyk Dashboard where a user might not correctly inherit all permissions from their user group, and could incorrectly be granted visibility of Identity Management.
</Accordion>

<Accordion title='Tyk would not store Policy ID in the API Definition for a policy that did not exist'>
Fixed an issue where Tyk would not store the *Policy Id* in the *API Definition* for a policy that did not exist. When using *JWT Authentication*, the *JWT Default Policy Id* is stored in the *API Definition*. If this policy had not been created in Tyk at the time the *API Definition* was created, Tyk Dashboard would invalidate the field in the *API Definition*. When the policy was later created, there would be no reference to it from the *API Definition*. This was a particular issue when using *Tyk Operator* to manage the creation of assets on Tyk.
</Accordion>

<Accordion title='Service Uptime page did not report the number of success hits correctly'>
Fixed an issue in the Dashboard *Service Uptime* page where the number of success hits was being incorrectly reported as the total number of hits, inclusive of failures. After this fix, the *Success Column* displays only the number of success hits.
</Accordion>

<Accordion title='High priority CVEs fixed'>
Fixed the following high priority CVEs identified in the Tyk Dashboard, providing increased protection against security vulnerabilities:

- [CVE-2022-33082](https://nvd.nist.gov/vuln/detail/CVE-2022-33082)
- [CVE-2022-28946](https://nvd.nist.gov/vuln/detail/CVE-2022-28946)
- [CVE-2021-23409](https://nvd.nist.gov/vuln/detail/CVE-2021-23409)
- [CVE-2021-23351](https://nvd.nist.gov/vuln/detail/CVE-2021-23351)
- [CVE-2023-28119](https://nvd.nist.gov/vuln/detail/CVE-2023-28119)
- [CVE-2022-21698](https://nvd.nist.gov/vuln/detail/CVE-2022-21698)
- [CVE-2020-26160](https://nvd.nist.gov/vuln/detail/CVE-2020-26160)
- [CVE-2019-19794](https://nvd.nist.gov/vuln/detail/CVE-2019-19794)
- [CVE-2010-0928](https://nvd.nist.gov/vuln/detail/CVE-2010-0928)
- [CVE-2007-6755](https://nvd.nist.gov/vuln/detail/CVE-2007-6755)
- [CVE-2018-5709](https://nvd.nist.gov/vuln/detail/CVE-2018-5709)
</Accordion>

<Accordion title='Azure SAML2.0 Identity Provider was preventing users from authenticating'>
Fixed an issue encountered with *Azure SAML2.0 Identity Provider* that was preventing users from authenticating.
</Accordion>

<Accordion title='Fields defined in Uptime_Tests.Check_List were not correctly handled in API Designer'>
Fixed an issue encountered with the *API Designer* where fields defined in *Uptime_Tests.Check_List* were not correctly handled. Uptime tests can now be configured for *Tyk Classic APIs* using the *Raw API Definition* editor.
</Accordion>

<Accordion title='Tyk Dashboard API security vulnerability'>
Fixed a security vulnerability with the Tyk Dashboard API where the `api_version` and `api_id` query parameters were potential targets for SQL injection attack.
</Accordion>
</AccordionGroup>



##### Updated



<Expandable title="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.
</Expandable>



---

### 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](/developer-support/release-types/early-access-feature) 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](#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](#Changelog-v5.2.0) below.

#### Downloads
- [Docker image to pull](https://hub.docker.com/layers/tykio/tyk-dashboard/v5.2.1/images/sha256-2f9d8af0e57f7fe4afb618dcf34772c001104dc0ec62a27541d12dc9ae90d5c8?context=explore)

#### Changelog

##### Added



<Expandable title='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.
</Expandable>



##### Fixed



<Expandable title='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.
</Expandable>



<Expandable title='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.
</Expandable>



---

### 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](/developer-support/release-types/early-access-feature) 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](#Changelog-v5.2.0) below.

Configure Caching Timeouts Per API Endpoint and Enable Advanced Caching Options From Within Dashboard

We’ve added the ability to [configure](/api-management/response-caching#configuring-the-middleware-in-the-tyk-oas-api-definition) 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](/api-management/response-caching#configuring-the-middleware-in-the-api-designer) 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](/api-management/gateway-config-tyk-oas#transformbody) middleware for both [request](/api-management/traffic-transformation/request-body) and [response](/api-management/traffic-transformation/response-body) *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](https://hub.docker.com/layers/tykio/tyk-dashboard/v5.2.0/images/sha256-28ff62e1e1208d02fec44cf84c279a5f780207ccbb7c3bdef23d1bf8fc6af3b8?context=explore)


#### API Changes

The following is a list of API changes in this release. Please visit our [Postman collection](https://www.postman.com/tyk-technologies/workspace/tyk-public-workspace/overview) for further information on our APIs.



<Expandable title='Added /system/stats endpoint to provide statistics for total and active APIs deployed'>
Added a new [endpoint](/tyk-dashboard-api), */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.
</Expandable>




#### Changelog
<a id="Changelog-v5.2.0" data-scroll-offset></a>

##### Added



<AccordionGroup>
<Accordion title='Configure request and response body transformations'>
Added support for API developers to easily [configure](/api-management/gateway-config-tyk-oas#transformbody) both request and response *Body Transformations* for more precise data management when working with *Tyk OAS* APIs. Define input data, craft transformation templates and test them against specific inputs for reliable customization.
</Accordion>

<Accordion title='Adding a new data source is simpler when working with UDG'>
Adding a new [data source](/api-management/data-graph#3-configure-datasource-details) is simpler when working with *UDG*. The default value for the *data source name* is pre-filled, saving time. The *data source name* is pre-filled in the format *fieldName_typeName*, with *typeName* being the name of any GraphQL type.
</Accordion>

<Accordion title='Added /system/stats endpoint to provide statistics for total and active APIs deployed'>
Added a new [endpoint](/tyk-dashboard-api), */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.
</Accordion>
</AccordionGroup>



##### Changed


<AccordionGroup>
<Accordion title='Saving operation is simpler when creating an API within the API Designer'>
Improved the flow when creating an API within the *API Designer* so that you remain on the same screen after saving. This means you can continue editing without having to navigate back to the screen to make subsequent changes.
</Accordion>

<Accordion title='Saving a UDG data source is simpler and quicker'>
Updated the [screen](/api-management/data-graph#connect-datasource) for configuring and saving *UDG* data sources. The *Save* button has been replaced with *Save & Update API* button and users no longer need to click *Update* at the top of the screen to persist changes. Saving a *UDG* data source is now simpler and quicker.
</Accordion>

<Accordion title='Enhanced API usage monitoring added to Dashboard'>
Updated the *Dashboard* with enhanced API usage monitoring. Users now benefit from an insightful chart on the *Licensing Statistics* page, detailing: maximum, minimum and average counts of created and active APIs. Flexible date filtering, license limit reference lines and the ability to toggle between line and bar graphs empower users to monitor usage effortlessly, ensuring license adherence.
</Accordion>

<Accordion title='New chart introduced on License Statistics page to show number of deployed Data Planes'>
A new chart has been introduced on the *License Statistics* page that presents the number of deployed *Data Planes*. This addition enables users to easily monitor their *Data Plane* usage and nearness to their contract limits.
</Accordion>
</AccordionGroup>



##### Fixed



<AccordionGroup>
<Accordion title='Advanced cache config data was absent in the Raw Editor'>
Fixed an issue where *advanced_cache_config* data was absent in the *Raw Editor*. This fix now ensures that *advanced_cache_config* can be configured. Furthermore, API modifications in the *Designer* no longer lead to data loss, safeguarding cache configuration consistency. The UI now offers a clear view of advanced cache settings, including the new *Timeout* field and *Cache* response codes fields.
</Accordion>

<Accordion title='403 errors were raised with JWT claim names containing spaces'>
Fixed an issue with *JWT claim names* containing spaces. Previously 403 errors were raised when using tokens containing such claims.
</Accordion>

<Accordion title='Popular endpoints were not displayed in Tyk Dashboard when SQL aggregated analytics was enabled'>
Fixed an issue where *popular endpoints* data was not displayed in *Tyk Dashboard* with *SQL aggregated analytics* enabled. Users can now view *popular endpoints* when viewing *Traffic Activity* per API or filtering by API with *SQL aggregated analytics* enabled.
</Accordion>

<Accordion title='Fixed security issue with expired certificates'>
Fixed a potential security vulnerability where *static* or *dynamic mTLS* requests with expired certificates could be proxied upstream.
</Accordion>

<Accordion title='Users were unable to view request analytics for a specific date in the API Activity dashboard'>
Fixed an issue in the *API Activity* dashboard where users were unable to view request analytics for a specific date. Subsequently, users can now make informed decisions based on access to this data.
</Accordion>

<Accordion title='Enforced timeout configuration parameter for an API endpoint was not validated'>
Fixed an issue where the [Enforced Timeout](/planning-for-production/ensure-high-availability/enforced-timeouts) configuration parameter of an API endpoint accepted negative values, without displaying validation errors. With this fix, users receive clear feedback and prevent unintended configurations.
</Accordion>

<Accordion title='Duplicate APIs could be created when click save button multiple times in API Designer'>
Fixed an issue in *Tyk Dashboard* where duplicate APIs could be created with the same names and listen paths if you clicked multiple times on the *save* button in the API Designer. Now, this is not possible anymore and there is no risk of creating multiple APIs with the same name.
</Accordion>

<Accordion title='Connection issues were encountered with MongoDB connection strings'>
Fixed an issue with *MongoDB* connection strings. To ensure consistent compatibility with both *mgo* and *mongo-go* drivers, users should now utilize URL-encoded values within the *MongoDB* connection string's username and password fields when they contain characters like "?", "@`". This resolves the need for different handling across *MongoDB* drivers.
</Accordion>
</AccordionGroup>



---

## 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](https://tip.golang.org/doc/go1.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](/api-management/plugins/golang#upgrading-your-tyk-gateway) 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](/developer-support/upgrading) and [how to back up tyk](/developer-support/faq#tyk-configuration)

#### Deprecation
There are no deprecations in this release.

#### Upgrade Instructions
Go to the [Upgrading Tyk](#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](/api-management/user-management#user-permissions).

##### Import API examples from within the Dashboard

In 5.0 we introduced the possibility to import API examples manually or via
[_Tyk Sync_](/api-management/automations/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](/api-management/data-graph#automatically-creating-rest-udg-configuration-based-on-oas-specification) 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](/tyk-oss-gateway/configuration#slave_options-rpc_pool_size)

#### Downloads

[docker image to pull](https://hub.docker.com/layers/tykio/tyk-dashboard/v5.1/images/sha256-8cde3c6408b9a34daa508a570539ca6cd9fcb8ee5c4790abe907eaecddc1bd9b?context=explore)


#### 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](https://github.com/TykTechnologies/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_](/api-management/automations/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](https://www.w3schools.com/django/ref_filters_slugify.php#:~:text=Definition%20and%20Usage,ASCII%20characters%20and%20hyphens%20(%2D).), 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](#upgrading-tyk). 

#### Changelog
<a id="Changelog-v5.0.15" data-scroll-offset></a>

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](/developer-support/release-notes/gateway#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



<AccordionGroup>
<Accordion title='Tyk Dashboard UI: Fixed display issue for API statistics'>
Fixed an issue where API statistics were not being shown when using PostgreSQL and adding two or more tags in the Activity page
</Accordion>

<Accordion title='Tyk Dashboard UI:  Fixed issue with display of HTTP 429 status codes on the Activity page'>
Fixed an issue where HTTP 429 status codes were not being shown on the Activity page when using PostgreSQL
</Accordion>

<Accordion title='Tyk Classic Portal UI: Fixed display of graphs and requests counter'>
Fixed wrong graphs and incorrect requests counter on Tyk Classic Portal when using PostgreSQL
</Accordion>

<Accordion title='Tyk Dashboard UI: fixed issues with the Error Breakdown display, specifically related to date handling'>
Fixed Error Breakdown issue showing errors that happened on different dates than selected date
</Accordion>
</AccordionGroup>



---

### 5.0.13 Release Notes
Please refer to our GitHub [release notes](https://github.com/TykTechnologies/tyk/releases/tag/v5.0.13)

---

### 5.0.12 Release Notes
Please refer to our GitHub [release notes](https://github.com/TykTechnologies/tyk/releases/tag/v5.0.12)

---

### 5.0.11 Release Notes
Please refer to our GitHub [release notes](https://github.com/TykTechnologies/tyk/releases/tag/v5.0.11)

---

### 5.0.10 Release Notes
Please refer to our GitHub [release notes](https://github.com/TykTechnologies/tyk/releases/tag/v5.0.10)

---

### 5.0.9 Release Notes
Please refer to our GitHub [release notes](https://github.com/TykTechnologies/tyk/releases/tag/v5.0.9)

---

### 5.0.8 Release Notes
Please refer to our GitHub [release notes](https://github.com/TykTechnologies/tyk/releases/tag/v5.0.8)

--- 

### 5.0.7 Release Notes
Please refer to our GitHub [release notes](https://github.com/TykTechnologies/tyk/releases/tag/v5.0.7).

---

### 5.0.6 Release Notes
Please refer to our GitHub [release notes](https://github.com/TykTechnologies/tyk/releases/tag/v5.0.6). 

---

### 5.0.5 Release Notes
Please refer to our GitHub [release notes](https://github.com/TykTechnologies/tyk/releases/tag/v5.0.5).

---

### 5.0.4 Release Notes
Please refer to our GitHub [release notes](https://github.com/TykTechnologies/tyk/releases/tag/v5.0.4).

---

### 5.0.3 Release Notes
Please refer to our GitHub [release notes](https://github.com/TykTechnologies/tyk/releases/tag/v5.0.3).

---

### 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](https://github.com/go-mgo/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](https://github.com/go-mgo/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](https://github.com/mongodb/mongo-go-driver): 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](https://github.com/mongodb/mongo-go-driver) GH repository.

See how to [Choose a MongoDB driver](/planning-for-production/database-settings#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](https://hub.docker.com/layers/tykio/tyk-dashboard/v5.0.2/images/sha256-fe3009c14ff9096771d10995a399a494389321707e951a3c46f944afd28d18cd?context=explore)


##### Changelog
<a id="Changelog-v5.0.2" data-scroll-offset></a>

###### 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](#Changelog-v5.0.1) below.

##### Downloads
- [docker image to pull](https://hub.docker.com/layers/tykio/tyk-dashboard/v5.0.1/images/sha256-013d971fc826507702f7226fa3f00e1c7e9d390fc0fb268bed42e410b126e89d?context=explore)

##### Changelog
<a id="Changelog-v5.0.1" data-scroll-offset></a>

###### 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](/api-management/api-versioning) 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](/api-management/traffic-transformation/mock-response), 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](https://github.com/TykTechnologies/tyk-examples): A repository containing example API definitions and policies for Tyk products. 
- via command line [using tyk-sync](/api-management/data-graph#udg-examples)

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](/api-management/graphql#graphql-apis-headers). 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](https://hub.docker.com/layers/tykio/tyk-dashboard/v5.0/images/sha256-3d736b06b023e23f406b1591f4915b3cb15a417fcb953d380eb8b4d71829f20f?tab=vulnerabilities)

#### 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](/api-management/dashboard-configuration#data-graphs-api)
- 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](/api-management/gateway-config-managing-oas#importing-an-openapi-description-to-create-an-api)

##### 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](https://hub.docker.com/r/tykio/tyk-dashboard/tags?page=1&name=4.3.0))

#### Upgrade process

Follow the [standard upgrade guide](/developer-support/upgrading), there are no breaking changes in this release.

If you want switch from MongoDB to SQL, you can [use our migration tool](/planning-for-production/database-settings#migrating-from-an-existing-mongodb-instance), but keep in mind that it does not yet support the migration of your analytics data.


<Note>
Note: Upgrading the Golang version implies that all the Golang custom plugins that you are using need to be recompiled before migrating to 4.3 version of the Gateway. Check our docs for more details [Golang Plugins](/api-management/plugins/golang).
</Note>


## 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:

```
"ui": {
  "dev": true
}
```

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):
```
type MyEntity @key(fields: "id") @key(fields: "name") {
  id: ID!
  name: String!
}
```
 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)
```
extend type MyEntity @key(fields: "id") {
  id: ID! @external
}
```

###### 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:
```
enum Example {
  A,
  B
}

extend enum Example {
  C  
}
```

Subgraph 2:
```
enum Example {
  A,
  B,
  C
}
```
 
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](/developer-support/upgrading), there are no breaking changes in this release.

If you want switch from MongoDB to SQL, you can [use our migration tool](/planning-for-production/database-settings#migrating-from-an-existing-mongodb-instance), 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](/developer-support/release-types/early-access-feature).

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](/api-management/gateway-config-tyk-oas) 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](/tyk-dashboard/configuration#http_server_options-certificates).

##### 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](/developer-support/upgrading), there are no breaking changes in this release.

If you want switch from MongoDB to SQL, you can [use our migration tool](/planning-for-production/database-settings#migrating-from-an-existing-mongodb-instance), 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](/api-management/graphql#overview-1)

[Subgraphs and Supergraphs docs](/api-management/graphql#subgraphs-and-supergraphs)

##### 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](/api-management/graphql#graphql-subscriptions)

##### 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](/planning-for-production/database-settings#postgresql), 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](/planning-for-production/database-settings#migrating-from-an-existing-mongodb-instance)

#### 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](/developer-support/upgrading), there are no breaking changes in this release.

If you want switch from MongoDB to SQL, you can [use our migration tool](/planning-for-production/database-settings#migrating-from-an-existing-mongodb-instance), 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](/tyk-developer-portal/tyk-portal-classic/dynamic-client-registration)

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](/api-management/data-graph#overview). 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](/api-management/data-graph#header-forwarding), 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](/api-management/dashboard-configuration#extend-permissions-using-open-policy-agent-opa).

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](/api-management/graphql#migrating-to-3-2).

## 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](/developer-support/release-notes/dashboard#tyk-identity-broker-now-built-in-to-the-dashboard) for more information regarding this. 

To learn more [see the documentation](/api-management/external-service-integration)

##### 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](/api-management/graphql#syncing-gql-schema)

###### 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](/api-management/graphql#graphql-playground)

##### 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](/tyk-developer-portal/tyk-portal-classic/key-requests)


#### 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](/tyk-self-managed) 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](/api-management/graphql) and [Universal Data Graph](/api-management/data-graph#overview)


##### 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](/api-management/gateway-config-managing-classic#secure-an-api) and [keys](/api-management/gateway-config-managing-classic#access-an-api)

We also have a [blog post](https://tyk.io/blog/the-transformation-of-policies-and-keys/) 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](/api-management/external-service-integration#what-is-tyk-identity-broker-tib-)


##### 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](/tyk-configuration-reference/kv-store)


##### 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](/api-management/plugins/rich-plugins#coprocess-dispatcher-hooks).


##### 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](/planning-for-production/ensure-high-availability/health-check)

##### 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](/api-management/troubleshooting-debugging#capturing-detailed-logs)

##### 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](/planning-for-production/ensure-high-availability/load-balancing#configure-load-balancing-and-weighting-via-the-dashboard)

##### 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 <Tooltip tip="A list of blocked or denied items or entries">blocklist</Tooltip> 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](/api-management/tyk-pump#tyk-pump-configuration)

##### 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](/developer-support/release-notes/archived#upgrading-from-version-2-8)


## Further Information

### Upgrading Tyk
Please refer to the [upgrading Tyk](/developer-support/upgrading) page for further guidance on the upgrade strategy.

### API Documentation
{/* Required. Update the link to the Gateway "tyk-gateway-api" or dashboard "tyk-dashboard-api" and the Postman collection

If there were changes in any of Tyk’s API docs:

- Have API endpoints been documented in the release note summary and changelog?				
- Has a link to the endpoint documentation being included?
- Has the benefit of the new/updated endpoint been explained in the release highlights and changelog? */}
- [OpenAPI Document](/tyk-dashboard-api)
- [Postman Collection](https://www.postman.com/tyk-technologies/workspace/tyk-public-workspace/overview)

### FAQ

Please visit our [Developer Support](/developer-support/community) page for further information relating to reporting bugs, upgrading Tyk, technical support and how to contribute.