Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

The diagram below shows the general API and backend service life cycle elements.

Image RemovedImage Added

Figure: API and backend service life cycle elements

...

  1. Log in to the API Publisher (https://<HostName>:9443/store) as a user who has the publisher role assigned. 
  2. From the All APIs window that opens, click on the API you want to publish.
  3. The API's overview window opens. Click the Life Cycles 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 DEPRECIATED 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. Note the API life cycle history visible at the bottom of the page. 

Similarly, you can depreciate, retire and block APIs. Next, see how to manage subscriptions and access tokens in Managing API Usage.