View API
- Print
- PDF
View API
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in Classic and VPC
View API information.
This API checks the sub account resource list for VIEW_GET_API (subaccount) on query (SubAccountResourceListCheck).
Request
The following describes the request format for the endpoint. The request format is as follows:
| Method | URI |
|---|---|
| GET | /products/{product-id}/apis |
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 |
Request query parameters
The following describes the parameters.
| Field | Type | Required | Description |
|---|---|---|---|
offset | Long | Optional | Starting point in the list of data to view
|
limit | Long | Optional | Number of data to view at once
|
withStage | Boolean | Optional | Whether to view stage information
|
apiName | String | Optional | Filter by API name
|
hasStage | Boolean | Optional | Filter by stage presence or absence
|
hasStageNotAssociatedWithUsagePlanId | String | Optional | View excluding stages associated with a specific usage plan
|
Request example
The following is a sample request.
curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis' \
--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.
{
"apis": [
{
"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.
{
"apis": [
{
"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"
}
],
"total": 1
}
Was this article helpful?