Edit and Delete APIs

API publishers can edit and delete APIs. You cannot edit some settings if the API is in use or if the API was Gateway published.
API publishers can create, edit, and delete APIs. You cannot edit some settings if the API is in use or if the API was Gateway published. For more information on how to create APIs, set up the visibility permissions for your organizations, and set up the API management, see Create and Set Permissions for APIs.
You can:
 
 
Edit API Details  
Edit  Visibility Permissions
Edit Management Permissions
Delete API
Add API to Application 
Edit API Details
You can edit the following information of an API using the API wizard:
  • On the 
    API Definition
     tab, you can add or replace an API definition file. The API Portal supports Swagger 3.0 JSON and WADL XML files (for REST APIs), and WSDL and optional XSD files (for SOAP APIs). 
  • On the 
    API Details
     tab, you can change the API Name, Version, and State. If no applications or API groups are using the API, you can also change its API EULA and Visibility. You cannot change the Proxy URL.
  • On the 
    Proxy Configuration
     tab, you can change the Location of the API and the Policy Templates.
     This tab is available only for API Portal-published APIs.
  • On the 
    Spec Authentication
     tab, for API Portal-published APIs, you can change the default Authentication Type that the API Explorer applies to the API.
For more information about these settings, see Publish APIs with the API Portal.
 
Follow these steps:
  1. Log in to API Portal and select 
    Publish
    .
  2. Select the API that you want to edit.
    The APIs page opens.
  3. In the top right corner, click the 
    Actions
     button.
  4.  Select 
    Edit API Details
    .
  5. Edit the API, and then select 
    Save
    .
Edit Visibility Permissions
As an API Owner, you can set up which organizations can see the API. API owners will always be able to see the API regardless of visibility settings. By default, the API is Private and Open.
 The state of an API also affects its visibility. For more information, see Manage API Lifecycles and States.
 
Follow these steps:
 
  1. On the APIs page, select the API you want to edit.
    The API details page opens.
  2. Select the 
    API Details
     tab.
  3. Click the 
    Actions
     button.
  4. Select 
    Edit Visibility Permissions
    .
    The 
    Visibility Permissions
     window opens.
  5. Change the visibility to 
    Public,
     
    Private
    , or 
    Restricted
    .
    If you set the visibility to 
    Public
    , the API is visible to all organizations. 
    If you select the visibility to 
    Private
    , the API is visible to you only. 
    If you set the visibility to 
    Restricted
    , you can specify which organizations can see this API. 
  6. Click 
    Save and Next
  7. Click 
    Save
    .  
Edit Management Permissions
Follow these steps:
 
  1. On the APIs page, select the API you want to edit.
     
    The API details page opens.
  2. Select the 
    API Details
     tab.
  3. Click the 
    Actions
     button.
  4. Select 
    Edit Management Permissions
    .
    The 
    Management Permissions
     window opens.
  5. Change the visibility to 
    Open,
     
    Private
    , or 
    Restricted
    .
    If you set the API Management to 
    Open
    , any users with API management permissions can edit this API. To see who that would be, select Restricted and see the list. API Owners added in the future will automatically be able to edit this API.
    If you set the API Management to 
    Private
    , only you can edit this API. 
    If you set the API Management to 
    Restricted
    , you can specify users with API management permissions to edit this API. Any new API Owners will need to be added manually to be able to edit this API.
  6. Click 
    Save
    .
Delete APIs from the API Portal
Administrators and API owners can delete an API. Deleting a API Portal-published API from the API Portal also deletes the API on the API proxy when the API Portal and the proxy synchronize.
Deleting 
Gateway-published
 APIs on the API Portal does not automatically delete the API on the API proxy. Therefore, the API Proxy page shows a synchronization error. We recommend that you have an API proxy administrator remove the 
Set as Portal Managed
 assertion from the API.
 
Follow these steps:
 
  1. Disable the API:
    1. On the APIs page, select the API you want to disable.
      The API details page opens.
    2. Select 
      Edit
      .
      The Edit API page opens.
    3. Select the 
      API Details
       tab
    4. Change the state to 
      Disable
      , and then select 
      Save
      .
  2. Determine which applications include the API that you want to delete, and remove the API from each application that includes it:
    1. On the API details page, under 
      References
      , select 
      Applications
      .
      The Applications page opens and shows a list of all applications that use the API.
    2. On the 
      Actions 
      menu next to the application, select 
      Edit
      .
      The Edit Application page opens.
    3. Select the API Management tab.
    4. Under 
      Selected APIs
      , select 
      Remove
       next to the API you want to remove from the application, and then select 
      Save
      .
      If an application includes only one selected API, you can remove the API only by replacing it with another API.
  3. Remove the API from each API group that includes it:
    1. On the API details page, under 
      References
      , select 
      API Groups
      .
      The API Groups page opens and shows a list of all the API groups that use the API.
    2. On the 
      Actions
       menu next to the API group that includes the API you want to delete, select 
      Edit
      .
      The Edit API Group page opens.
    3. In the 
      APIs
       section, under 
      Selected APIs
      , select 
      Remove
       next to the API you want to remove from the API group, and then select 
      Save
      .
  4. Delete the API on the API Portal:
    1. On the APIs page, select the API you want to delete.
    2. On the API details page, select 
      Delete
      .
       If you cannot delete the API, then one or more applications that include the API might be pending approval. Look for application requests that include the API and reject them.
  5. (Recommended) If the API is a 
    Gateway-published
     API, remove the 
    Set as Portal Managed
     assertion from the API on the API proxy:
    1. Use the Policy Manager to log in to the API proxy as an administrator.
    2. Remove the 
      Set as Portal Managed
       assertion from the API.
The API is deleted from the API Portal.
Add API to Application
 
Follow these steps:
 
  1. On the APIs page, select the API you want to edit.
     
    The API details page opens.
  2. Select the 
    API Details
     tab.
  3. Click the 
    Actions
     button.
  4. Select 
    Add API to Applications
    .
    A drop-down list of Applications appears.
  5. Select an application. An 
    Edit Application
     page opens.  
  6. Follow the steps in Edit Applications.