The following procedure describes how to unpublish a virtual API from one or more targets.
When unpublishing a virtual API, keep the following points in mind:
If you are a registered user and accessing CentraSite using the logon credentials, to unpublish a virtual API, you must have Full permission on the native API. If your user account belongs to a role that has the “Manage Assets” permission for an organization, you automatically have permission to unpublish all virtual APIs in that organization. Also, if you are the owner of an API, you can unpublish that particular API.
If you are a registered user and accessing CentraSite as a guest, to unpublish a virtual API, you must at least have the instance-level Full permission on the native API.
This action is not visible for the following conditions:
Unless you have a minimum of "Full" permission on the API.
If the API does not belong to the type "Service".
Unless the API has one or more virtual aliases already published into the Mediator.
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 |
You use this procedure to unpublish a virtual API using the native API's
action.To unpublish an API for consumption
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.
On the API detail page, click Unpublish API dialog.
. This opens theChoose 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.
Enable the checkbox next to the name of the target to unpublish the API. You can select multiple targets.
Click the
button.Or:
Else, if at any time you wish to terminate this operation, just click
the button.
An Unpublish Progress popup will display the progress state of unpublishing the API (s). Click .
If the unpublish process failed, identify and correct the error and then try unpublishing the virtual alias again.
You use this procedure to unpublish a virtual API using the API's
action.To unpublish a virtual API for consumption
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.
On the virtual API detail page, click Unpublish API dialog.
. This opens theEnable the checkbox next to the name of the target to unpublish the API. You can select multiple targets.
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.
Click the
button.Or:
Else, if at any time you wish to terminate this operation, just click
the button.
A Unpublish Progress popup will display the progress state of unpublishing your virtual API. Click .
If the unpublish process failed, identify and correct the error and then try unpublishing the virtual alias again.