MENU
      Create product

        Create product


        Article summary

        Available in Classic and VPC

        Create a product 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

        Request headers

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

        Request syntax

        The request syntax is as follows.

        {
            "subscriptionCode" : "PROTECTED",
            "description" : "description",
            "productName" : "productName"
        }
        JSON

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        subscriptionCodeStringRequiredSubscription method of the product to create
        • PUBLIC | PROTECTED
          • PUBLIC: The API can be used by anyone without approval
          • PROTECTED: Publisher approval is required to use the API
        descriptionStringOptionalDescription of the product to create
        • 0 - 300 characters
        productNameStringRequiredName of the product to create
        • 1 - 100 characters

        Request example

        The following is a sample request.

        curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products' \
        --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 '{
            "subscriptionCode" : "PROTECTED",
            "description": "test",
            "productName" : "product001"
        }'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        {
            "product" : {
                "invokeId" : "invokeId",
                "domainCode" : "domainCode",
                "productId" : "productId",
                "isPublished" : true,
                "modifier" : "modifier",
                "permission" : "permission",
                "productName" : "productName",
                "subscriptionCode" : "PROTECTED",
                "isDeleted" : true,
                "modTime" : "2000-01-23T04:56:07.000+00:00",
                "tenantId" : "tenantId",
                "disabled" : true,
                "productDescription" : "productDescription",
                "actionName" : "actionName",
                "zoneCode" : "PUBLIC"
          }
        }
        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.

        {
            "product": {
                "productId": "***ghj3***",
                "invokeId": "***ghj3***",
                "tenantId": "***e230cebc1402ba89b148896951***",
                "productName": "product000",
                "productDescription": "test",
                "isPublished": false,
                "subscriptionCode": "PROTECTED",
                "modifier": "***d3020-5bb7-11ec-bfb8-246e96591***",
                "isDeleted": false,
                "modTime": "2024-05-07T01:53:41Z",
                "domainCode": "PUB",
                "zoneCode": "PUBLIC"
            }
        }
        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.