Deleting an API definition

You can delete an API definition that is no longer required.

About this task

You can complete this task either by using the API Designer UI application, or by using the browser based API Manager UI.

API Manager UI only: To complete this task, you must be assigned a role that has the Api-Drafts:Edit permission. The pre-supplied Developer role has this permission by default; if you are assigned a custom role it must have this permission. For more information, see Creating custom roles.


  1. In the navigation pane, click Develop icon in the API UI navigation pane Develop, then select the APIs tab.
  2. You can delete an API either from the Develop listing page, or from within the API definition itself.
    1. To delete an API from the Develop listing page, click the options menu icon options icon alongside the required API, and then select Delete.
    2. To delete an API from within the API definition, complete the following steps:
      1. Click the title of the API definition that you want to work with.
      2. Click the options menu icon:
        Screen capture highlighting the options menu icon
      3. To delete just this version of the API, select Delete. To delete all versions of this API, select Delete API.
      Note: If a Product was previously generated automatically from the API, by using the Activate API option, that Product will be deleted together with the API; such Products have the title api_title auto product.
  3. Click Delete to confirm.