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/{project_id}/apigw/instances/{instance_id}/apis/publish/{api_id}[?env_id]

The following table lists the parameters in the URI.

Table 2 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which can be obtained by the administrator on the My Credentials page.

instance_id

Yes

String

Instance ID, which can be obtained from the dedicated gateway information on the API Gateway console.

api_id

Yes

String

API ID

env_id

Yes

String

Environment ID

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