Update Portal Integration

The Update Portal Integration task updates the API Portal integration on a gateway. This task only needs to be run when the API Portal Administrator receives notification that an upgrade is available.
gateway91
The
Update Portal Integration
task updates the API Portal integration on a
CA API Gateway
. This task only needs to be run when the API Portal Administrator receives notification that an upgrade is available.
To access this task: Tasks > Extensions and Add-Ons > Update Portal Integration
This task works only if your Gateway is serving as a tenant Gateway for a CA API Developer Portal.
Prerequisites
The following prerequisite applies only if the current tenant Gateway is version 9.0. Skip if the tenant Gateway is version 9.1.
  • Ensure the old Portal integration file is removed from the Gateway. To do this, run the following commands in a privileged shell on the Gateway:
    # service ssg stop # rm /opt/SecureSpan/Gateway/runtime/modules/assertions/ApiPortalIntegrationAssertion-9.0.00.aar # service ssg start
Properties
There are no properties for this task: the upgrade occurs in the background. You are notified if the upgrade was successful, failed, or was not necessary.
Frequently Asked Questions
Question
Answer
What happens if I don't upgrade when notified?
The Portal integration continues to work, but you should upgrade at your earliest convenience. The upgrade enhances the internal Portal integration code and updates Portal-related resources and entities.
Does this also upgrade my tenant Gateway?
No. This upgrades only the API Portal integration capability. To upgrade the Gateway itself, see Upgrade the Gateway.
How will I know an upgrade is required?
The system will notify the API Portal Administrator when an upgrade is required.
What happens if I did not remove the old .aar file first?
The upgrade may not complete properly. Remove the .aar file and restart the Gateway ("service ssg restart").
Note that an old .aar file exists only if you've been running the Portal integration since v9.0. It does not exist if you started the Portal integration in v9.1.