Release Notes: API Developer Portal
These Release Notes summarize the new and enhanced features, known issues, resolved issues, and compatibility matrix for Layer7 API Developer Portal version 5.0.
Release 5.0 CR 1
MySQL 8.0 Is Now Available for External Portal Databases
For the release of Portal 5.0 CR 1, MySQL 8.0 is now available for external Portal databases. To learn how you can upgrade your existing MySQL 5.7 Portal database, see Upgrade Portal Database to MySQL 8.0.
Download the Portal 5.0 CR 1 package from the API Developer Portal Solutions and Patches page.
Portal Migration Utility Now Available
[Issued November 20, 2020] As part of the installation on Docker Swarm option, the internal database for the API Portal can be created using either PostgreSQL or MySQL. With the deprecation of support for PostgreSQL, the
Layer7 Portal Migration Utilityis a tool you can use to migrate data from PostgreSQL to MySQL.
See Migrating Portal Data from PostgreSQL to MySQL to learn more.
You can also read more about the PostgreSQL support deprecation notice here.
Note for customers using API Gateway 9.2 or 10 CR1 and higher
For customers using the API Portal with the Layer7 API Gateway version 9.2 (any CR) or version 10 CR1 and higher, review the following information:
- API Gateway 9.2(any CR):There is limited compatibility support when using API Portal 5.0 with API Gateway version 9.2. Do NOT perform update of the integration bundle as part of your 5.0 upgrade. Consequently, a number of new API Portal features will not be available. We recommend upgrading your API Gateway to a later version. See Compatibility Matrix for more information.
- API Gateway 10 CR1 and higher:You MUST update the integration bundle and replace the PortalUpgradeAssertion file as part of your 5.0 upgrade. See Update the Integration Software on the API Proxy for more information.
Review the following new and enhanced features:
Portal High Availability Deployment on Kubernetes
You can now deploy Portal on Kubernetes maintaining high availability by using Helm Charts.
For more information about the strategies that you need to adopt for HA, see High Availability Portal Deployment on Kubernetes.
For information about Portal Helm Charts to deploy Portal on a Kubernetes Cluster, see GitHub.
Policy Management for Reuse
Manage Policies with Gateway Bundles
Policy authors can create policy bundles in the Gateway Policy Plugin and incorporate them into the CI/CD pipeline for easier upgrades and migrations. As Portal Admin, you can import Gateway bundles into the API Portal and deploy them to the proxies managed in API Portal.
For bundles that are of encapsulated assertion type, these bundles are made available as policy templates for reuse during API publishing. Newer build revisions of these encapsulated assertion type bundles can be uploaded to the Portal for deployment to proxies so that existing APIs leveraging the bundle’s policy template can automatically leverage the updated policy.
For more information on creating Gateway bundles, see the Gateway Policy Plugin documentation.
API Key Management and Deployment
Manage Multiple API Keys
You can now create, read, update, and delete multiple API keys for your applications. Upon upgrading, the existing API key for an application becomes its default key.
For more information about when you would want to create and manage multiple API keys in applications, see Manage API Keys.
Manage Key Deployment Type for Proxies
You can now manage how you want API keys to be deployed for all proxies registered with API Portal. This can be on-demand or automatic. You can also continue to manage the key deployment type for proxies by making calls to the PAPI.
For more information, see Manage Proxies.
Deploy API Keys to Proxies using API Portal
You can now manage API key deployments to proxies using API Portal. You can also continue to manage application deployments to proxies by making calls to the Portal API (PAPI).
For more information, see Manage API Key Deployments to Proxies.
API Program Content Customization
Introducing API Hub, a React-admin-based implementation for the Developer Console of Layer7 API Developer Portal (API Portal).
The standard API Hub is a reference implementation that includes localization support and is included with API Portal. This reference implementation includes core pages for searching and discovering of APIs and Applications targeting organization-based users.
You can use the standard API Hub, or provide a customized API consumer-facing user experience of API Portal by hosting, customizing and extending it. You can extend by adding custom pages, by adding branding/theme changes, and by adding other supported languages.
Org Admins can use API Hub to create applications, while Portal Administrators, API Owners, and Org Publishers can use the standard API Hub to manage wiki documents and other custom content for their API program.
In this release, Applications in API Hub only show the default API key.
For more information, see API Hub.
For more information about how to customize API Hub, see the CA APIM GitHub.
New Portal API Documents Resource
The Portal API (PAPI) now includes the Documents resource. You can manage API documents and additional custom content in API Hub using this resource.
For more information about these endpoints, see Portal API (PAPI).
Enhanced User Experience
New API Portal Dashboard and Menu Bar
The new and enhanced API Portal Dashboard provides a quick overview of the current state of your API Portal. Upon logging in to API Portal, you see a personalized view of menu options, entities and analytics depending on your role or customization.
For more information, see API Portal Dashboard.
Global Theme and Page Appearance Updates
In conjunction with the new API Portal look and feel, your theme and page appearance experience has been upgraded.
The following properties have been added to themes:
- Color: UI Background color, API Hub primary color, API Hub secondary color
- Typography: API Hub font
- Font size: Title, Section title, Small title, Label, Small label
The following properties are no longer supported:
- Navigation label
- Header and footer
- Background image
Upon upgrade, your global theme will include a number of new properties from the default theme. Additionally, the default values for some existing properties have been changed. Changes are automatically applied; validate your settings for any impact on your existing global theme and appearance.
For more information, see Customize Page Appearance.
New Add/Edit API Wizard
The Add/Edit API wizard has been enhanced for a more unified end-to-end API management. Publishers can now manage these configurations from the Add/Edit API wizard:
- API Details, including API definition and proxy configuration
- Custom Fields (if enabled)
- Policy Templates
- Spec Authentication (REST API only)
- Management Permissions
- Visibility Permissions
- API Tags
- API Publish State (previously part of API Details)
- Some configurations, such as Proxy Configuration and Spec Authentication, are not applicable to Gateway-published APIs.
- As a result of these enhancements, your old bookmarks might not work.
For more information, see Manage APIs.
Cross-organizational Analytics for Org Publisher
To understand the consumption of APIs across organizations, the analytics reports have been expanded to allow Org Publishers to access metrics and visualize the data for all the APIs and applications owned by their organization as well as applications of other organizations using their APIs. As such, Org Publishers can now filter data by organization and proxies.
For more information, see Monitor.
Filter API Hits by API Keys
You can now filter and group API hits by API key using the new API Key dimensional filter in a custom report.
For more information:
Portal Services Enhancement
Default SSL Database Connection
By default, all database connections from API Portal are now using SSL encryption provided the database server supports them. Enabling SSL encryption increases the security of data transmitted between API Portal and the database.
If you have configured an external database server and disabled SSL, this change does not impact your current configuration.
News and Announcements
Installation Migration from Bintray to Docker Hub
The original Docker registry (Bintray) hosting API Portal images is sunsetting. All Portal images are now migrated to Docker Hub, and installations will run from Docker Hub with no change to scripts. While this change is transparent for most use cases, note that the image URI has changed from
docker.io/caapim. This affects offline package’s configuration and also any custom scripts/operations you may have against the downloaded images.
For more information on package installations, see Install and Configure API Portal.
API Portal customers no longer require separate licenses for using the API Gateway, PSSG, and Ingress containers. This licensing update is part of the direction to eliminate product-level licensing within Layer7, and eases customer adoption of solutions across the Layer7 API Management offering.
If you have previously configured your Layer7 API Management products and components with separate licenses, this change will bypass your previous setup and the new unified license included in API Portal will be used during upgrade.
Broadcom Telemetry Update
Broadcom is moving away from telemetry provider Segment and now uses proprietary technology to gather and leverage your telemetry data of subscription usage and system configuration in a secure and anonymous way. The telemetry data is sent to Broadcom telemetry at
For more information, see Configure Telemetry.
Updates to Portal.svc Resource
Customization for Sign Up and Account Setup pages are made by making calls to Portal.svc endpoints for payload delivery, query, and validation.
The following changes have been made:
- /admin/Portal.svc/Registrations endpoint now validates the unique organization when a new user signs up for an account.
- /admin/Portal.svc/accountSetup endpoint now validates the unique username when a new user completes the account setup.
The following endpoints no longer need to be explicitly called have been deprecated:
Imminent Deprecation of API Explorer
The API Explorer application will be deprecated in a future release. You will be able to access Portal’s native APIs (including PAPI, Portal Metrics API, Login API, and Authorization API) as individual APIs from the menu bar. This will also give you the ability to view and test the APIs using the Swagger UI.
Imminent Deprecation of Custom Pages and Custom Pages Resource
With the launch of API Hub as the one-stop, customizable platform serving your API consumers and developers, no further enhancements will be made to Custom Pages.
You can still view and use the full function of Custom Pages and the Custom Pages API in this release. However, note that the ability to customize core pages and upload them as bundles to API Portal will be disabled as of next release, and will be deprecated entirely in the release following.
For more information on Custom Pages, see Customize Core Pages.