What's new: 2023

Find out about the newest features and the latest updates in API Connect V10 Reserved.

API Connect V10 Reserved offers an individual API Connect instance that runs on an infrastructure that is managed by IBM. API Connect V10 Reserved provides a single-tenant environment at a lower cost, and with more control over your environment, than a traditional cloud-based offering.

For a list of the known limitations for API Connect V10 Reserved, see Known limitations.

2023 Q4

What's new for API Developers:

LDAP updates
  • The UI for creating an LDAP registry now provides options for specifying the scope for "Search DN" (subtree, one level, and base) as you can in the CLI.
  • You can now specify whether your LDAP is Microsoft Active Directory in the UI and with the CLI, to ensure that the directory is handled correctly in API Connect.
For more information, see Creating an LDAP user registry and Using the CLI to create an LDAP user registry.

What's new for API Product Managers:

Analytics Monitoring Data Dashboard
The Cloud Manager and API Manager analytics view have a new dashboard called Monitoring Data Dashboard. The new dashboard provides information on which applications, plans, consumer organizations, and APIs are sending and receiving the most data.

New analytics API event fields
From API Connect 10.0.5.5 and later, when using IBM® DataPower® 10.5.0.8 or later with the DataPower API Gateway, two new fields are now included in the API event records:
  • api_resource_id: String containing the resource ID for the API used by the gateway. Format is api_name:api_version:method:path.
  • gateway_service_name: The name of the gateway service, as configured in the Cloud Manager UI.
Note that these updates don't apply to the DataPower Gateway (v5 compatible).

Analytics event query_string fields are now stored as text
API event query_string fields are now stored in Analytics as text for improved indexing.

Top 20 analytics charts
New analytics charts that show the top 20 APIs, applications, and consumer organizations.

Analytics scroll API responses sorted by datetime
Calls to the analytics REST API events/scroll operation return results sorted by datetime.

Analytics charts variable length time axis
The time axis on analytics charts is sized appropriate to the available data points and selected time period.

Analytics time range options in UI
New time range options for viewing API event data in the UI:
  • Last minute of API event data.
  • Last 5 minutes of API event data.

What's new for API Consumers:

Download your APIs in JSON format
You can now download your OpenAPI documents from the Developer Portal UI in JSON format, as well as YAML format. You can select your required download option from the Overview section of the API.

What's new for Developer Portal site Administrators:

Ability to configure the analytics chart views in the Developer Portal
You can now configure which analytics charts of API data are displayed to API consumers in the Developer Portal. Previously, if access to analytics data is granted, API consumers see all of the default charts of application and organization analytics data, including API statistics, response times, and error information. Now, you can configure which charts are displayed to your API consumers, by using the Configuration > System > IBM API Developer Portal Consumer Analytics menu in the Developer Portal UI.

Updates to the Developer Portal content commands

The content command now enables you to export and import your Developer Portal site content. The following content commands are added:

  • content:create-export

    Creates a task to export a .tgz file of your site content.

  • content:create-import

    Creates a task to import an archive of your site content.

  • content:delete-export

    Cancels any currently running content:create-export tasks, and deletes any related artifacts.

  • content:delete-import

    Cancels any currently running content:create-import tasks, and deletes any related artifacts.

  • content:get-export

    Streams the content of a specific completed export task to a .tgz file.

  • content:get-export-status

    Returns the status of a specific export task.

  • content:get-import-status

    Returns the status of a specific import task.

Also, the content:list entity type flag name is changed from --content_type to --entity_type. There is no change to the content:list-types command.

For more information about the content commands and how to use them, see Using the content commands .

New Developer Portal export-entity commands
The following export-entity commands are added, which enable you to export assorted entity content from your Developer Portal site.
  • export-entity:create

    Creates a new export entity, which is the container for the entity content that you want to export.

  • export-entity:add-content

    Adds content to an existing export entity.

  • export-entity:get

    Returns a list of the content of a specific export entity.

  • export-entity:remove-content

    Removes certain content from a specific export entity.

  • export-entity:delete

    Deletes a specific export entity.

  • export-entity:launch

    Launches an export entity polling task that creates a .tgz file of all of the entities that are contained in a specific export entity. Can be run with a --no-poll option, in which case the task doesn't return a .tgz file, but just returns the task ID.

  • export-entity:get-launch-export

    Streams the content of a specific completed export-entity:launch task to a .tgz file.

  • export-entity:delete-launch-export

    Cancels a currently running export-entity:launch task, and deletes any related artifacts.

  • export-entity:get-launch-export-status

    Returns the status of a specific export-entity:launch task.

  • export-entity:list

    Returns a list of all of the export entities within a specific Developer Portal. Each export entity contains a defined list of all of the entity content that will be exported if export-entity:launch is run.

