API Portal Legacy: Removing API Portal Artifacts from the Gateway

Products

• CA API Developer Portal
• CA API Gateway

Issue/Introduction

Any users who want to remove Portal components from their Gateways or who want to go ahead with the newer Portal 4.x series, removing the API Portal Legacy components is required.

Environment

This impacts all Portal versions 3.5 and older.

Resolution

To remove any API Portal Legacy components from the Gateway, the following steps should be followed:

1. Remove metric push cronjob
   SSH root via ssgconfig:
   - */15 * * * * /opt/SecureSpan/ApiPortal/portal.sh
    
2. Remove internal Services 
   In Policy Manager, remove:
   - API Key Management Service
   - API Portal Integration Service
    
3. Unpublish Web Services from Classic Portal
   Remove "Set as Portal Managed Service" Assertion from all Services
    
4. Remove policy folder
   - Remove API Portal Integration folder
   - Remove API Deleted from Portal folder
    
5. Remove Cluster-wide properties:
   portal.account.plan.fragment.guid
   portal.api.plan.fragment.guid
   portal.deleted.api.folderid
   portal.oauth1.fragment.guid
   portal.oauth2.encass.guid
    
6. Remove API Portal Integration Assertions:
   SSH root via ssgconfig:
   Remove the following Assertions from /opt/SecureSpan/Gateway/runtime/modules/assertions/
   - ApiPortalDataLensAssertion-9.1.00.aar
   - ApiPortalIntegrationAssertion-9.1.00.aar
    
7. Remove API Portal Integration folder and files
   SSH root via ssgconfig:
   Remove files in /opt/SecureSpan/ApiPortal
   Remove folder /opt/SecureSpan/ApiPortal
    
8. Restart Gateway Service from SSG ASCII menu:
   SSH via ssgconfig:
   In main menu:
   1. Select 2) Display Layer 7 Gateway configuration menu
   2. Select 7) Manage Layer 7 Gateway status
   3. Select 2) Restart the Layer 7 Gateway