MENU
      Create resource

        Create resource


        Article summary

        Available in Classic and VPC

        Create a resource according to the user-defined conditions.

        Request

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

        MethodURI
        POST/products/{product-id}/apis/{api-id}/resources

        Request headers

        For headers common to API Gateway, see API Gateway common request headers.

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID that the API belongs to
        api-idStringRequiredID of the API whose resource you want to create

        Request syntax

        The request syntax is as follows.

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

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        corsMaxAgeStringOptionalPeriod in which the client will store preflight request results
        corsAllowMethodsStringOptionalMethod to allow in client requests (resource access)
        • GET | POST | PUT | PATCH | DELETE | HEAD | OPTIONS
        corsAllowOriginStringOptionalSet up domains to allow client requests (resource access)
        • Enter * to allow all domains
        resourcePathStringRequiredResource path
        • <E.g.> /resource
        corsAllowCredentialsStringOptionalEquivalent to the value of Access-Control-Allow-Credentials in HTTP
        corsExposeHeadersStringOptionalCustom headers that can be included in client requests (resource access)
        corsAllowHeadersStringOptionalHeaders to allow in client requests (resource access)

        Request example

        The following is a sample request.

        curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/resources' \
        --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" : "*",
            "resourcePath" : "/test01***2233",
            "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"
        }'
        Curl

        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"
            }
        }
        JSON

        Response status codes

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

        Response example

        The following is a sample response.

        {
            "resource": {
                "apiId": "***51hs***",
                "resourceId": "***hoc2***",
                "resourcePath": "/test01***2233",
                "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"
            }
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.