Help Center/ API Gateway/ API Reference/ Shared Gateway APIs (for Existing Users)/ API Management/ Taking an API Offline
Updated on 2022-09-01 GMT+08:00
View PDF
Share

Taking an API Offline

Function

This API is used to remove an API from an environment in which it has been published. After this operation, the API can no longer be called in the environment.

URI

The following table lists the HTTP/HTTPS request method and URI of the API.

Table 1 HTTP/HTTPS request method and URI

Request Method

URI

DELETE

/v1.0/apigw/apis/publish/{api_id}[?env_id]

The following table lists the parameters in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

api_id

Yes

String

API ID

env_id

Yes

String

ID of the environment in which the API has been published

Request

N/A

Response

N/A

Status Codes

Table 3 Status codes

Status Code

Description

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409

Conflict

500

Server Internal Error
Parent topic: API Management