Unpublishing an API from Service Registries

Edit online

You can manually unpublish APIs previously published on service registries.

Before you begin

You must have the Publish API to service registry privilege to perform the task.

About this task

Consider the following points before you unpublish an API from a service registry:

  • Individual endpoints cannot be unpublished. When you manually unpublish an API, all the endpoints in that API are unpublished from the selected service registries.
  • API publishing and unpublishing to service registries are specific to the current webMethods API Gateway instance, so APIs are unpublished only from the webMethods API Gateway instance where you unpublish. Therefore, if the same API was published from other instances of webMethods API Gateway, it remains available on the service registries from those webMethods API Gateway instances.

APIs are automatically unpublished from service registries. webMethods API Gateway automatically, but temporarily unpublishes an API in the following situations:

  • When you deactivate an API upon publishing to a service registry.
    Note: When you reactivate the API, the temporarily unpublished endpoints are published again to the original service registries.
  • Disabling or deleting an webMethods API Gateway port that has an endpoint that is published to a service registry.
Note: When you enable or add back the port again, the temporarily unpublished endpoints are published again to the original service registries.

Procedure

  1. Open the menu options and select APIs.
    A list of all APIs appears.
  2. Click the Unpublish icon for the API that you want to unpublish.
    The Unpublish API dialog box is displayed.
  3. Select Service registries in Destination.
    The list of service registries to which the API was published is displayed.
  4. Select the service registries from which you want to unpublish the API.
  5. Select Force unpublish to mark the API as unpublished in API Gateway even if the unpublish fails on the selected service registries.
    The API is unpublished from the selected service registries. The API is no longer available on selected service registries for testing and user consumption.

What to do next

After an API is unpublished, the Republish icon changes to the Publish icon.