Available in Classic and VPC
Edit the description of an API.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| PATCH | /products/{product-id}/apis/{api-id} |
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 |
|---|---|---|---|
product-id |
String | Required | Product ID associated with the API |
api-id |
String | Required | API ID created on the product |
Request syntax
The request syntax is as follows.
{
"apiDescription" : "apiDescription"
}
Request body
The following describes the request body.
| Field | Type | Required | Description |
|---|---|---|---|
apiDescription |
String | Required | Description for the API to edit |
Request example
The following is a sample request.
curl -X PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}' \
--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 '{
"apiDescription" : "api-*** Description"
}'
Response
The following describes the response format.
Response status codes
For response status codes common to API Gateway, see API Gateway response status codes.