If you are assigned the Deployer or Admin role, you can deactivate a
managed API
and its operations. You can view, edit, activate, or delete a deactivated managed API.
You can deactivate a managed API when the API is in the deprecated state. You can activate and use an inactive managed API.
After you deactivate a managed API, the API is no longer available in the API gateway and all calls to the API will fail. Ensure that you notify the API consumers about the impending deactivation of the managed API before deactivating the API to prevent disruptions and enable them to make necessary adjustments.
If the deactivation fails, the status of the managed API doesn't change. You can't view the operation level status of a managed API.
You can use the
Show Inactive APIs
toggle button to see the list of inactive or deactivated APIs.
On the
API Console
page, click the
Managed APIs
tab.
Click the
Actions
menu on the row of the
managed API
and select
Deactivate Managed API
.
The
Update <managed_API_name> Lifecycle Status
dialog box appears.
On the
Inactive
tab, enter one or more valid email addresses.
No email communications are sent to these email addresses. You can use the
Email Address
field as a placeholder to add the email addresses. You can refer to the placeholder email addresses when you want to send a notification to the API consumers externally.
Optionally, add required notes.
Click
Confirm
.
The managed API status changes to
Inactive
.
The
managed API
gets deactivated and the
managed API
count reduces by 1.
Similarly, on the
Published APIs
tab, the
managed API
count of the respective published API reduces by 1.
ASK INFAPreview
