Unpublishing Services from Gateways
You can execute a Unpublish action through the following pages:
Native Service Details page, the exact rendering of user interface depends on whether or not the Native Service has an immediate Virtual Service.
If the Native Service does not have an immediate Virtual Service, you will be allowed to directly unpublish the Native Service from an API Gateway gateway. If the Native Service has an immediate Virtual Service, you will be directed to select the Virtual Services, and unpublish the selected Virtual Services from Mediator, API Gateway, and Insight Server gateways.
Virtual Service Details page, you will be allowed to directly unpublish the Virtual Service from
Mediator,
API Gateway, and
Insight Server gateways.
Search Results page, you will be allowed to directly unpublish multiple instances of native and Virtual Services from
Mediator,
API Gateway, and
Insight Server gateways in a single step.
To unpublish a service
1. In CentraSite Business UI, access the Advanced Search panel in one of the following ways:
Click the
Browse link in the upper-left corner of the menu bar.
Click the
Search icon next to the
Scope list. The default search scope is
Assets.
This displays a list of assets in the Search Results page.
2. In the Additional Search Criteria list, select Asset Types.
3. To search for the assets of type, Service, click Choose.
4. In the Choose Asset Types dialog box, select the Assets button, and follow these steps:
a. Click the chevron next to Assets button.
b. In the list of asset types, select any of the following types: Service, REST Service, OData Service.
c. Click OK.
5. Click the Service you want to unpublish from the gateways.
This opens the Service details page. Also, the actions bar displays a set of actions that are available for working with the displayed Service.
6. On the actions bar of the Service details page, click Unpublish.
CentraSite directs you to an intermediate
Unpublish Virtual Services dialog box, if the displayed Service has a Virtual Service. A list of the defined Virtual Services that are available for unpublishing from the gateways is displayed.
CentraSite directs you to the
Unpublish from Gateway dialog box, if the displayed Service does not have an immediate Virtual Service.
7. In the Unpublish Virtual Services dialog box, select one or multiple Virtual Services you want to unpublish from the gateways, and click Next.
This opens the Unpublish from Gateway dialog box.
8. In the Gateway list, select one or multiple gateways from which you want to unpublish the Virtual Services. (The Gateway list only displays the gateways for which you have the Modify permission.)
The Gateway list includes:
If you choose... | CentraSite displays... |
API Gateway | All instances of API Gateway gateway. |
Mediator | All instances of Mediator gateway. |
All Gateways | All instances of both API Portal and Mediator gateways. |
The default is set to All Gateways.
9. Applicable for API Gateway gateways. Optional. In the Sandbox list, do the following:
a. Click the Configure icon next to the field labeled Sandbox.
This opens the API Gateway Settings dialog box.
b. Select one or multiple sandbox categories that classify the endpoint of the Services for unpublishing from API Portal gateways.
The Sandbox list includes:
If you choose... | CentraSite displays... |
Development | Instances of a specific gateway whose endpoints are classified by the Development category. |
Production | Instances of a specific gateway whose endpoints are classified by the Production category. |
Test | Instances of a specific gateway whose endpoints are classified by the Test category. |
All Sandboxes | Instances of a specific gateway whose endpoints are classified by any of the above mentioned categories. |
The default is set to All Sandboxes.
c. Click OK.
10. Applicable for Mediator gateways. Optional. Select the Revoke Consumability check box to revoke the accessibility of a Service from the Guest users.
11. Click Unpublish.
The Unpublish Inprogress popup displays the progress state of unpublishing the Service from the selected gateways.
If the unpublish process logs failures, identify, and correct the failure, and try unpublishing the Service again.
