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.
apip43
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.
Portal Admin
API Owner
Org Publisher
Org Admin
Developer
Guest
Anonymous
Create API
green.png
green.png
green.png
red.png
red.png
red.png
red.png
Read API
green.png
green.png
green.png
green.png
green.png
red.png
red.png
Update API
green.png
green.png
green.png
red.png
red.png
red.png
red.png
Delete API
green.png
green.png
green.png
red.png
red.png
red.png
red.png
Assign Managing Org
green.png
green.png
red.png
red.png
red.png
red.png
red.png
Assign User Permissions
green.png
green.png
red.png
red.png
red.png
red.png
red.png
Assign Consuming Org
green.png
green.png
green.png
red.png
red.png
red.png
red.png
The Org Publisher has publishing permissions only in their assigned Organization.
Edit APIs
Follow these steps:
  1. Log in to API Developer Portal as an administrator.
  2. Select
    Publish
    .
  3. From the top menu, select
    APIs
    .
    The APIs page opens. APIs are shown in tiles.
  4. (Optional) To show APIs as a list, click the list image button on the right side. To switch back to tile view, click the tile image button.
  5. Select an API tile or an API from the list.
    A page with information about the selected API opens:
    • Overview - API location, API type, and tags.
    • Spec - Swagger API documentation
    • Deployments - information about Proxies to which the API is deployed and the type of deployment (on demand, automatic, scripted)
    • Documentation - for more information about API Documentation, see Manage API Documents.
    The Deployments tab is visible to administrators and to users who have
    read
    permissions for APIs, Proxies, and API Deployments. The Documentation tab is visible to administrators.
  6. To edit the API, click the
    Actions
    button in the top right corner and select one of the following options:
    • Add API to Application
    • Edit API Details
    • Edit Visibility Permissions
    • Edit Management Permissions
    • Edit Tags
    • Delete API
For more information about editing Visibility Permissions, Management Permissions, and Tags, go to Create and Set Permissions for APIs.
Add API to Application
Follow these steps:
  1. Log in to API Developer Portal as an administrator.
  2. Select
    Publish
    .
  3. From the top menu, select
    APIs
    .
  4. On the APIs page, select the API you want to edit.
    The API details page opens.
  5. In the top right corner, click the
    Actions
    button.
  6. Select
    Add API to Application
    .
    A drop-down list of Applications appears.
  7. Select an application. An
    Edit Application
    page opens. 
  8. Follow the steps in Edit Applications.
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 Developer Portal as an administrator.
  2. Select
    Publish
    .
  3. From the top menu, select
    APIs
    .
  4. Select the API that you want to edit.
    The APIs page opens.
  5. In the top right corner, click the
    Actions
    button.
  6. Select
    Edit API Details
    .
  7. Edit the API, and then select
    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. Log in to API Developer Portal as an administrator.
  2. Select
    Publish
    .
  3. From the top menu, select
    APIs
    .
  4. Disable the API:
    1. On the APIs page, select the API you want to disable.
      The API details page opens.
    2. In the top right corner, click the
      Actions
      button.
    3. Select
      Edit API
      .
    4. In the
      API Details
      tab, change the state to
      Disable
      , and then select
      Save
      .
  5. 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.
  6. 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
      .
  7. Delete the API on the API Portal:
    1. On the APIs page, select the API you want to delete.
    2. In the top right corner, click the
      Actions
      button.
    3. Select
      Delete API
      .
    4. 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.
  8. (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.