You can publish and manage APIs using the
API Management SaaSand the API proxy.
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 (PAPI) 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 how to manage API visibility and permissions, see Create and Set Permissions for APIs.
You can find, filter, and examine published APIs using the APIs page using either the Grid View or List View. You can also filter APIs by tags. The following image shows the APIs page:
This page shows the following information about the APIs:
- Portal State:The state of the API onAPI Management SaaS:
- Enabled:Org Admins and Developers can add only enabled APIs (checkmark) to applications. Applications can consume only enabled APIs.
- Incomplete:Incomplete APIs are APIs that have been created but do not have the required fields specified to be enabled. After you have supplied these values, you can enable the API.SOAP APIs require a Web Services Description Language (WSDL). SOAP and REST APIs require the following:
- At least one policy template.
- Values for the required custom fields.
- Deprecated:Deprecated APIs display with a (down arrow). If an API is already added to an application and the state of the API changes fromEnabledtoDeprecated, the application can continue to consume the API.
- Disabled:Disabled APIs display with an (X). If an API is already added to an application and the state of the API changes fromEnabledtoDisabled, 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 but aren't enabled in API Portal. To learn how to enable a Gateway-published API, see Enable a Gateway-Published API.
- Visibility:Switch toList Viewor useFilter byto see the visibility of APIs. Private or semi-private APIs are available only to the organizations to which they have been assigned. Public APIs are available to all organizations. Publishers can access all APIs.
- Version:Shows the current version of the API.
- Tags:Shows 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.You can edit only some of the API settings for applications that have added APIs.
View the List of Applications that Have Added an API
Prerequisite:You have added at least one API to an application.
For more information about how to add APIs to applications, see Manage Applications
On the APIs page, in the row of the API, select the number in the
Applicationscolumn. The Applications page opens with a list of the applications to which an Org Admin or Developer has added the API.
View the Details for an API
Prerequisite:You have created the API.
For more information about how to create APIs, see Create and Set Permissions for APIs
Follow these steps:
- From the menu bar, selectManage,APIs.TheAPIspage appears.
- Select the API for which you want to view the details.The page with Overview information opens.TheSpectab is only visible for REST APIs. TheDeploymentstab is only visible to Portal Admins and API Owners.
- View the information in theOverviewandDeploymentstabs.You can download API assets such as WSDL or Swagger from the Overview page.
- View your API documents on theDocumentationtab.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
Deploymentstab 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
For each proxy enrolled with
API Portal, the deployment state, API 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 theAPI Management SaaSis 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 thePending Deploymentstate for a long time, there might be an issue with the deployment to the specified proxy. For on-demand and scripted API deployment types, select the deployment state link for a more detailed deployment response message.
- Error (red). If the API deployment state is inErrorstate, 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 redxicon. If so, there is a problem reaching the API proxy. Contact your system administrator in this case. The redxicon on Proxy Details page does not apply to on-demand and scripted deployments.For on-demand and scripted API deployment types, select the redErroricon on the API Details page to view more details about the error.
- API Deployment Type:The API deployment type determines how Portal published APIs are deployed to the proxy. The API deployment type cannot be edited once APIs are deployed to the proxy. The API deployment type is selected when adding an API proxy. A proxy supports the following API deployment types:
- AutomaticAny changes to APIs are automatically deployed to the proxy.
- On-DemandAPI deployments are triggered on-demand by calling the deployment APIs. You can access these APIs from the APIs page.
- ScriptedAPI deployments are integrated into your existing CI/CD workflow by using the deployment APIs and invoking them from your deployment script.
- 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.
See the following notes about search:
- Helps you find APIs and content on custom pages (pages that the Portal Admin publishes using the content management system).
- Finds exact matches, and partial matches in titles, names, descriptions, and other content.
- Does not find content on standard pages (for example, the Applications and Analytics pages).
- Does not support Boolean searches (operators like AND, NOT and OR to get more relevant results).