Version 9.5 SP1
 —  Virtualizing APIs Using the CentraSite Business UI  —

Unpublishing an API

The following procedure describes how to unpublish a virtual API from one or more targets.


General

When unpublishing a virtual API, keep the following points in mind:

Top of page

Ways in Which You Can Unpublish an API

You can unpublish the virtual APIs from one or more targets in either of the following ways:

If you want to unpublish using the... Follow the steps described in...
Native API's Unpublish action Unpublishing an API from Native API's Action Menu
Virtual API's Unpublish action Unpublishing an API from Virtual API's Action Menu

Top of page

Unpublishing an API from Native API's Action Menu

You use this procedure to unpublish a virtual API using the native API's Unpublish action.

Start of instruction setTo unpublish an API for consumption

  1. In CentraSite Business UI, display the details page of the API whose virtual alias you want to unpublish from the target(s). For procedures, see the section Viewing Details of an API.

  2. On the API detail page, click Unpublish. This opens the Unpublish API dialog.

  3. Choose the alias you want to unpublish from the drop-down labeled Virtual Alias. (The list will contain the virtual aliases that are defined for the native API.) You can select multiple targets.

  4. Enable the checkbox next to the name of the target to unpublish the API. You can select multiple targets.

  5. Click the Unpublish button.

    Or:
    Else, if at any time you wish to terminate this operation, just click the Cancel button.

  6. An Unpublish Progress popup will display the progress state of unpublishing the API (s). Click Ok.

    If the unpublish process failed, identify and correct the error and then try unpublishing the virtual alias again.

Top of page

Unpublishing an API from Virtual API's Action Menu

You use this procedure to unpublish a virtual API using the API's Unpublish action.

Start of instruction setTo unpublish a virtual API for consumption

  1. In CentraSite Business UI, display the details page of the virtual API you want to unpublish. For procedures, see the section Viewing the Details of a Virtual API.

  2. On the virtual API detail page, click Unpublish. This opens the Unpublish API dialog.

  3. Enable the checkbox next to the name of the target to unpublish the API. You can select multiple targets.

  4. Enable the Expose to Consumers checkbox to allow unauthorized consumers (guests) to search and access the virtual API.

    The Expose to Consumers checkbox is visible only to those users who have "Full" permission on this API.

  5. Click the Unpublish button.

    Or:
    Else, if at any time you wish to terminate this operation, just click the Cancel button.

  6. A Unpublish Progress popup will display the progress state of unpublishing your virtual API. Click Ok.

    If the unpublish process failed, identify and correct the error and then try unpublishing the virtual alias again.

Top of page