Create stage
    • PDF

    Create stage

    • PDF

    Article summary

    Available in Classic and VPC

    Create a stage 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}/stages

    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 stage you want to create

    Request syntax

    The request syntax is as follows.

    {
        "cacheTtlSec" : 0,
        "ipAclList" : "ipAclList",
        "stageName" : "stageName",
        "throttleRps" : 6,
        "response" : "response",
        "deploymentDescription" : "deploymentDescription",
        "isMaintenance" : true,
        "enabledContentEncoding": true,
        "minimumCompressionSize": 0,
        "ipAclCode" : "ALLOWED",
        "endpointDomain" : "endpointDomain",
        "statusCode" : 1
    }
    

    Request body

    The following describes the request body.

    FieldTypeRequiredDescription
    cacheTtlSecIntegerOptionalAPI cache TTL
    • 1 - 3600 seconds
    ipAclListStringConditionalIP ACL list
    • Required when entering ipAclCode
    stageNameStringRequiredStage name
    • 1 to 20 characters, including English letters, numbers, and special characters "_" and "-"
    throttleRpsIntegerOptionalPer-method per-second request limit
    • 1 - 2,147,483,647
    responseStringOptionalResponse for the status code
    • 0 - 1500 characters
    deploymentDescriptionStringOptionalDescription for the stage deployment
    isMaintenanceBooleanOptionalMaintenance settings
    • true | false (default)
      • true: enable
      • false: disable
    enabledContentEncodingBooleanOptionalEncoding settings
    • true | false (default)
      • true: enable
      • false: disable
    minimumCompressionSizeIntegerOptionalWhether to compress data when sending
    • Enter a non-negative integer to enable compression
      • 0 - 10,485,760
    • Compression is disabled if this field is not entered
    ipAclCodeStringConditionalWhether to allow IP ACLs
    • ALLOWED | REJECTED
      • ALLOWED: allow
      • REJECTED: deny
    • Required when entering ipAclList
    endpointDomainStringRequiredEndpoint domain
    statusCodeIntegerOptionalStatus code
    • 100 - 599

    Request example

    The following is a sample request.

    curl --location --request POST 'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/apis/***51hs***/stages' \
    --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 '{
        "stageName": "stage000",
        "endpointDomain": "https://test***.test.com"
    }'
    

    Response

    The following describes the response format.

    Response syntax

    The response syntax is as follows.

    {
        "stage" : {
            "canaryDeployedTime" : "2000-01-23T04:56:07.000+00:00",
            "modifier" : "modifier",
            "canaryEndpointDomain" : "canaryEndpointDomain",
            "canaryThrottleRps" : 5,
            "cacheTtlSec" : 0,
            "stageName" : "stageName",
            "throttleRps" : 4,
            "monthQuotaRequest" : 9,
            "canaryCacheTtlSec" : 6,
            "canaryDistributionRate" : 5.962134,
            "apiId" : "apiId",
            "stageId" : "stageId",
            "deployedStageDeploymentNo" : 7,
            "useDistributionRate" : true,
            "canaryDeploymentDescription" : "canaryDeploymentDescription",
            "dayQuotaRequest" : 2,
            "isMaintenance" : true,
            "rateRps" : 3,
            "endpointDomain" : "endpointDomain",
            "ipAclList" : "ipAclList",
            "canaryDeploymentNo" : 1,
            "regTime" : "2000-01-23T04:56:07.000+00:00",
            "response" : "response",
            "canaryConditions" : [ {
                "parameterName" : "parameterName",
                 "parameterCode" : "REQUEST_HEADER",
                "parameterValue" : "parameterValue"
            } ],
            "tenantId" : "tenantId",
            "ipAclCode" : "ALLOWED",
            "statusCode" : 2,
            "enabledContentEncoding": true,
            "minimumCompressionSize": 0
        }
    }
    

    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.

    {
        "stage": {
            "tenantId": "***e230cebc1402ba89b148896951***",
            "modifier": "***d3020-5bb7-11ec-bfb8-246e96591***",
            "stageId": "***fh5o***",
            "apiId": "***51hs***",
            "stageName": "stage000",
            "endpointDomain": "https://test***.test.com",
            "regTime": "2024-05-07T23:48:47Z",
            "isMaintenance": false,
            "enabledContentEncoding": false
        }
    }
    

    Was this article helpful?

    What's Next
    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.