View API key

Available in Classic and VPC

View the created API key using the API key-related parameters in the dashboard.

Request

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

Request headers

For headers common to API Gateway, see API Gateway common request headers.

Request query parameters

The following describes the parameters.

Request example

The following is a sample request.

curl -X GET 'https://apigateway.apigw.ntruss.com/api/v1/dashboards/api-keys
?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.

{
    "apiKeyIds": {
        "content": [
            {
                "apiKeyId": "apiKeyId",
                "apiKeyName": "apiKeyName",
                "deleted": false,
                "enabled": true
            }
        ],
        "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.

{
    "apiKeyIds": {
        "content": [
            {
                "apiKeyId": "*****vg079",
                "apiKeyName": "apiKey-***",
                "deleted": false,
                "enabled": true
            }
        ],
        "total": 1
    }
}