API

Article Summary

Share feedback

Thanks for sharing your feedback!

Clone an api

URL

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

Request Parameter

Name	Position	Required	Type	Description
productId	path	Y	String	Product Id Length(Min/Max): 0/10

Request Body

{
  "apiName" : "apiName",
  "apiDescription" : "apiDescription",
  "originApiId" : "originApiId"
}

Response Code

Response Body

{
  "api" : {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  }
}

Create an api

URL

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

Request Parameter

Name	Position	Required	Type	Description
productId	path	Y	String	Product Id Length(Min/Max): 0/10

Request Body

{
  "apiName" : "apiName",
  "apiDescription" : "apiDescription"
}

Response Code

Response Body

{
  "api" : {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  }
}

Delete an api

URL

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

Request Parameter

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

Request Body

None

Response Code

Response Body

None

Deploy An Api

URL

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

Request Parameter

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

Request Body

{
  "deploymentDescription" : "deploymentDescription",
  "stageId" : "stageId"
}

Response Code

Response Body

None

Search api by product id

URL

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

Request Parameter

Name	Position	Required	Type	Description
productId	path	Y	String	Product Id Length(Min/Max): 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
withStage	query string	N	Boolean	With Stage
apiName	query string	N	String	Api Name Length(Min/Max): 0/20
hasStage	query string	N	Boolean	Has Stage
hasStageNotAssociatedWithUsagePlanId	query string	N	String	Has Stage Not Associated With Usage Plan Id

Request Body

None

Response Code

Response Body

{
  "total" : 0,
  "apis" : [ {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  } ]
}

Get api-list of filter

URL

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

Request Parameter

Name	Position	Required	Type	Description
productId	path	Y	String	Product Id Length(Min/Max): 0/10

Request Body

None

Response Code

Response Body

{
  "total" : 0,
  "apis" : [ {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  } ]
}

Get an api

URL

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

Request Parameter

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

Request Body

None

Response Code

Response Body

{
  "api" : {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  }
}

Search apis' infos by product id

URL

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

Request Parameter

Name	Position	Required	Type	Description
productId	path	Y	String	Product Id Length(Min/Max): 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
withStage	query string	N	Boolean	With Stage
apiName	query string	N	String	Api Name Length(Min/Max): 0/20
hasStage	query string	N	Boolean	Has Stage
hasStageNotAssociatedWithUsagePlanId	query string	N	String	Has Stage Not Associated With Usage Plan Id

Request Body

None

Response Code

Response Body

{
  "total" : 0,
  "apis" : [ {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  } ]
}

Import api from swagger

URL

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

Request Parameter

Name	Position	Required	Type	Description
productId	path	Y	String	Product Id Length(Min/Max): 0/10

Request Body

{
  "apiName" : "apiName",
  "apiDescription" : "apiDescription",
  "importValidateType" : "FAIL_ON_WARN",
  "swagger" : "swagger"
}

Response Code

Response Body

{
  "errorMessages" : [ "errorMessages" ],
  "warnMessages" : [ "warnMessages" ],
  "success" : true,
  "api" : {
    "apiName" : "apiName",
    "domainCode" : "domainCode",
    "productId" : "productId",
    "modifier" : "modifier",
    "permission" : "permission",
    "isDeleted" : true,
    "modTime" : "2000-01-23T04:56:07.000+00:00",
    "stages" : [ {
      "stageName" : "stageName",
      "isPublished" : true,
      "apiId" : "apiId",
      "stageId" : "stageId"
    } ],
    "tenantId" : "tenantId",
    "apiDescription" : "apiDescription",
    "disabled" : true,
    "apiId" : "apiId",
    "actionName" : "actionName"
  }
}

Modify an api

URL

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

Request Parameter

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

Request Body

{
  "apiDescription" : "apiDescription"
}

Response Code

Response Body

None

Publish a product

URL

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

Request Parameter

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

Request Body

{
  "stages" : [ {
    "isPublished" : true,
    "stageId" : "stageId"
  } ]
}

Response Code

Response Body

None

Was this article helpful?

What's Next

API Key

Table of contents

Clone an api
Create an api
Delete an api
Deploy An Api
Search api by product id
Get api-list of filter
Get an api
Search apis' infos by product id
Import api from swagger
Modify an api
Publish a product