Encrypt
- Print
- PDF
Encrypt
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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:
Method | URI |
---|---|
POST |
|
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:
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 |
---|---|---|---|
plaintext | String or Array<String> | Required | Base64-encoded string data
|
context | String | Conditional | Base64-encoded string data
|
Request example
The request example is as follows:
- Request API Gateway request signature v1 and
plaintext
as String type
- Request API Gateway request signature v and
plaintext
as Array<String> type
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 |
msg | String | - | Description of the response code (code )SUCCESS ) |
data | Object | - | Response result |
data.ciphertext | String | - | 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
- Request
plaintext
as Array<String> type
Was this article helpful?