Resource
- Print
- PDF
Resource
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Create a resource
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources
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
{
"corsMaxAge" : "corsMaxAge",
"corsAllowMethods" : "corsAllowMethods",
"corsAllowOrigin" : "corsAllowOrigin",
"resourcePath" : "resourcePath",
"corsAllowCredentials" : "corsAllowCredentials",
"corsExposeHeaders" : "corsExposeHeaders",
"corsAllowHeaders" : "corsAllowHeaders"
}
Response Code
- 201
Response Body
{
"resource" : {
"corsMaxAge" : "corsMaxAge",
"resourceId" : "resourceId",
"corsAllowMethods" : "corsAllowMethods",
"methods" : [ {
"methodName" : "ANY",
"methodCode" : "methodCode"
} ],
"corsAllowOrigin" : "corsAllowOrigin",
"resourcePath" : "resourcePath",
"corsAllowCredentials" : "corsAllowCredentials",
"corsExposeHeaders" : "corsExposeHeaders",
"apiId" : "apiId",
"corsAllowHeaders" : "corsAllowHeaders"
}
}
Delete a resource
URL
DELETE https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-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 |
resourceId | path | Y | String | Resource Id Length(Min/Max): 0/10 |
Request Body
- None
Response Code
- 204
Response Body
- None
Get resource of an api
URL
GET https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources
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
- 200
Response Body
{
"resourceList" : [ {
"corsMaxAge" : "corsMaxAge",
"resourceId" : "resourceId",
"corsAllowMethods" : "corsAllowMethods",
"methods" : [ {
"methodName" : "ANY",
"methodCode" : "methodCode"
} ],
"corsAllowOrigin" : "corsAllowOrigin",
"resourcePath" : "resourcePath",
"corsAllowCredentials" : "corsAllowCredentials",
"corsExposeHeaders" : "corsExposeHeaders",
"apiId" : "apiId",
"corsAllowHeaders" : "corsAllowHeaders"
} ]
}
Import(overwrite) resources from swagger file
URL
POST https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/import
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
{
"importValidateType" : "FAIL_ON_WARN",
"swagger" : "swagger"
}
Response Code
- 200
Response Body
{
"errorMessages" : [ "errorMessages" ],
"warnMessages" : [ "warnMessages" ],
"success" : true,
"resourceList" : [ {
"corsMaxAge" : "corsMaxAge",
"resourceId" : "resourceId",
"corsAllowMethods" : "corsAllowMethods",
"methods" : [ {
"methodName" : "ANY",
"methodCode" : "methodCode"
} ],
"corsAllowOrigin" : "corsAllowOrigin",
"resourcePath" : "resourcePath",
"corsAllowCredentials" : "corsAllowCredentials",
"corsExposeHeaders" : "corsExposeHeaders",
"apiId" : "apiId",
"corsAllowHeaders" : "corsAllowHeaders"
} ]
}
Modify a resource
URL
PATCH https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}/resources/{resource-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 |
resourceId | path | Y | String | Resource Id Length(Min/Max): 0/10 |
Request Body
{
"corsMaxAge" : "corsMaxAge",
"corsAllowMethods" : "corsAllowMethods",
"corsAllowOrigin" : "corsAllowOrigin",
"corsAllowCredentials" : "corsAllowCredentials",
"corsExposeHeaders" : "corsExposeHeaders",
"corsAllowHeaders" : "corsAllowHeaders"
}
Response Code
- 200
Response Body
{
"resource" : {
"corsMaxAge" : "corsMaxAge",
"resourceId" : "resourceId",
"corsAllowMethods" : "corsAllowMethods",
"methods" : [ {
"methodName" : "ANY",
"methodCode" : "methodCode"
} ],
"corsAllowOrigin" : "corsAllowOrigin",
"resourcePath" : "resourcePath",
"corsAllowCredentials" : "corsAllowCredentials",
"corsExposeHeaders" : "corsExposeHeaders",
"apiId" : "apiId",
"corsAllowHeaders" : "corsAllowHeaders"
}
}
Was this article helpful?