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 and
API Portal gateway within any organization in
CentraSite.
Organization Administrator: instances of
API Gateway and
API Portal gateway 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.
In addition to the above, you can unregister a gateway if you have the Full instance-level permission on the gateway itself.
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. If you do not see the Unpublish action in the Gateway Details page, it is probably because you do not have the required role to unregister a gateway from CentraSite.
Important: | This functionality is not applicable to Mediator and Insight Server gateways. |
When you unregister a gateway, for example API Portal, 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.
If you encounter a problem when unregistering API Portal gateway, CentraSite displays a dialog box describing the problem. When a fault is returned by the API Portal server, CentraSite unregisters the API Portal gateway regardless of the exception, provided the Force Unpublish button is selected by the user. If the reason for the failure is CentraSite server, then the CentraSite Administrator or API Portal Administrator should take corrective action.
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 or API Portal 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 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 Gateways and API Portal gateways.
3. In the displayed list, select the gateways you want to unregister from CentraSite.
If you have selected multiple gateways where one or more of them are already unregistered from CentraSite, CentraSite initiates the unregistration mechanism on that set of gateways, and ignores the already unregistered gateways.
You can also unregister a single gateway from the Gateway Details page.
4. On the actions bar of the Search Results page, click Unpublish.
5. In the Unpublish <Gateway> dialog box, click Unpublish.
6. If you encounter a problem during the unregistration, try selecting the Force Unpublish button, and then click Unpublish.
