Help Center/ DataArts Studio/ User Guide/ DataArts DataService/ API Development/ Managing APIs/ Unpublishing/Deleting APIs
Updated on 2022-09-23 GMT+08:00
View PDF

Unpublishing/Deleting APIs

Scenario

If you want to stop an API that has been published from providing services, you can unpublish the API. For details, see Unpublishing an API.

  • If you want to continue to use an API that has been unpublished, you need to publish it again. Note that the original authorization information of the API will not be retained once the API is unpublished.
  • If you no longer need the API, you can delete it. For details, see Deleting APIs.

The unpublished API cannot be accessed in the specified time, which may affect the applications or users who are using the API. Ensure that users have been notified of this consequence.

Prerequisites

  • An API has been created.
  • The API has been published.

Unpublishing an API

  1. On the DataArts Studio console, locate an instance and click Access. On the displayed page, locate a workspace and click DataArts DataService.
  1. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
  2. Choose API Development > APIs.
  3. Locate the row that contains the target API, choose More > Unpublish.
  4. In the displayed dialog box, select the time period where the API needs to be unpublished and click OK.

    The API unpublishing time must be later than its minimum retention period. Authorized users will be notified of the unpublishing. If all authorized users process the notifications in the review center or unbind the API from their apps, the API will be directly unpublished. Otherwise, the API will be forcibly unpublished when the minimum retention period ends.

Deleting APIs

  1. On the DataArts Studio console, locate an instance and click Access. On the displayed page, locate a workspace and click DataArts DataService.
  1. In the left navigation pane, choose an edition, for example, Exclusive Edition. The Overview page is displayed.
  2. Choose API Development > API Catalogs. On the page displayed, select the API you want to delete and click Delete.
    • Only APIs in an unpublished state can be deleted. APIs in suspended or published state cannot be deleted.
    • A maximum of 1,000 APIs can be deleted at a time.
  3. Click OK to delete the API.
Parent topic: Managing APIs