MENU
      View API key list

        View API key list


        Article summary

        Available in Classic and VPC

        View the list of API keys that meet the user-defined conditions.

        Request

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

        MethodURI
        POST/products/{product-id}/api-keys/search

        Request headers

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

        Request path parameters

        The following describes the parameters.

        FieldTypeRequiredDescription
        product-idStringRequiredProduct ID whose API key you want to view

        Request syntax

        The request syntax is as follows.

        {
            "apiKeyValue" : "apiKeyValue",
            "offset" : 6,
            "limit" : 0,
            "apiKeyId" : "apiKeyId",
            "statusSet" : [ "REQUEST" ]
        }
        JSON

        Request body

        The following describes the request body.

        FieldTypeRequiredDescription
        apiKeyValueStringOptionalPrimary key or secondary key value
        offsetLongOptionalStarting point of the response data
        • 0 - 9,223,372,036,854,775,807
        • It is used with limit to implement pagination
        limitLongOptionalMaximum number of response data
        • 1 - 9,223,372,036,854,775,807
        • It is used with offset to implement pagination
        apiKeyIdStringOptionalAPI key ID
        statusSetArrayOptionalAPI key status
        • REQUEST | DENY | ACCEPTED | REJECTED | BLOCKED_REQUEST
          • REQUEST: requested
          • DENY: request denied
          • ACCEPTED: approved
          • REJECTED: denied
          • BLOCKED_REQUEST: request blocked

        Request example

        The following is a sample request.

        curl --location --request POST'https://apigateway.apigw.ntruss.com/api/v1/products/***ksk9***/api-keys/search' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --header 'Content-Type: application/json' \
        --data '{
            "limit": 1,
            "statusSet": [
                "ACCEPTED"
            ]
        }'
        Curl

        Response

        The following describes the response format.

        Response syntax

        The response syntax is as follows.

        {
            "apiKeyPage" : {
                "total" : 0,
                "content" : [ {
                    "domainCode" : "domainCode",
                    "regTime" : "2000-01-23T04:56:07.000+00:00",
                    "secondaryKey" : "secondaryKey",
                    "modTime" : "2000-01-23T04:56:07.000+00:00",
                    "apiKeyId" : "apiKeyId",
                    "apiKeyName" : "apiKeyName",
                    "primaryKey" : "primaryKey",
                    "status" : "REQUEST"
                } ]
            }
        }
        JSON

        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.

        {
            "apiKeyPage": {
                "content": [
                    {
                        "primaryKey": "***cPwqGb81wdWGWTS0rJc6WSoamDEmWtL2T6***",
                        "secondaryKey": "***1rDumQKkUPD8ogxdpAouZRMTNy9YTFliHP***",
                        "apiKeyId": "***g2ya***",
                        "apiKeyName": "apikey001",
                        "regTime": "2024-05-09T00:58:08Z",
                        "modTime": "2024-05-09T00:58:08Z",
                        "status": "ACCEPTED",
                        "domainCode": "PUB"
                    }
                ],
                "total": 2
            }
        }
        JSON

        Was this article helpful?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.