Disable Canary

Available in Classic and VPC

Disable the Canary feature deployed on a stage.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method	URI
DELETE	/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary

Request headers

For information about the headers common to all API Gateway APIs, see API Gateway request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`product-id`	String	Required	Product ID associated with the API 1 - 10 characters
`api-id`	String	Required	API ID created on the product 1 - 10 characters
`stage-id`	String	Required	Stage ID created on the API 1 - 10 characters

Request example

The following is a sample request.

curl -X DELETE 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/canary' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

The following describes the response format.

Response status codes

For information about the HTTP status codes common to all API Gateway APIs, see API Gateway response status codes.