For more information about the export-entity commands and how to use them, see Using the export-entity commands.

Note that you can now also export and import entities from the Developer Portal UI. When you're editing a content entity type in the UI, you can click Export in the side navigation bar. To create an export entity container and export that entity, including any required embedded entities, click Export entity. Or, if you have an existing export entity container, you can select the required container, and click Add to the export. You can also view and manage all of your export entities by clicking Content > Content synchronizer > Exports, and all of your import entities by clicking Content > Content synchronizer > Imports.

Updates to the Developer Portal site commands

The site command now enables you to export and import the entire configuration for a Developer Portal site, including custom modules, custom themes, site configuration, and site content. The added commands mean that you can easily replicate a Developer Portal site, for example replicating a test site into a production site. The following site commands are added:

  • site:create-export

    Creates a task to export a .tgz archive file of your entire site configuration. You can then use this archive to create an identical Developer Portal site.

  • site:create-import

    Creates a task to import an archive of your entire site configuration, completely overriding the original site configuration, including content, custom modules, and custom themes.

  • site:delete-export

    Cancels any currently running site:create-export tasks, and deletes any related artifacts.

  • site:delete-import

    Cancels any currently running site:create-import tasks, and deletes any related artifacts.

  • site:get-export-status

    Returns the status of a specific export task.

  • site:get-export

    Streams the content of a specific completed export task to a .tgz file.

  • site:get-import-status

    Returns the status of a specific import task.

Important: If you want to import a site export configuration file, the export file must have been created on the same version of API Connect as the version that you want to import to.

For more information about the site commands and how to use them, see Using the site commands.

Updates to the list of blocked Drupal modules
The following Drupal modules are now unsupported and their installation is blocked in the Developer Portal:
  • All of the advanced aggregation modules; advagg, advagg_mod, advagg_js_minify, advagg_css_minify, advagg_ext_minify, advagg_validator, and advagg_bundler. These modules are blocked due to incompatibility with the current Drupal version.
  • statistics module. This module is being deprecated by Drupal.
  • tfa module. Two-factor authentication isn't available within the Developer Portal. If multi-factor authentication is required, it can be configured within an OpenID Connect (OIDC) user registry; see Creating an OIDC user registry.
For more information about custom modules, see Installing custom modules.

Ability to identify the realm parameter when logging in as a consumer to the toolkit CLI
You can now find out which realm parameter you need to use when logging in to the Developer Portal with the toolkit CLI, by running the following command:
apic identity-providers:list --server consumer_endpoint_api --mode consumer --catalog catalog_name_or_id --org <provider_org_name_or_id> --fields registry_type,realm
For more information, see Logging in as a consumer to the Developer Portal by using the CLI.

What's new for Reserved Administrators:

Migrate v5-compatible APIs to the DataPower API Gateway
If your deployment includes v5-compatible APIs, they can only be used with the DataPower v5-compatible Gateway (also known as the v5c gateway). To use the v5-compatible APIs with the DataPower API Gateway, you must migrate the APIs to the newer format. For more information, see Migrating v5-compatible APIs to API Gateway.

2023 Q3

What's new for Developer Portal site Administrators

New Developer Portal CLI product commands

The new product commands allow you to update the images, attachments, tags and categories for products on your Developer Portal. The following product commands are added:

  • product:add-attachment
  • product:set-icon
  • product:add-tag

For more information about the product commands and how to use them, see Using the product commands.

New Developer Portal CLI api commands

The new api commands allow you to update the images, attachments, tags, and categories for products on your Developer Portal. The following api commands are added:

  • api:add-attachment
  • api:set-icon
  • api:add-tag

For more information about the api commands and how to use them, see Using the api commands.

New Developer Portal CLI site command
The new site:login-link command is now available for use through the IBM API Connect toolkit CLI. By running this command, you receive a one-time login link for the Developer Portal site admin account.

For more information about the site commands and how to use them, see Using the site commands.

New flag for the modules and themes commands in Developer Portal CLI
The new --custom flag added to your modules:list and themes:list commands helps you find what modules and themes have been installed on your Developer Portal site after an install.

For more information about the --custom flag, see Using the themes commands and Using the modules commands.

New Developer Portal content commands

The new content commands allow you to list and expand your Developer Portal site content. The following content commands are added:

  • content:list-types

    Lists allowed content types on your site.

  • content:list

    Lists all the entities in your Developer Portal site for the given content type and bundle.

For more information about the content commands and how to use them, see Using the content commands .

2023 Q2

What's new for API Developers

Added APIs to manipulate attachments in a message object
The message object provides APIs and properties to manipulate message attachments. For more information, see Manipulating attachments in a message object.

