Get Key Version List
    • PDF

    Get Key Version List

    • PDF

    Article summary

    Available in Classic and VPC

    Get the version list of a key.

    Request

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

    MethodURI
    GET/keys/{keyTag}/versions

    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 path parameters

    You can use the following path parameters with your request:

    FieldTypeRequiredDescription
    keyTagStringRequiredKey tag
    • Unique identifier for the key derived from the key name
    • Check through Get key list
    • Use to request encryption or decryption with REST APIs
    • Key tags are not treated as confidential information

    Request example

    The request example is as follows:

    curl --location --request GET 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/versions' \
    --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:

    FieldTypeRequiredDescription
    codeString-Success or Failure
    dataObject-Response result
    data.keyTagString-Tag of the key that was queried
    data.currentVersionInteger-Current key version
    data.versionListArray-Details by key version

    versionList

    The following describes versionList.

    FieldTypeRequiredDescription
    versionInteger-Key version
    statusString-Key status
    • ENABLE | DISABLE
      • ENABLE: available (version enabled)
      • DISABLE: unavailable (version disabled)
    statusDateLong-Key status change date and time (millisecond)
    • Unix timestamp format
    rotatedDateLong-Key rotation date and time (millisecond)
    • Unix timestamp format

    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": {
            "keyTag": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6",
            "currentVersion": 2,
            "versionList": [
                {
                    "version": 1,
                    "status": "ENABLE",
                    "statusDate": 1733875954000,
                    "rotatedDate": 1732603460000
                },
                {
                    "version": 2,
                    "status": "ENABLE",
                    "rotatedDate": 1733875426000
                }
            ]
        }
    }
    

    Was this article helpful?

    What's Next
    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.