Edit resource

Available in Classic and VPC

Edit resource information according to the user-defined conditions.

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}/resources/{resource-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 that the resource belongs to 0 - 10 characters Check through View product list
`api-id`	String	Required	ID of the API that the resource belongs to 0 - 10 characters Check through View API
`resource-id`	String	Required	ID of the resource to edit 0 - 10 characters Check through View resource list

Request syntax

The request syntax is as follows.

{
    "corsMaxAge" : "corsMaxAge",
    "corsAllowMethods" : "corsAllowMethods",
    "corsAllowOrigin" : "corsAllowOrigin",
    "corsAllowCredentials" : "corsAllowCredentials",
    "corsExposeHeaders" : "corsExposeHeaders",
    "corsAllowHeaders" : "corsAllowHeaders"
}

Request body

The following describes the request body.

Field	Type	Required	Description
`corsMaxAge`	String	Optional	Period in which the client will store preflight request results
`corsAllowMethods`	String	Optional	Method to allow in client requests (resource access) `GET` \| `POST` \| `PUT` \| `PATCH` \| `DELETE` \| `HEAD` \| `OPTIONS`
`corsAllowOrigin`	String	Optional	Set up domains to allow client requests (resource access) Enter `*` to allow all domains
`corsAllowCredentials`	String	Optional	Equivalent to the value of Access-Control-Allow-Credentials in HTTP
`corsExposeHeaders`	String	Optional	Custom headers that can be included in client requests (resource access)
`corsAllowHeaders`	String	Optional	Headers to allow in client requests (resource access)

Request example

The following is a sample request.

curl --location --request PATCH 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/resources/***lvof***' \
--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 '{
    "corsAllowMethods" : "DELETE",
    "corsAllowOrigin" : "*",
    "corsAllowHeaders" : "content-type,x-ncp-apigw-api-key,x-ncp-apigw-timestamp,x-ncp-iam-access-key,x-ncp-apigw-signature-v1,x-ncp-apigw-signature-v2"
}'

Response

The following describes the response format.

Response syntax

The response syntax is as follows.

{
    "resource" : {
        "corsMaxAge" : "corsMaxAge",
        "resourceId" : "resourceId",
        "corsAllowMethods" : "corsAllowMethods",
        "methods" : [ {
            "methodName" : "ANY",
            "methodCode" : "methodCode"
        } ],
        "corsAllowOrigin" : "corsAllowOrigin",
        "resourcePath" : "resourcePath",
        "corsAllowCredentials" : "corsAllowCredentials",
        "corsExposeHeaders" : "corsExposeHeaders",
        "apiId" : "apiId",
        "corsAllowHeaders" : "corsAllowHeaders"
    }
}

Response status codes

For response status codes common to API Gateway, see API Gateway API response status codes.

Response example

The following is a sample response.

{
    "resource": {
        "methods": [
            {
                "methodCode": "0006",
                "methodName": "OPTIONS"
            }
        ],
        "apiId": "***51hs***",
        "resourceId": "***lvof***",
        "resourcePath": "/test001***3",
        "corsAllowOrigin": "*",
        "corsAllowMethods": "DELETE",
        "corsAllowHeaders": "content-type,x-ncp-apigw-api-key,x-ncp-apigw-timestamp,x-ncp-iam-access-key,x-ncp-apigw-signature-v1,x-ncp-apigw-signature-v2"
    }
}