View API key

Available in Classic and VPC

View the list of API keys.

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/api-keys' \
--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.

{
    "apiKeys": [
        {
            "apiKeyId": "apiKeyId",
            "tenantId": "tenantId",
            "apiKeyName": "apiKeyName",
            "apiKeyDescription": "apiKeyDescription",
            "modifier": "modifier",
            "isEnabled": true,
            "modTime": "2024-05-07T07:08:12Z",
            "domainCode": "domainCode"
        }
    ],
    "total": 0,
    "initialCount": 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.

{
    "apiKeys": [
        {
            "apiKeyId": "*****vg079",
            "tenantId": "*****02f55ae4436913a6e2c65bab47c",
            "apiKeyName": "apiKeyName",
            "apiKeyDescription": "apiKeyDescription",
            "modifier": "d12c9fd0-****-****-****-246e96591a38",
            "isEnabled": true,
            "modTime": "2024-05-07T07:08:12Z",
            "domainCode": "PUB"
        }
    ],
    "total": 1,
    "initialCount": 1
}