Get Key List

Available in Classic and VPC

Get the key list.

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all Key Management Service APIs, see the account authentication method in Key Management Service request headers.

Request query parameters

You can use the following query parameters with your request:

Request example

The request example is as follows:

curl --location --request GET 'https://ocapi.ncloud.com/kms/v1/keys?pageNo=1&pageSize=1' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' 

Response

This section describes the response format.

Response body

The response body includes the following data:

KeyList

The following describes KeyList.

Response status codes

For response status codes common to all Key Management Service APIs, see Key Management Service response status codes.

Response example

The response example is as follows:

{
    "code": "SUCCESS",
    "data": {
        "keyList": [
            {
                "keyId": 12345,
                "keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
                "keyName": "{KEY_NAME}",
                "keyType": "AES256",
                "status": "REVOKE",
                "protectionType": "BASIC",
                "isConvergent": true,
                "registerDate": 1733380631000,
                "destroyDate": 1733645878000
            }
        ],
        "currentPageNo": 1,
        "totalPageNo": 1,
        "totalCount": 1
    }
}