Manage Proxies

Tasks related to proxy management are performed by Portal Admins.
In this section, learn to:
View the Status of an API Proxy
The
API Proxy Details
page displays the following information:
  • Deployment Type
  • API Proxy URL
  • Proxy Version
  • OTK Version
  • APIs deployed to the Proxy
  • Apps using the Proxy
  • Account Plans attached to the Proxy
  • API Plans attached to the Proxy
  • Organizations assigned to the proxy
To view the status of an API Proxy:
  1. Log in to
    API Portal
    as a Portal administrator or other Publisher role.
  2. Select the
    Services
    icon.
  3. Select
    Publish, Proxies.
  4. On the
    API Proxy
    page, select
    View Details
    . Green check marks 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.
  5. For on-demand and scripted deployment types, select the
    Deployed
    link to view details of deployment.
  6. 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 can be shown. To complete the enrollment, select
    View Details
    on the API Proxy page for that proxy 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.
Edit an API Proxy
You can edit an API proxy, for instance:
  • To change the name of the proxy (for example, to give it a new name or to correct a spelling mistake).
  • To change which organizations are assigned to the proxy.
You can edit the deployment type only for deployed proxies.
Follow these steps:
  1. Log in as a Portal administrator.
  2. Select the
    Services
    icon.
  3. Select
    Publish, Proxies.
  4. On the API Proxy page, select
    Edit
    next to the API proxy.
  5. In
    Proxy Details
    , edit the
    Proxy Name
    , then click
    Save & Next
    .
  6. In
    Organizations Assignment
    , under
    Organizations
    , select or unselect the organizations to be assigned to the proxy, then click
    Save
    .
If you are upgrading from version 4.4 or earlier, by default no organization will be assigned to any of your proxies. Ensure that the Portal admin performs the necessary organizations assignment after upgrading. See Edit an API Proxy for details.
Delete an API Proxy
You can remove a proxy if you no longer need it, if it is causing problems, or if it was added by mistake.
Follow these steps:
  1. Log in to
    API Portal
    as a Portal administrator.
  2. Select the
    Services
    icon.
  3. Select
    Publish, Proxies.
  4. On the API Proxy page, select
    Delete
    next to the API proxy.
  5. Select
    OK
    to confirm the deletion.
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.
  • You can also assign organizations to a proxy using the Deployment API. However, organizations unassignment can only be done via the
    API Proxy Details
    page.
  • For information about how to deploy to an API Proxy, see Manage API Deployments.