The Status drop-down in the basic settings allows you to retire an API. A retired API is shut down and can no longer be called.

You need to confirm the action in a separate pop-up window. If you are trying to retire a private API, the pop-up also informs you about the number of active contracs for this API.

You have three options:

  • Click Retire to shut down the API. Clients can no longer use this API version.
  • (Click View Contracts to check which clients currently use this API with an active contract.)
  • Click Cancel to abort the action.

If you have confirmed the retirement, the status in the basic settings will change to

Now, this API it is not invokable any more and its status cannot be changed.

 Nevertheless, you have still access to the API's configuration details in the API Management and you are still able to create a new version from it:

Related Pages:
  • No labels