If you are assigned the Deployer or Admin role, you can deprecate a
managed API
and its operations. You can deprecate a managed API if the API is in the active state or shared state.
If you plan to deactivate a managed API, deprecate the managed API first to inform the API consumers that the deprecated managed API might not be available for consumption in the future. The existing API consumers can continue using the deprecated managed API and its operations until the API is deactivated.
After you deprecate a managed API, the API endpoint URL doesn't appear on the
Managed APIs
tab as the API. You can't download the API specification for a deprecated API.
On the
API Console
page, click the
Managed APIs
tab.
Click the
Actions
menu on the row of the
managed API
and select
Deprecate Managed API
.
The
Update <managed_API_name> Lifecycle Status
dialog box appears.
Optionally, on the
Deprecated
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
Deprecated
.
You can view or deactivate a deprecated managed API.