View API_filter

Prev Next

Available in Classic and VPC

View the list of API IDs and names created in a product.

Request

The following describes the request format for the endpoint. The request format is as follows:

Method URI
GET /products/{product-id}/apis/filter

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 example

The following is a sample request.

curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/products/{product-id}/apis/filter' \
--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": [
        {
            "productId": "productId",
            "apiId": "apiId",
            "apiName": "apiName"
        }
    ],
    "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": [
        {
            "productId": "*****xn0bk",
            "apiId": "*****y6ql9",
            "apiName": "api-***"
        },
        {
            "productId": "*****xn0bk",
            "apiId": "*****luwtk",
            "apiName": "api-***"
        }
    ],
    "total": 2
}