Stage

Article Summary

Share feedback

Thanks for sharing your feedback!

Connect a usage plan

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/associate-usage-plan

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10
stageId	path	Y	String	Stage Id Length (Max/Min): 0/10

Request body

{
  "usagePlanId" : "usagePlanId"
}

Response code

Response bodies

Create Stage

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10

Request body

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

Response code

Response bodies

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

Delete Stage

URL

DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10
stageId	path	Y	String	Stage Id Length (Max/Min): 0/10

Request body

Response code

Response bodies

Deploy to Stage

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/deploy

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10
stageId	path	Y	String	Stage Id Length (Max/Min): 0/10

Request body

{
  "deploymentNo" : 0
}

Response code

Response bodies

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

Disconnect a usage plan

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/disassociate-usage-plan

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10
stageId	path	Y	String	Stage Id Length (Max/Min): 0/10

Request body

{
  "usagePlanId" : "usagePlanId"
}

Response code

Response bodies

View usage plans

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/search

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10

Request body

{
  "usagePlanId" : "usagePlanId"
}

Response code

Response bodies

{
  "stages" : [ {
    "stageName" : "stageName",
    "stageId" : "stageId"
  } ]
}

Search Stages

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10
stageId	path	Y	String	Stage Id Length (Max/Min): 0/10

Request body

Response code

Response bodies

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

View Stages

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10

Request body

Response code

Response bodies

{
  "host" : "host",
  "stages" : [ {
    "canaryDeploymentNo" : 0,
    "stageName" : "stageName",
    "isCanary" : true,
    "resourceDtos" : [ {
      "corsMaxAge" : "corsMaxAge",
      "resourceId" : "resourceId",
      "corsAllowMethods" : "corsAllowMethods",
      "methods" : [ {
        "methodName" : "ANY",
        "methodCode" : "methodCode"
      } ],
      "corsAllowOrigin" : "corsAllowOrigin",
      "resourcePath" : "resourcePath",
      "corsAllowCredentials" : "corsAllowCredentials",
      "corsExposeHeaders" : "corsExposeHeaders",
      "apiId" : "apiId",
      "corsAllowHeaders" : "corsAllowHeaders"
    } ],
    "defaultDeploymentNo" : 6,
    "stageId" : "stageId"
  } ]
}

View Stages

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/filter

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10

Request body

Response code

Response bodies

{
  "host" : "host",
  "stages" : [ {
    "canaryDeploymentNo" : 0,
    "stageName" : "stageName",
    "isCanary" : true,
    "resourceDtos" : [ {
      "corsMaxAge" : "corsMaxAge",
      "resourceId" : "resourceId",
      "corsAllowMethods" : "corsAllowMethods",
      "methods" : [ {
        "methodName" : "ANY",
        "methodCode" : "methodCode"
      } ],
      "corsAllowOrigin" : "corsAllowOrigin",
      "resourcePath" : "resourcePath",
      "corsAllowCredentials" : "corsAllowCredentials",
      "corsExposeHeaders" : "corsExposeHeaders",
      "apiId" : "apiId",
      "corsAllowHeaders" : "corsAllowHeaders"
    } ],
    "defaultDeploymentNo" : 6,
    "stageId" : "stageId"
  } ]
}

Initialize cache

URL

POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/cache-initialize

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10
stageId	path	Y	String	Stage Id Length (Max/Min): 0/10

Request body

Response code

Response bodies

Search usage plans connected to the Stage

URL

GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/usage-plans

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10
stageId	path	Y	String	Stage Id Length (Max/Min): 0/10
offset	query string	N	Long	Offset Min: 0 Max: 9,223,372,036,854,775,807
limit	query string	N	Long	Limit Min: 1 Max: 9,223,372,036,854,775,807
usagePlanName	query string	N	String	Usage Plan Name Length (Max/Min): 0/20

Request body

Response code

Response bodies

{
  "total" : 5,
  "monthQuotaRequest" : 6,
  "dayQuotaRequest" : 0,
  "rateRps" : 1,
  "quotaCondition" : "quotaCondition",
  "content" : [ {
    "domainCode" : "domainCode",
    "usagePlanId" : "usagePlanId",
    "modifier" : "modifier",
    "associatedStagesCount" : 0,
    "dayQuotaRequest" : 6,
    "permission" : "permission",
    "rateRps" : 5,
    "usagePlanName" : "usagePlanName",
    "monthQuotaRequest" : 1,
    "tenantId" : "tenantId",
    "disabled" : true,
    "usagePlanDescription" : "usagePlanDescription",
    "quotaCondition" : "quotaCondition",
    "actionName" : "actionName"
  } ]
}

Set the default usage plan

URL

PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}/usage-plan

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10
stageId	path	Y	String	Stage Id Length (Max/Min): 0/10

Request body

{
  "monthQuotaRequest" : 1,
  "dayQuotaRequest" : 6,
  "rateRps" : 0,
  "quotaCondition" : "quotaCondition"
}

Response code

Response bodies

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

Edit Stage settings

URL

PUT https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/stages/{stage-id}

Request parameters

Name	Location	Requirement status	Type	Description
productId	path	Y	String	Product Id Length (Max/Min): 0/10
apiId	path	Y	String	Api Id Length (Max/Min): 0/10
stageId	path	Y	String	Stage Id Length (Max/Min): 0/10

Request body

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

Response code

Response bodies

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

Was this article helpful?

What's Next

Stage Deployment

Table of contents

Connect a usage plan
Create Stage
Delete Stage
Deploy to Stage
Disconnect a usage plan
View usage plans
Search Stages
View Stages
View Stages
Initialize cache
Search usage plans connected to the Stage
Set the default usage plan
Edit Stage settings