Added the JSON custom scalar type for GraphQL APIs
You can use the JSON custom scalar type in GraphQL APIs to specify JSON payloads. For more information, see GraphQL custom schema directives and scalar types.

Added the ability to specify strict UTF-8 encoding for JSON documents
When you configure a Parse policy, you can specify whether to enforce strict UTF-8 encoding throughout the entire JSON document. For more information, see Parse.

Client credentials are shown in response to the apps:create command
If you're using the toolkit CLI to create consumer applications, the apic apps:create command now returns the client credentials for the application. For example, running the following command:
apic apps:create -s my_mgt_endpoint -o my_org -c my_catalog --consumer-org my_consumer-org tests/fixtures/refs/testapp.json
with the following payload:
{"title":"Jessica's Store","name":"store","redirect_endpoints":[]}
returns the following response:
store    [state: enabled]   https://example.com/api/apps/e6a4d5f1-bec0-416b-b1b7-738cc854c5b5/463d84ea-e70a-4338-beed-f3c2fe2547c0/423e0d4d-ea7c-4512-a5f6-afbd60bc3920/dab4a161-fdcd-455a-b5e7-c8447cc52105   
client_id:'12340747f8bed76c4807988603bffa1f'    client_secret: 'f123d1098ace3aa02d35d3f0da65a9f3'
For more information about how to run toolkit CLI commands, see API development and management commands.

Updates to Automated API behavior testing OpenAPI 3.0 support
You can use OpenAPI 3.0 APIs in Automated API behavior testing. For more information, see Testing an API with Automated API behavior testing.

What's new for API Product Managers:

Sender details for email notifications for consumer:app-suspended and consumer:app-reinstated are updated to be consistent with the notifications in the consumer space
The sender address details for the following two email templates are now consistent with the other email notifications:
  • consumer:app-suspended
  • consumer:app-reinstated
Previously, app-suspended and app-reinstated notifications were always sent from the Cloud level sender name and address that's configured in the Cloud Manager. However, this configuration does not follow the established pattern for notifications, as documented in Configuring sender details for email notifications.

These two templates are now sent from the sender address that's configured at the Catalog level, if provided, or the Provider Organization level, or, if neither of those sender details are provided, the Cloud Manager level, consistent with existing behavior for other templates.

Specify the fields that are returned from analytics REST API and toolkit CLI event queries.
You can specify the API event record fields that you want returned from REST API and toolkit CLI event queries. Use the --fields argument with the toolkit CLI, and the fields query parameter with the REST API, for example: 
/events?fields=bytes_received,bytes_sent

Analytics discover view in context filtering
While you're viewing the analytics API event data in the discover view, you can now quickly add and remove filters to update the event data displayed. For more information about filtering analytics UI data, see Filtering displayed data.

Analytics dashboards enhanced with new charts
Three new charts are added to the analytics dashboards.
  • Usage Dashboard: Top APIs by request size.
  • Usage Dashboard: Top APIs by response size.
  • Monitoring Latency Dashboard: Top APIs by response time.

New analytics dashboard: Gateway Operations
A new analytics dashboard is provided, which shows the API usage and latency per gateway. For more information about the analytics dashboards, see Analytics dashboards.

Ability to save and share analytics queries
You can now save and share analytics queries created in the Cloud Manager and API Manager UIs. For more information about saving and sharing queries, see API Manager UI analytics view.
Geographic IP data included in analytics API event data
The API event data now includes geographic information of the client IP address that called the API, and of the gateway itself. The geoIP feature is disabled by default.

What's new for Developer Portal site Administrators

Change to the behavior of the approval process for onboarding to the Developer Portal
The way that the approval process works for onboarding to the Developer Portal has changed. In earlier releases, if Self service onboarding approval is enabled, and a user was approved to access a Developer Portal with a specific consumer organization, that user would not need to go through the approval process again if they created more consumer organizations for the same Developer Portal.

Now, Self service onboarding approval is honored whenever a consumer organization is created. So, even if a user is approved to access a Developer Portal with one consumer organization, if they then try to create another consumer organization in the same Developer Portal, their request will still go through the approval process.

For more information, see Creating and configuring Catalogs.

Developer Portal upgrade to Drupal 10

From API Connect 10.0.5.3, the Developer Portal, which is built on the open source Drupal content management system, will be upgraded from Drupal 9 to Drupal 10. This upgrade also requires PHP 8.1. As a result, all existing Developer Portal sites will be upgraded to Drupal 10, and all new sites will be based on Drupal 10 as well. Ensure that all modules and themes used on your Developer Portal site are compatible with Drupal 10 and PHP 8.1. While core modules and themes will be automatically made compatible as part of the upgrade, any custom modules or themes, whether created in-house or contributed by the Drupal community, need to be verified for compatibility before the upgrade.

