- Print
- PDF
Re-encrypt
- Print
- PDF
Available in Classic and VPC
Reencrypt the ciphertext with the most recent version of the specified master 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:
Method | URI |
---|---|
POST | /keys/{keyTag}/re-encrypt |
Request headers
For information about the headers common to all Key Management Service APIs, see the token authentication method in Key Management Service request headers.
Request path parameters
You can use the following path parameters with your request:
Field | Type | Required | Description |
---|---|---|---|
keyTag | String | Required | Key tag
|
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
ciphertext | String | Required | String created by encrypting a plaintext |
context | String | Conditional | Base64-encoded string data
|
Request example
The request example is as follows:
- Request
ciphertext
as String type
curl --location --request POST 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/re-encrypt' \
--header 'x-ncp-ocapi-token: {Access Token}' \
--data '{
"ciphertext": "{CIPHERTEXT}",
"context": "{BASE64_CONTEXT}"
}'
- Request
ciphertext
as Array<String> type
curl --location --request POST 'https://ocapi.ncloud.com/kms/v1/keys/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6/re-encrypt' \
--header 'x-ncp-ocapi-token: {Access Token}' \
--data '{
"ciphertext": ["{CIPHERTEXT_1}", "{CIPHERTEXT_2}", "{CIPHERTEXT_3}"],
"context": "{BASE64_CONTEXT}"
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
code | String | - | Success or Failure |
data | Object | - | Response result |
data.newCiphertext | String or Array<String> | - | String that reencrypted the ciphertext (ciphertext ) with the most recent version of the specified master key |
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
ciphertext
as String type
{
"code": "SUCCESS",
"data": {
"newCiphertext": "{CIPHERTEXT_NEW}"
}
}
- Request
ciphertext
as Array<String> type
{
"code": "SUCCESS",
"data": {
"newCiphertext": [
"{CIPHERTEXT_NEW_1}",
"{CIPHERTEXT_NEW_2}",
"{CIPHERTEXT_NEW_3}"
]
}
}