While an API is the published interface, a corresponding service running in the back-end handles its actual implementation. APIs have their own life cycle, independent from the back-end service they rely on.
The default API life cycle has the following stages:
- CREATED: API metadata is saved, but it is not visible to subscribers yet, nor deployed to the API Gateway.
- PUBLISHED: API is visible in API Store, and eventually published if the
Propagate Changes to API Gatewayoption 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.
The diagram below shows the general API and backend service life cycle elements.
Figure: API and backend service life cycle elements
API Publisher has a separate tab called Life Cycle using which you can publish APIs to the API Store, depreciate, retire and perform other operations to an API. The Life Cycle tab is only visible to and manageable by a user who is assigned the publisher role. For instructions on creating a user with the publisher role, refer to section .
Let's take a look at how to perform some common life cycle operations on an API.
Publishing an API
- Log in to the API Publisher (https://<HostName>:9443/store) as a user who has the publisher role assigned.
- From the All APIs window that opens, click on the API you want to publish.
The API's overview window opens. Click the Life Cycle tab, which displays the API's available states.
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.
Invalidates current user subscriptions, forcing users to subscribe again.
- 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 deprecate, retire and block APIs. Next, see how to manage subscriptions and access tokens in Managing API Usage.