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:
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. Select
    Publish
    ,
    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.
    You can edit the API deployment type only for deployed proxies.
  • To assign or un-assign an organization to or from the proxy.
Follow these steps:
  1. On the API Proxy page, select
    Edit
    next to the API proxy that you want to edit.
    The
    Details
    tab opens.
  2. Edit the proxy name, the API deployment type, and the key deployment type, and then select
    Save & Next
    .
    The
    Organization Assignment
    tab opens.
  3. 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 the Status of an API Proxy
Follow these steps:
  1. On the API Proxy page, select the name of the proxy for which you want to view the status.
    The API Proxy Details page appears.
  2. To view the API or key deployment type details, click
    Edit
    .
  3. To view details of an error, select the red error icon.
    If you did not complete the proxy enrollment, the proxy is considered
    pending enrollment
    and no details are shown. To complete the enrollment, on the API Proxy page for that proxy, select
    View Details
    and follow the instructions on the screen. The enrollment URL expires and regenerates after 24 hours. If more than 24 hours have elapsed since you copied the URL, you must copy a new one.
    For more information about how to troubleshoot API deployments, see Troubleshoot API Deployments.
View Proxy Details
You can view the details for a specific proxy from the tiles that display on the API Proxy Details page. The following image shows an example of the API Proxy Details page:
Green checkmarks indicate that the API proxy is synchronizing correctly. Red
x
icons might indicate a problem, especially if the last synchronization far exceeds the synchronization interval.
You can view the following information for the proxy on this page:
  • The API deployment type (Automatic or on Demand)
  • The key deployment type (Automatic or On Demand)
  • The API proxy URL
  • The proxy version
  • The OTK version
You can view the following information about the entities that are associated to this proxy on this page:
  • The
    APIs
    tile displays information about the APIs:
    • Portal
      displays the total number of APIs in
      API Portal
      .
    • Proxy
      (only shown for automatic proxies) displays the total number of APIs deployed to this proxy.
  • The
    Application API Keys
    tile displays information about the API keys:
    • Portal
      displays the total number of API keys for all applications in
      API Portal
      .
    • Proxy
      (only shown for automatic proxies) displays the total number of API keys deployed to this proxy.
  • 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.
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. On the API Proxy page, select
    Delete
    next to the API proxy that you want to delete.
  2. Select
    Ok
    to confirm the deletion.