Manage Proxies

As a Portal Admin, you can manage proxies. Proxies represent specific environments and define the backend Gateways. Gateways process incoming requests from physical APIs and applications using the proxies.
In this article:
About Enhanced Synchronization
Beginning with the release of version 5.0.2 of the API Portal, API and API key deployment synchronization between the Portal and On-Premise proxies has been enhanced for improved reliability and scalability. This enhancement has also allowed the API Portal to capture and present richer data in the Proxy Details page for analysis and troubleshooting. To ensure that your Portal and proxy integration is taking full advantage of this enhanced synchronization, the following items and actions should be considered:
Modifying an existing proxy's configuration from On-Demand to Automatic synchronization ensures that the proxy will adopt the enhanced synchronization method. New proxy enrolments with Automatic synchronization will always adopt the enhanced synchronization method.
Add an API Proxy
Portal Admins typically add On-Premise proxies while setting up
API Portal
and add SaaS proxies after installing
API Portal
, when enrolling a Layer7 API Gateway.
Follow these steps:
  1. Log in to
    API Portal
    as a Portal Admin.
  2. From the menu bar, select
    Manage, Proxies
    .
    A list of API proxies display on the API Proxy page.
  3. Select
    Add Proxy
    .
    The Details page appears.
  4. Complete the following fields, and then select
    Save & Next
    :
    • Proxy Name:
      Defines the unique name for your proxy.
    • API Deployment Type:
      Control how
      API Portal
      deploys newly Portal-published APIs to this proxy by selecting the API deployment type.
      API Portal
      automatically deploys the changes that you make to existing APIs to the proxies regardless of the deployment type.
      Options:
      • Automatic:
        Choose this type when you want
        API Portal
        to automatically deploy the API to all proxies as soon as you publish the API.
      • On Demand:
        Choose this type when you want the Portal Admin to manage API deployments to proxies as needed.
      • Scripted:
        Choose this type when you want to use existing Continuous Integration/ Continuous Development (CI/CD) processes and script the deployment to automate API deployment. Include calls to the
        ApiDeployments
        resource for the Portal API (PAPI) in your deployment script.
      Default:
      Automatic
      For more information about how to deploy APIs to proxies, see Manage API Deployments.
    • Key Deployment Type:
      Control how
      API Portal
      deploys newly-added API keys to this proxy by selecting the key deployment type.
      API Portal
      automatically deploys the changes that you make to existing API keys to all proxies regardless of the deployment type.
      Options:
      • Automatic:
        Choose this type when you want
        API Portal
        to automatically deploy API keys to all proxies as soon as you add the API key to the application.
      • On Demand:
        Choose this type when you want the Portal Admin or Org User with deployment permissions to manage API key deployments to proxies as needed.
      Default:
      Automatic
      For more information about how to deploy API keys to proxies, see Manage API Key Deployments to Proxies.
      You can also manage the key deployment type for proxies by making calls to the
      Proxies
      resource for the PAPI.
      For more information about the PAPI, see Portal API (PAPI).
  5. On the
    Organization Assignment
    tab, under
    Organizations
    , select or clear the checkboxes for the organizations that you want to assign to or un-assign from the proxy, and then click
    Save
    .
    After you assign an organization to a proxy, a Publisher within the organization can deploy an API they own or manage to that proxy.
    You can also assign organizations to a proxy using the
    Proxies
    resource for the PAPI. However, you can un-assign organizations from the proxy only using
    API Portal
    .
Edit an API Proxy
You can edit an API proxy, for instance:
  • To change the name of the proxy. For example, to give it another name or to correct a spelling mistake.
  • To edit the API or key deployment type.
  • To assign or un-assign an organization to or from the proxy.
