Available in Classic and VPC
View the API details.
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /products/{product-id}/apis/{api-id} |
Request headers
For headers common to API Gateway, see API Gateway common request headers.
Request path parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
product-id |
String | Required | Product ID associated with the API |
api-id |
String | Required | API ID created on the product |
Request example
The following is a sample request.
curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/{api-id}' \
--header 'Content-Type: application/json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
Response
The following describes the response format.
Response syntax
The syntax is as follows.
{
"api": [
{
"stages": [
{
"apiId": "apiId",
"stageId": "stageId",
"stageName": "stageName",
"isPublished": true
}
],
"productId": "productId",
"apiId": "apiId",
"apiName": "apiName",
"apiDescription": "apiDescription",
"tenantId": "tenantId",
"modifier": "modifier",
"modTime": "2024-05-02T08:10:26Z",
"isDeleted": false,
"domainCode": "domainCode"
}
"total": 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.
{
"api": [
{
"stages": [
{
"apiId": "*****luwtk",
"stageId": "*****7mhdv",
"stageName": "v1",
"isPublished": true
}
],
"productId": "*****xn0bk",
"apiId": "*****luwtk",
"apiName": "api",
"apiDescription": "",
"tenantId": "*****02f55ae4436913a6e2c65bab47c",
"modifier": "d12c9fd0-****-****-****-246e96591a38",
"modTime": "2024-05-02T08:10:26Z",
"isDeleted": false,
"domainCode": "PUB"
}
],
}