Version 9.5 SP1
 —  API Management Solutions  —

Deleting an API

Deleting an API permanently removes the API from the CentraSite registry.


General

When you delete an API, CentraSite removes the registry entry for the API (that is, it removes the instance of the API from CentraSite's object database). Also note that:

Top of page

Delete an API

You can delete a single API or a selected set of APIs. The descriptions in this section give you details on how to do this.

To delete any given API, you must belong to a role that has the "Manage Assets" permission for the organization in which the API resides.

The following sections describe how to delete APIs.

Deleting a Single API

Use the following procedure to delete a single API.

Start of instruction setTo delete an API

  1. In CentraSite Business UI, display the details page for the API that you want to delete. If you need procedures for this step, see the section Viewing the Details of an API.

  2. On the API’s actions menu, click Delete (graphics/action_delete.gif).

  3. When you are prompted to confirm the delete operation, click Yes.

    The API is permanently removed from the CentraSite registry.

Deleting a Set of APIs

You can delete multiple APIs in a single step. The rules described above for deleting a single API apply also when deleting multiple APIs.

Important:
If you have selected several APIs where one or more of them are predefined APIs, only those APIs you have permission for will be deleted. The same applies to any other APIs for which you do not have the required permission.

Use the following procedure to delete a set of APIs.

Start of instruction setTo delete multiple APIs in a single operation

  1. In CentraSite Business UI, use either the Browse or Search feature to select a set of APIs you want to delete. If you need information on how to browse or search the CentraSite catalog, refer to the section Browsing the CentraSite Catalog or Searching the CentraSite Catalog in the document Managing the CentraSite Catalog.

  2. Mark the checkbox next to the name of each API you want to delete.

  3. In the actions menu, click Delete (graphics/action_delete.gif).

    Note:
    If one or more or the selected APIs is in pending state (e.g., awaiting approval), an error message will appear and no APIs will be deleted.

Top of page