Updated on 2022-02-21 GMT+08:00

Taking an API Offline

Scenario

You can remove APIs that you do not need from the environments where the APIs have been published.

This operation will cause the APIs to be inaccessible in the environments. Ensure that you have notified users before this operation.

Prerequisites

  • You have created an API group and API.
  • You have published the API.

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner and choose API Gateway.
  3. In the navigation pane, choose API Publishing > APIs.
  4. Take the API offline. You can use one of the following methods:

    • In the Operation column of the target API, choose More > Take Offline.
    • Click the name of the target API, and click Take Offline in the upper right corner of the API details page.

    To take multiple APIs offline, select the APIs, and click Take Offline. You can take a maximum of 1000 APIs offline at a time.

  5. Select the environment from which you want to take the API offline, and click Yes.

Follow-Up Operations

After taking an API offline, delete it based on the instructions provided in Deleting an API.