Follow these steps:
  1. Select
    Proxies
    from the Manage menu.
  2. On the API Proxy page, select
    Edit
    next to the API proxy that you want to edit.
    The
    Details
    tab opens.
  3. Edit the proxy name, the API deployment type, and the key deployment type, and then select
    Save & Next
    .
    The
    Organization Assignment
    tab opens.
  4. In the
    Organizations
    section, assign organizations to the proxy. Select or clear the checkboxes for the organizations that you want to assign to or un-assign from the proxy, and then select
    Save
    .
    You can also assign organizations to the proxy using the PAPI. To un-assign an organization from the proxy, use
    API Portal
    .
    For more information, see Manage Organization Assignments to Proxies using the PAPI.
If you are upgrading from
API Portal
version 4.4 or earlier, by default organizations are not assigned to your proxies. After upgrading, ensure that the Portal Admin performs the necessary organizations assignment.
View Proxy Details
The Proxy Details page shows Portal administrators how API Gateways are currently enrolled and configured to work with the API Portal and serves as a dashboard for Portal administrators who want to quickly understand the status of their proxies and effectively gain insights from all deployment activities managed by the API Portal. Proxy Details are broken down into three distinct tabs, each providing a unique view of your proxy deployment:
  • Overview
  • API Deployment
  • API Key Deployments
Overview Tab
The following describes the Overview tab in four main areas A,B, C and D:
A - Header: Proxy Name, Connection Status, and Navigation Tabs
Proxy Name and Connection Status
In the heading area of the page, you can quickly identify the API proxy by its name at the top-left corner, followed by the connection status of the proxy which indicates whether it’s connected to the Portal (green) or disconnected from the Portal (red).
A connected status indicates that the Portal is able to send messages and synchronize with the proxy for API and key deployment. If a disconnected status is shown, contact your API Gateway administrator to investigate the connectivity issue.
The connection status does not appear unless the latest Portal Integration bundle is installed (see 'Portal Compatibility' under 'B - Basic Proxy Details'). Install the latest bundle to ensure you can view all the available data in the Proxy Details page.
Navigation Tabs
As required, you may navigate away from the Overview tab to view details for the API Deployments or API Key Deployments associated with the proxy by clicking their respective tabs.
Action Menu
Use the drop-down menu to edit or delete the proxy.
B - Proxy Basic Details
The first row of tiles display the following information about the proxy and its components:
  • The API proxy URL
  • The version of the OAuth Toolkit solution
  • The version of the connected API Gateway
  • Portal Compatibility: Lets you quickly determine if your proxy has the latest Portal Integration Bundle installed
    Up to Date
    The API Proxy is compatible with the currently installed version of the API Portal, provided the latest Portal Integration Bundle is installed on the proxy after a Portal upgrade.
    Update Required
    The installed Portal Integration Bundle is outdated and requires updating in order for you to optimize API and API Key deployments and continue using all of the Portal's available features. To learn how to update the Portal Integration Bundle, see Integrate On-Premise API Proxies.
C - Primary Deployment Information Tiles
The second row of information tiles display information about API management assets that are maintained from the Portal for the proxy, including APIs and API Key Deployments. Each of the two tiles show respective groupings (subtotals) of API and API Key counts by the following deployment statuses:
  • Published (White)
  • Pending (Light Gray)
  • Not Deployed (Dark Gray)
  • Deployed (Green)
  • Error (Red)