For more information about the Drupal 10 upgrade, and how to ensure compatibility, see Guidelines on upgrading your Developer Portal from Drupal 9 to Drupal 10.

Dynamic translations for API Connect entities
The latest Developer Portal upgrade contains a dynamic translations feature for the API Connect entities, including Blocks, Nodes, and Menu Links. Now, when you update the existing translations for your API Connect entities, the changes are automatically reflected across your sites without the need of re-translation. The dynamic translations feature also includes adding new language codes and their accompanying translations.

Note that the translation changes may take 5-10 minutes to appear on the site as the cache recycles.

What's new for Reserved Administrators:

Manage certificates for self-managed gateways with API Connect or IBM Cloud Secrets Manager
If you deploy a self-managed gateway, you can now manage its certificates using either the API Connect built-in certificate management tool, or IBM Cloud Secrets Manager. For information, see the section on Adding self-managed gateways.

2023 Q1

What's new for API Developers

Added the Date custom scalar type for GraphQL APIs
You can use the Date custom scalar type in GraphQL APIs to define custom scalars that specify dates. For more information, see Extensions to GraphQL.

Ability to set the API Designer locale
You can set a different locale than your current operating system for the API Designer application, by using the --lang argument when you start the application. For example, by using the --lang=es argument when you start API Designer, the language is set to Spanish. For more information, see Setting the locale for API Designer.

Ability to switch directories in API Designer
You can switch to a different directory after logging in to the API Designer application UI, by clicking Switch directory on the menu bar in the header. For more information, see Logging in from API Designer.

OpenAPI validation
You can now click Validate in the API Manager and API Designer API editors to validate your OpenAPI YAML source. If validation errors are found, you can click each error to navigate directly to the section of the API form that contains the invalid YAML. For more information, see Validating the OpenAPI YAML source.

Support for multiple OAuth2 flows in OpenAPI 3.0 APIs
If you're creating or editing OpenAPI 3.0 APIs, you can now select multiple flows (grant types) for your OAuth2 security schemes. For more information about how to create OAuth2 security schemes, see Defining OAuth2 security scheme components.

Create and manage API keys for platform APIs
Create API keys associated with your user account, and then use them to authenticate when you call the APIs provided by API Connect. For more information, see Managing API keys.

What's new for API Product Managers:

Analytics UI enhancements
The analytics UI now includes the following enhancements:
  • All analytics views can be switched between local time and Coordinated Universal Time.
  • Analytics charts can be switched between linear and logarithmic axes, selectable from the chart options menu.
  • Analytics data can be shown going back to the start of your data retention period, not just the last 30 days.
  • When you create and edit queries, the custom time range option now provides precision to the second, rather than the minute.
  • Up to 200 events per page now viewable in the discover view tables.
  • Updated columns in the discover view, providing clearer and more useful information.
  • New query fields for gateway_ip, client_ip, immediate_client_ip. Queries can use CIDR notation to search by subnet.
  • New refresh button on dashboards to update the data that is displayed, without the need to reload the browser.
  • Ability to save and load analytics queries. Saved queries are stored in the analytics backup.

Analytics CLI and REST API enhancements
New filter operators for use with the CLI and REST API: startswith, endswith, regex, notoneof. For more information, see Example toolkit CLI operations.

Additional variables for customizing the email notification templates
More variables are available to add to the email notification templates, so that you can define custom templates with more flexibility when addressing the user that's receiving the email. The following user variables are now available:
  • originator
  • originatorFirstName
  • originatorLastName
  • originatorEmail
  • username
  • email
  • firstName
  • lastName
For more information, see Configuring notifications in the API Manager.

What's new for API Consumers:

Consumer analytics redesign
The analytics dashboards in the Developer Portal are redesigned and enhanced. As well as viewing the standard analytics metrics for APIs at the application and organization level, API consumers can now view additional information, including response time, status codes, number of errors, and API call history.

What's new for Developer Portal site Administrators:

Use the toolkit CLI to enable and disable maintenance mode on your Developer Portal site
You can now enable and disable maintenance mode on your Developer Portal site, by using the Portal commands in the toolkit CLI. For more information, see How to enable and disable maintenance mode on your Developer Portal.

New drupal-state commands available in the Developer Portal command-line tool
The drupal-state commands enable you to store and retrieve information about the state of your Developer Portal system. For more information, see Using the drupal-state commands.

What's new for Reserved Administrators:

New V10 Reserved instances include DataPower V5-compatible Gateway
New instances of V10 Reserved automatically deploy with the DataPower V5-compatible Gateway in addition to the DataPower API Gateway. Existing V10 Reserved instances are not upgraded automatically to include the v5-compatible gateway; if you want to add it to your instance, contact IBM Support.