Release Notes

Red Hat 3scale API Management 2.5

For Use with Red Hat 3scale API Management 2.5

Red Hat Customer Content Services


Release Notes for Red Hat 3scale API Management 2.5.

Part I. Red Hat 3scale API Management 2.5.1 - Patch release

Chapter 1. New features

1.1. Major features

  • Our officially-supported Command Line Interface (CLI) can now import OpenAPI Specification definitions to create or update API services (JIRA #1656).
  • When copying and updating services, you can now work with the following service configuration settings:

  • From today, you can configure remotes to manage sets of 3scale instances (JIRA #1655).

1.2. Minor features

  • Possibility to prevent showing the Openresty version number in response headers and error response bodies (JIRA #1989).
  • OpenID Connect: you can set the no_body option when authorizing against the 3scale backend (JIRA #2006).

Chapter 2. Resolved issues

  • APIcast uses different HTTPS sessions for requests on different domains (JIRA #2205).
  • Now you can configure maximum client certificate chain length (JIRA #2383).

Chapter 3. Known issues

  • You cannot import OpenAPI Specification (OAS) 2.0 with extensions (JIRA #2550) and with titles including dots (JIRA #2628).
  • When importing OAS 2.0, you cannot see the operationId description in 3scale (JIRA #2549).
  • You cannot import operationId descriptions that contain spaces (JIRA #2548).
  • Before using an imported service from OAS 2.0, you need to manually update the staging environment (JIRA #2545).
  • When you try to import a directory as OAS 2.0, Toolbox shows an error message (JIRA #2524).

Part II. Red Hat 3scale API Management 2.5 release notes

Chapter 4. New features

4.1. Major features

  • APIcast API Gateway:

    • New TLS Client Certificate Validation Policy, to allow Mutual TLS between gateway and clients (JIRA #1671).
    • New Content-based routing policy based on headers (JIRA #1411).
  • Added the feature to configure the allowed OAuth flows per API. When an API service is updated through the Admin Portal, the corresponding flows are enabled on the RH-SSO side (JIRA #774).
  • Introducing a new option to stop processing mapping rules once the first one is met (JIRA #1344).
  • The authentication settings for the API gateway now include a Basic Authentication option to allow the API Credentials to be passed in an HTTP Authorization header (JIRA #430).

4.2. Minor features

  • Now you can update extra Application Plan values (JIRA #1868).
  • Swiss Franc (CHF) and Saudi Riyal (SAR) have been included to the list of supported currencies (JIRA #1594).
  • Providers are now able to programmatically configure user access rights via API. Two new endpoints 'User Permissions Read' and 'User Permissions Update' have been added to the Account Management API (JIRA #484).
  • A new endpoint called 'Access token create' has been added to the Account Management API. Now it is possible to programmatically create an access token and to assign the scopes needed for a specific use case (JIRA #1112), as well as to search, show and delete the Access Token API endpoint (JIRA #1766).

Chapter 5. Resolved issues

  • Invoices correctly generated in POSTPAID mode when subscribing on last day of the month (JIRA #534).
  • Service deletion works consistently when a service is re-added and discovered in 3scale (JIRA #1194).
  • Successful POST requests to HTTPS API backend via forward proxy (JIRA #1781).
  • Now, the Accounts section shows results when searching by user key (JIRA #996).
  • You can configure reCAPTCHA (JIRA #1108).
  • System successfully charges invoices resulting in positive values (JIRA #1420).
  • 3scale Batcher policy works with OpendID Connect authentications mode (JIRA #1515).
  • Successful update of the APIcast configuration after upgrading to the new APIcast (JIRA #1549).
  • Policies properly displayed in 3scale when using Internet Explorer 11 (JIRA #1711).
  • Fixed link to Quickstart Guide in Developer Portal (JIRA #2078).

Chapter 6. Documentation

Chapter 7. Technology Preview features

  • Istio adapter: Introduces the ability to add API management capabilities on top of Service Mesh (JIRA #1689).
  • New 3scale operator for installing and syncing resources in 3scale (JIRA #1798):

    • Advanced options to configure your 3scale API Management solution at the time of installation.
    • Use custom resources to define 3scale tenants, APIs, plans, limits, metrics and other definitions for your 3scale installation.
  • High Availability (HA) and Evaluation (Eval) OpenShift templates (JIRA #1168).
  • The Conditional policy that only executes a policy chain if a certain condition is met. There is no user interface available for this policy; it must be configured via JSON.

Chapter 8. Known issues

  • Dashboard stream and email notifications are not filtered according to user permissions (JIRA #629).
  • Backend-listener does not reconnect to backend-redis (JIRA #608).
  • In the Active Docs section of the Developer Portal on a mobile device running with Android, you can see that the menu opens fully and then you cannot close it. You have to refresh the page to close it (JIRA #1067).
  • Redis HA via Sentinel functionality with the backend for System components is currently not supported through connections with system-redis or backend-redis (JIRA #1132).

Chapter 9. Changes in 3scale 2.5

9.1. Deprecated features

  • Compatibility with Microsoft Internet Explorer 11 (IE11) is deprecated in this release. This web browser will not be supported in future releases of 3scale.
  • Oracle Database with non-CDB architecture is deprecated in Oracle Database 12c, and this influences when using this architecture as a part of the 3scale database. Inline with Oracle’s recommendations, we advise using a CDB architecture. Non-CDB configurations may be unsupported in future releases. For more details, refer to Deprecation of Non-CDB Architecture.

9.2. Removed features

  • End User Plans feature has been removed. This feature is replaced by the ability to define rate limits for end users using the APIcast policy for edge limiting. For more details, see Edge Limiting Policy.
  • The latest transactions page is no longer available (JIRA #1767).

9.3. Changes in documentation

9.4. Future changes

  • The installation process is changing from template-based to operator-based. In this release we are introducing the new 3scale operator as a Technology Preview. In future releases, installation via the operator will be the standard mechanism for deploying the 3scale API Management solution.
  • A new registry is available for accessing product images ( This registry requires authentication to access as opposed to the old registry ( As a transition step, in 3scale 2.5 images will be published in both registries, but in 2.6 they will only be published in the authenticated registry. For more details, refer to Transitioning the Red Hat container registry and Registry Authentication.

Chapter 10. Redesign of the 3scale Documentation Library

This document describes the redesign of the 3scale Documentation Library. The primary focus of this redesign is on rearranging content to facilitate usability and navigation.

First, you will find a mapping between the base and the redesigned structures. Then, for each new documentation category, you will see an outline of the mapping from the base to the redesigned library.


  • Blue box → Category name
  • Pink box → Reused book
  • Green box → New book

10.1. General mapping

General mapping

10.2. Mapping: Release Information

Mapping: Release Information

10.3. Mapping: First Steps with 3scale

Mapping: First Steps with 3scale

10.4. Mapping: Operational Management of 3scale

Mapping: Operational Management of 3scale

10.5. Mapping: Admin Portal Guide

Mapping: Admin Portal Guide

10.6. Mapping: Developer Portal Guide

Mapping: Developer Portal Guide

10.7. Mapping: API Gateway

Mapping: API Gateway

10.8. Mapping: Reference

Mapping: Reference

Legal Notice

Copyright © 2019 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.