Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • CREATED: API metadata is saved, but it is not visible to subscribers yet, nor deployed to the API Gateway.
  • PROTOTYPED : API is deployed as a prototype, usually for testing purpose. It is not visible in the API Store.
  • PUBLISHED: API is visible in API Store, and eventually published if the Propagate Changes to API Gateway option is selected at publishing time.
  • DEPRECATED: API is still deployed into API Gateway (available at runtime to existing users), but not visible to subscribers. An API is automatically deprecated when a new version is published.
  • RETIRED: API is unpublished from the API gateway and deleted from the store.
  • BLOCKED: Access is temporarily blocked. Runtime calls are blocked and the API is not shown in the API store anymore.

...

  1. Log in to the API Publisher (https://<HostName>:9443/store) as a user who has the publisher role assigned. See Managing Users and Roles. 
  2. Click on an API that you want to publish.
  3. The API's overview window opens. Click the Life Cycle tab, which displays the API's available states.

    Info
    iconfalse

    The Life Cycle tab is only visible to users with publisher privileges.

  4. To publish the API, select the PUBLISHED state from the drop-down list. You get three check boxes to select as follows:

    Propagate Changes to API Gateway

    Used to define an API proxy in the API Gateway runtime component, allowing the API to be exposed to the consumers via the API Gateway. If this option is left unselected, the API metadata will not change and you will have to manually configure the API Gateway according to the information published in the API Store.

    Deprecate Old Versions

    If selected, any prior versions of the API will be set to the DEPRECATED state automatically.

    Require Re-Subscription

    Invalidates current user subscriptions, forcing users to subscribe again.

  5. Select the necessary options and click the Update button to publish the API to the API Store. 

...