Unregistering Gateways from CentraSite
To unregister a gateway from CentraSite, you must have the following roles:
CentraSite Administrator: to unregister
API Portal,
Mediator, or
Insight gateways within any organization.
Organization Administrator: to unregister
API Portal,
Mediator, or
Insight gateways within a specific organization.
API Portal Administrator role to unregister
API Portal gateways.
Mediator Administrator role to unregister
Mediator gateways.
In addition to the above, you can register an API Portal, Mediator, or Insight gateway if you have the instance level Full permission on the particular gateway.
Unregistering an API Portal, Mediator, or Insight causes CentraSite to suppress interactions with the particular gateway.
You usually unregister a gateway, as an example, API Portal gateway 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 can unregister an API Portal gateway, for example, from CentraSite using the Unpublish action in the API Portal Gateway Details page. If you do not see the Unpublish action in the API Portal Gateway Detailspage, it is probably because you not have the required role to unregister an API Portal gateway.
To unregister an API Portal, you must have the CentraSite Administrator or API Portal Administrator role. If your user account belongs to API Portal Administrator organization-level role, you automatically have permission to unregister all of the API Portals in that organization. If your user account belongs to the CentraSite Administrator role, you have permission to unregister any API Portal in the CentraSite registry.
When you unregister an API Portal, CentraSite executes the following operations:
1. Removes any relationship between the APIs (which are already published to the 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. Deletes the onboarded users specific to API Portal from the CentraSite registry.
3. Deletes access tokens of the deleted API Portal users from the Mediator and CentraSite registry.
If at the time of unregistration, the Mediator gateway is unavailable, the access tokens of the deleted API Portal users are marked as revoked. When the API is republished to Mediator at a later time, CentraSite sends a list of valid access tokens to Mediator. Then the Mediator removes the access tokens that were associated with the deleted users.
If you encounter a problem when unregistering an API Portal, CentraSite displays a dialogue box describing the problem.
When a fault is returned by the
API Portal server,
CentraSite ignores the exception and unregisters the
API Portal, provided the
Force Unpublish button is selected by the user.
However, if the reason for the failure is
CentraSite server, then the
CentraSite Administrator or
API Portal Administrator should take corrective action.
If you need to modify the details of an API Portal that is already unregistered from CentraSite, you must modify it in CentraSite and then republish it with CentraSite. If you make changes to the endpoint of an API Portal, for example, you must update the details page of the API Portal with the new API Portal's configuration, republish the API Portal with CentraSite to put those changes into effect.
To unregister a gateway
1. In the CentraSite Business UI activity bar, click Manage Governance Rules.
2. To filter the list to see a list of the available API Portal, Mediator, or Insight 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. Choose API Portal, Mediator, or Insight from the drop-down list.
c. Click the plus button next to the drop-down box or press Enter to add the scope API Portal, Mediator, or Insight to the search recipe.
CentraSite displays the list of API Portal, Mediator, or Insight gateways that are available to you.
3. In the displayed list, select the gateway you want to unregister from CentraSite.
This opens the Gateway Details page. Also, the actions bar displays a set of actions that are available for working with the displayed gateway.
4. On the actions bar of the Gateway Details page, click Unpublish.
5. In the Unpublish <Gateway> dialog box, click Unpublish.
You can also choose to unregister multiple gateways in a single step through the Search Results page.
If you have selected multiple API Portal gateways where one or more of them are unregistered from CentraSite, CentraSite initiates the unregistration mechanism on that set of API Portal gateways, and ignores the already unregistered API Portal gateways. Also remember that only API Portal gateways for which you have the required permission are unregistered.
6. If you encounter a problem during the unregistration, try selecting the Force Unpublish button, and then click Unpublish.
