View API

Available in Classic and VPC

View the API created and deployed in a product using the product-related parameters in the dashboard.

Request

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

Method	URI
GET	/dashboards/products/{product-id}/api-ids

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
`regions`	List<String>	Optional	Region to view APIs for Items in a collection can't be null
`offset`	Long	Optional	Starting point in the list of data to view 0 - 9,223,372,036,854,775,807
`limit`	Long	Optional	Number of data to view at once 1 - 9,223,372,036,854,775,807
`from`	String	Required	Query start date (yyyy-MM-dd)
`to`	String	Required	Query end date (yyyy-MM-dd)
`timeZone`	String	Required	Time zone (+09:00) URL encoding is required when using the GET method

Request example

The following is a sample request.

curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/dashboards/products/{product-id}/api-ids
?from=2024-05-09
&to=2024-05-09
&timeZone=%2B09%3A00' \
--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": {
        "content": [
            {
                "apiId": "apiId",
                "apiName": "apiName",
                "deleted": true
            }
        ],
        "total": 1
    }
}

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": {
        "content": [
            {
                "apiId": "*****vcqwb",
                "apiName": "api-***",
                "deleted": true
            }
        ],
        "total": 1
    }
}