MENU
      Encrypt
        • PDF

        Encrypt

        • PDF

        Article summary

        Available in Classic and VPC

        Encrypt up to 32 KB of data with the current version of the key. It can only be requested as an AES256 or RSA2048 key type.

        Request

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

        MethodURI
        POST
        • API Gateway request signature v1: /keys/v1/{keyTag}/encrypt
        • API Gateway request signature v2: /keys/v2/{keyTag}/encrypt

        Request headers

        For information about the headers common to all Key Management Service APIs, see 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 body

        You can include the following data in the body of your request:

        FieldTypeRequiredDescription
        plaintextString or Array<String>RequiredBase64-encoded string data
        • Up to 32 KB of data can be encrypted
        contextStringConditionalBase64-encoded string data
        • Required when using keys with convergent encryption
        • Can be up to 50 bytes long
        • Always generate the same ciphertext, even when encrypting the same data multiple times

        Request example

        The request example is as follows:

        • Request API Gateway request signature v1 and plaintext as String type
        curl --location --request POST 'https://kms.apigw.ntruss.com/keys/v1/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/encrypt' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-apigw-api-key: {API Gateway API Key}' \
        --header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
        --header 'x-ncp-apigw-signature-v1: {API Gateway Signature}' \
        --data '{
          "plaintext": "{BASE64_PLAINTEXT}",
          "context": "{BASE64_CONTEXT}"
        }'
        Shell
        • Request API Gateway request signature v and plaintext as Array<String> type
        curl --location --request POST 'https://kms.apigw.ntruss.com/keys/v2/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/encrypt' \
        --header 'x-ncp-apigw-timestamp: {Timestamp}' \
        --header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
        --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
        --data '{
          "plaintext": ["{BASE64_PLAINTEXT_1}", "{BASE64_PLAINTEXT_2}", "{BASE64_PLAINTEXT_3}"],
          "context": "{BASE64_CONTEXT}"
        }'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        codeString-Success or Failure
        msgString-Description of the response code (code)
      • Display an empty value ("") on request success (SUCCESS)
      • dataObject-Response result
        data.ciphertextString-String data created by encrypting a plaintext

        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:

        • Request plaintext as String type
        {
            "code": "SUCCESS",
            "msg": "",
            "data": {
                "ciphertext": "{CIPHERTEXT}"
            }
        }
        JSON
        • Request plaintext as Array<String> type
        {
            "code": "SUCCESS",
            "msg": "",
            "data": {
                "ciphertext": [
                    "{CIPHERTEXT_1}",
                    "{CIPHERTEXT_2}",
                    "{CIPHERTEXT_3}"
                ]
            }
        }
        JSON

        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.