Hi, I'm Ask INFA!
What would you like to know?
ASK INFAPreview
Please to access Ask INFA.

Manage APIs

Manage APIs

Deprecating a managed API

Deprecating a managed API

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.
  1. On the
    API Console
    page, click the
    Managed APIs
    tab.
  2. 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.
  3. 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.
  4. Optionally, add required notes.
  5. Click
    Confirm
    .
    The managed API status changes to
    Deprecated
    .
    You can view or deactivate a deprecated managed API.

0 COMMENTS

We’d like to hear from you!