Unregistering Gateways from CentraSite
Pre-requisites:
To unregister gateways from CentraSite, you must have one of the following roles:
CentraSite Administrator: instances of
API Gateway,
API Portal, and
Mediator gateways within any organization in
CentraSite.
Organization Administrator: instances of
API Gateway,
API Portal, and
Mediator gateways in the specific organization to which your Manage Organizations permission applies.
API Gateway Administrator: instances of
API Gateway in the specific organization to which your
API Gateway Administrator role applies.
API Portal Administrator: instances of
API Portal gateway in the specific organization to which your
API Portal Administrator role applies.
Mediator Administrator: instances of
Mediator gateway in the specific organization to which your
Mediator Administrator role applies.
In addition to the above, you can unregister a gateway if you have the Full instance-level permission on the gateway itself.
Note:
This functionality is not applicable to Insight Server gateways.
Unregistering a gateway causes CentraSite to suppress interactions with the particular gateway.
You usually unregister a gateway, for example API Portal, as a fallback option for the following reasons:
The
API Portal server is irreversibly down, for example, the machine hosting the
API Portal has crashed, or is inaccessible.
An internal or application error on the
CentraSite or
API Portal server.
To edit an
API Portal (for example, to modify the hostname of an
API Portal).
To suspend publishing of APIs and handling requests (new, renew, revoke) of access tokens for the
API Portal registry (temporarily or permanent).
You unregister a gateway from CentraSite using the Unpublish action in the Gateway Details page. The Unpublish action is NOT visible in the Gateway Details page for the following conditions:
If the required role to unregister the particular gateway is not met.
If the
Mediator gateway does not have any API published to it.
When you unregister, for example, an API Portal gateway, CentraSite executes the following operations:
1. Removes any relationship between the APIs (which are already published to API Portal) and the API Portal object in the repository (that is, CentraSite removes any existing association between the API Portal registry and the APIs published to it.
2. Unpublishes all APIs that were published to the API Portal gateway.
3. Deletes onboarded users specific to the API Portal gateway from CentraSite registry.
4. Deletes access tokens of the non-existing API Portal users from the API Gateway or Mediator gateway and the CentraSite registry.
If at the time of unregistration, Mediator gateway is unavailable, the access tokens of the non-existing API Portal users are marked as revoked. At a later time, when the API is republished to Mediator, CentraSite sends a list of valid access tokens to Mediator. Then, the Mediator removes the access tokens that are associated with the non-existing users.
To unregister gateways
1. In the CentraSite Business UI activity bar, click Governance Rules.
2. To filter the list to display the available API Gateway, API Portal, and Mediator gateways, do the following:
a. Go to the advanced search panel.
b. In the Narrow Your Results section, do the following:
a. Locate Applicable Scopes.
b. Select the required type of gateway asset from the drop-down list:
API Gateway API Portal Mediator c. Click the plus button next to the drop-down box or press Enter to add the scope to the search recipe.
CentraSite displays the list of available API Gateway, API Portal, and Mediator gateways.
3. In the displayed list, select the gateway instances you want to unregister from CentraSite.
If you have selected multiple instances where one or more of them are already unregistered from CentraSite, CentraSite initiates the unregistration mechanism on the selected gateway instances, and ignores the already unregistered instances.
You can also unregister a single gateway instance from its page.
4. On the actions bar of the Search Results page, click Unpublish.
5. In the Unpublish dialog box, click Unpublish.
If you encounter a problem when unregistering gateways, possibly because the machine hosting any gateway instance is inaccessible, CentraSite displays a dialog box describing the problem.
6. Select the Force Unpublish check box to unregister the gateway instances forcefully, and then click Unpublish.
When this option is selected, CentraSite ignores any failures even if the gateway instance is inaccessible, and clears all data from the CentraSite database.