Available in Classic and VPC
Unsubscribe by disassociating an API key associated with the product.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| POST | /api-keys/{api-key-id}/unsubscribe |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
api-key-id |
String | Required | API key ID to disassociate from the product |
Request syntax
The request syntax is as follows.
{
"productId" : "productId"
}
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
productId |
String | Required | Product ID to disassociate the API key from |
Request example
The following is a sample request.
curl -X POST 'https://apigateway.apigw.ntruss.com/api/v1/api-keys/{api-key-id}/unsubscribe' \
--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}'
--data '{
"productId": "*****xn0bk"
}'
Response
The following describes the response format.
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.