Implements S3 encryption on your system.
Endpoint
POST /s3_encryption/set
Request structure
{
"encryptionMode": "type"
}
| Parameter | Type | Description |
|---|---|---|
| encryptionMode | String | Sets the S3 encryption mode. You can set either INTERNAL or EXTERNAL. Encryption is DISABLED by default. |
Response structure
{
"encryptionMode": "DISABLED",
"rekeyEvents": [
{
"user": "string",
"timestamp": 0,
"code": "KEY_COMPROMISE",
"message": "string"
}
]
}
|
Parameter |
Type |
Description |
|---|---|---|
| encryptionMode | String | Sets the S3 encryption mode. You can set either INTERNAL or EXTERNAL. Encryption is DISABLED by default. |
| user | String | Displays the name of the user who set the encryption. |
| timestamp | Integer | Displays the time the encryption was applied. |
| code | String | A general reason for the rekey. Values include:
|
| message | String | A message providing further explanation and the action required (if any) to remedy the error. |
Return codes
|
Status code |
HTTP name |
Description |
|---|---|---|
| 200 | OK | The request was executed successfully. |
| 401 | Unauthorized | Access was denied because credentials are not valid. |
| 405 | Method Not Allowed | The specified HTTP method is not allowed for user data. Resend using POST. |
| 503 | Service Unavailable | The KMS is not currently set up. |