Edit method produces

Prev Next

Available in Classic and VPC

Edit the produce information for the set method. The type of content you're receiving changes.

Request

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

Method URI
PUT /api/v1/products/{product-id}/apis/{api-id}/resources/{resource-id}/methods/{method-name}/produces

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 that the API belongs to
api-id String Required ID of the API being edited
resource-id String Required ID of the target resource in the API
method-name String Required Target method type
  • ANY | GET | POST | PUT | DELETE | PATCH | OPTIONS | HEAD

Request syntax

The request syntax is as follows.

{
  "produces" : "produces"
}

Request body

The following describes the request body.

Field Type Required Description
produces String Required Content type to change to
  • Equivalent to the Content-Type header in HTTP
  • 1 - 100 characters
  • <E.g.> application/json, application/xml, text/plain

Request example

The following is a sample request.

curl --location --request PUT 'https://apigateway.apigw.ntruss.com/api/v1/products/********o9/apis/cvcohvd2xj/resources/p1hiuvmwv3/methods/DELETE/produces' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "produces" : "text/plain"
}'

Response

The following describes the response format.

Response syntax

The response syntax is as follows.

{
  "produces" : "produces"
}

Response status codes

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

Response example

The following is a sample response.

{
    "produces": "text/plain"
}