Manage APIs

You can publish and manage APIs using the
Layer7 API Developer Portal
and API proxy. You can get information about the published APIs using the APIs page.
You can publish and manage APIs using the API Portal and API proxy. You can get information about the published APIs using the APIs page.
You can also manage your APIs by way of the Portal API or use this API in your scripts for managing APIs.
For more information about the Portal API, see Portal API (PAPI).
For more information about managing visibility and permissions for APIs, see Create and Set Permissions for APIs.
Examine APIs with the APIs Page and API Wizard
You can find, filter, and examine published APIs using the APIs page using either Grid View or List View. You can also filter APIs by tags.
This page shows the following information about each API:
  • Portal State:
    The state of the API on the API Portal:
    • Enabled:
      Organization administrators and developers can add enabled APIs (checkmark) to applications and applications can consume them.
    • Incomplete:
      Incomplete APIs are APIs that have been created but did not have all the required fields specified to be Enabled. Once all the values are supplied, an API can be Enabled.
      • For a SOAP API, a WSDL is required.
      • For both SOAP and REST APIs, the following are required:
        • At least one Policy Template
        • Any required Custom Field values
    • Deprecated:
      Organization administrators and developers cannot add deprecated APIs (down arrow) to applications. If an API is already added to an application and the state of the API changes from
      Enabled
      to
      Deprecated
      , the application can continue to consume the API.
    • Disabled:
      Organization administrators and developers cannot add disabled APIs (X) to applications. If an API is already added to an application and the state of the API changes from enabled to disabled, the application cannot continue to consume the API. If an API is already added to an API group and the state of the API changes from enabled to disabled, the following message appears on the Edit API Group page:
      This API Group contains disabled APIs and will not be available for applications of same organizations.
    • Unpublished:
      Unpublished APIs (up arrow in cloud) are APIs that have been published on the API proxy. The API must be in the
      Enabled
      state before organization administrators or developers can add it to their application and before their application can consume it.
  • Visibility:
    Switch to
    List View
    or use
    Filter by
    to see the visibility of APIs. A private or semi-private API is only available to organizations that it has been assigned to. Public APIs are available to all organizations. Publishers can access all APIs.
  • Version:
    Lets you know the current version of the API.
  • Tags:
    Shows all the tags that are associated with the API. You can add up to 25 tags to an API.
  • Applications:
    The number of applications that have added the API.
    If an application has added an API, you might only be able to edit some of the API settings.
View the List of Applications that Have Added an API
On the APIs page, in the row of the API, select the number in the Applications column. The Applications page opens with a list of the applications to which an organization administrator or developer has added the API.
View the Details for an API
  1. On the
    APIs
    page, in the
    API Name
    column, click the name of the API that you want to view.
    The page with Overview information opens.
    The
    Spec
    tab is only visible for REST APIs. The
    Deployments
    tab is only visible to Admins and API Owners.
  2. View the information in the
    Overview
    and
    Deployments
    tabs.
    API Assets such as WSDL or Swagger can be downloaded from the Overview page.
  3. View your API documents on the
    Documentation
    tab.
    For more information about this tab, see Manage API Documents.
View How and Where an API is Deployed in the Details Page
On the APIs page, click the name of the API that you want to view deployment details. The
Deployments
tab includes a list of proxies on which the API is deployed. The APIs that are published but not deployed display the enrolled proxies with the
Not Deployed
label.
For each proxy enrolled with
API Portal
, the deployment state, deployment type, and the date and timestamp displays:
  • Deployment State:
    When an API is deployed, undeployed, or edited, the deployment state is updated.
    The deployment states are:
    • Deployed (
      green
      ). The current version of the API on the
      Layer7 API Developer Portal
      is deployed to the API proxy shown.
    • Pending Deployment (
      yellow
      ). The deployment process is running. Deployment can take up to 2 minutes (6 minutes for the Hybrid solution).
      If the deployment state of the API changes on the API proxy while the API Details page is open, you can display the new deployment state faster by refreshing the browser. If an API has been stuck in the
      Pending Deployment
      state for a long time, there might be an issue with the deployment to the specified proxy. For on-demand and scripted deployment types, select the deployment state link for a more detailed deployment response message.
    • Error (
      red
      ). If the API deployment state is in
      Error
      state, there is a deployment or connection problem with the specified proxy.
      To verify the state of a proxy, access the API Proxy Details page for each proxy. Then, check whether the APIs section is displaying a red
      x
      icon. If so, there is a problem reaching the API proxy. Contact your system administrator in this case.  The red
      x
      icon on Proxy Details page does not apply to on-demand and scripted deployments.
      For on-demand and scripted deployment types, select the red
      Error
      icon on the API Details page to view more details about the error.
  • Deployment Type:
    Deployment type determines how Portal published APIs are deployed to the proxy. The deployment type cannot be edited once APIs are deployed to the proxy. The deployment type is selected when adding an API proxy. A proxy supports the following deployment types:
    • Automatic
      Any changes to APIs are automatically deployed to the proxy.
    • On-Demand
      API deployments are triggered on-demand by calling the deployment APIs. You can access these APIs from the APIs page.
    • Scripted
      API deployments are integrated into your existing CI/CD workflow by using the deployment APIs and invoking them from your deployment script.
    For more information about deployment types, see Deployment Types.
  • Last Updated timestamp:
    The details page also displays the date and timestamp of the last deployment attempt. The timestamp is updated on successful and failed deployments.
Using Search
For this release, see the following notes about search:
  • Helps you find APIs and content on custom pages (pages that your Admin publishes using the content management system).
  • Will find exact matches, and partial matches in titles, names, descriptions, and other content.
  • Will not find content on standard pages (for example, Applications and Analytics pages).
  • Does not support Boolean searches (operators like AND, NOT and OR to get more relevant results).