Table of Contents

Search

  1. Preface
  2. Introduction to API Manager
  3. API management
  4. Organizational access policies
  5. API-specific policies
  6. API groups
  7. Authentication and authorization
  8. API Microgateway Service
  9. Analytics

API Manager Guide

API Manager Guide

Version management

Version management

You can create multiple versions of a managed API or custom API, choose the default version, and delete a version.
When you create a version of an API, API Manager creates an additional API with the same name. Each version appears as a separate entry on the
API Registry
page.
Default
appears next to the entry of the default version on the
API Registry
page.
If a version of an API is not the default version,
API Manager
adds the version to the API URL of the API.
API Manager
doesn't add the version to the API URL of the default version.
API consumers can invoke all versions of an API with a URL that contains the version, including the default version. A URL that doesn't contain the version always invokes the default version.
In the API details window, the API URL of the default version doesn't include the version. If you choose a different version as the default version,
API Manager
adds the version to the API URL of the previously default version, and removes the version from the API URL of the current default version. Be sure to notify API consumers of the changes in API URLs.
When you create a new version of an API, you can choose whether or not
API Manager
applies the policies of the API version that the new version is based on to the new version. Policies include authentication method and API-specific policies. If you choose not to copy the policies from the original version, configure policies for the new version.
When you copy a policy of a managed API where token authentication is enabled, the tokens that the original version uses don't apply to the new version. Perform one of the following actions:
  • If the original version uses OAuth 2.0 authentication, add the new version of the managed API to the OAuth 2.0 client and re-generate the token.
  • If the original version uses JSON Web Token (JWT) authentication, create JWT tokens for the new version.
If an API has multiple versions, you can delete any version of the API other than the default version. To delete the default version of the API, choose a different version as the default version.

0 COMMENTS

We’d like to hear from you!