Within the APIs tile, APIs are also grouped by their publishing source, and are either Portal-published or Gateway-published. Each tile also indicates the Deployment Type (Automatic or On-Demand) and the time and date of when the presented information was last updated on the screen.
Stacked Horizontal Bar
As a visual aid, a stacked horizontal bar graph appears at the top of each tile, letting you quickly compare API or API key deployment statuses by color segmentation. In the example below, we can see that the majority of APIs are deployed (green) to the proxy.
Troubleshoot Deployments
When reviewing the Overview tab of the Proxy Details, seeing an API or API Key with an ‘Error’ status may signify a synchronization issue. Typically, this means that changes made to an API or Application have not been deployed to the proxy.
You may also click an API or API key count to drill into the finer details for those APIs or API keys in the API Deployments OR API Key Deployment tabs. In the example below, we’re curious to see which two Portal-published APIs have the ‘Error’ status and determine what the next steps are to deploy them. Clicking the URL leads us to the API Deployments tab that can offer this insight (see the API Deployments Tab section on this page).
D - Secondary Proxy Information Tiles: Account and API Plans and Organizations
The secondary proxy information tiles provide the following information:
  • The Account Plans tile displays information about the account plans:
    • Portal displays the total number of account plans in API Portal.
    • Proxy displays the total number of account plans that API Portal has synchronized to this proxy.
  • The API Plans tile displays information about the API plans:
    • Portal displays the total number of API plans in API Portal.
    • Proxy displays the total number of API plans that API Portal has synchronized to this proxy.
    • If API plans are disabled, then the message API Plans are currently disabled appears.
  • The Organizations tile displays the total number of organizations that are assigned to this proxy.
API Deployments Tab
The API Deployments tab lists all the APIs that are marked for deployment to the proxy. Each API is uniquely identified by its name, and given the following attributes organized in columns from left to right:
  • State: Unpublished, Enabled, Disabled, Deprecated or Deleted - see Manage API Lifecycles and States Publish
  • Source: Where the API was published from, either from the Portal or Gateway
  • Last Deployed: The date and time the API was last deployed to the proxy Deployment
  • Status: Deployed, Pending Deployment, Pending Undeployment, Error Undeploy, Error
To find out more about an API (e.g., its public description, documentation, location, etc.), you can drill into the individual APIs by clicking their linked names in the API Name column.
For any APIs with an Error status, click the error link to view the message describing the cause of the error.
Filtering and Sorting
You may apply a combination of any number of filters to view a select list of API deployments that interest you with the following drop-down filters at the top of the API list:
  • State (Default is All States)
  • Publish Sources (Default is All Publish Sources)
  • Deployment Status (Default is Any Deployment Status)
You may sort your list by a last-deployed time-line of either ‘New to Old’ or ‘Old to New’.
API Key Deployments Tab
Structured similarly to the API Deployments tab, the API Key Deployments tab lists all the API keys that are available to applications associated with the proxy. Each API key is uniquely identified by its unique Key Name, and given the following attributes organized in columns from left to right:
  • API Key: The unique identifier code used to authenticate a client attempting to connect to an API Key
  • Status: Enabled or disabled
  • Key Deployment Status: Deployed, Pending Deployment, Pending Undeployment, Error Undeploy, Error
  • API Keystore: The number of API keys that currently reside in a keystore such as OTK.
To find out more about an API key (e.g., its Client Secret, OAuth attributes, associated API, etc. ), you can drill into the individual API keys by clicking their linked names in the API Key Name column.
For any API keys with an Error status, click the error link to view the message describing the cause of the error.
Filtering and Sorting
You may apply a combination of any number of filters to view a select list of API keys that interest you with the following fields at the top of the API list:
  • Key Name (Enter characters from Key names)
  • API Key (Enter a key - Exact Match Only)
  • Key Status (Select from Drop-down list - Default is Any Status)
  • Deployment Status (Select from Drop-down list - Default is Any Deployment Status)
You may sort your list by a last-deployed time-line of either ‘New to Old’ or ‘Old to New’.
Delete an API Proxy
You can delete a proxy if you no longer need it, if it is causing problems, or if you added it by mistake.
When you delete an API proxy, all references to that proxy are removed from
API Portal
. Analytics data for that API proxy remain but is no longer accessible.
You cannot delete the last enrolled API proxy.
Follow these steps:
  1. Select
    Proxies
    from the Manage menu.
  2. On the API Proxy page, select
    Delete
    next to the API proxy that you want to delete.
  3. Select
    Ok
    to confirm the deletion.