Get the current S3 encryption

Virtual Storage Platform One Object API Reference Guide

Version
3.0.x
File Size
270 KB
Audience
anonymous
Part Number
MK-24VSP1OB002-01
Displays the current S3 encryption set on your system.

Endpoint

POST /s3_encryption/get

Request structure

Not applicable.

Response structure

{
  "encryptionMode": "DISABLED",
  "rekeyEvents": [
    {
      "user": "string",
      "timestamp": 0,
      "code": "KEY_COMPROMISE",
      "message": "string"
    }
  ]
}

Parameter

Type

Description

encryptionMode String The type of S3 encryption, either INTERNAL or EXTERNAL. Encryption can also be set as DISABLED.
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:
  • "KEY_ROTATED"
  • "REKEY_SUCCESS"
  • "KEY_OLD"
  • "KEY_COMPROMISE"
  • "INVALID_KEY"
  • "INSUFFICIENT_PERMISSIONS"
  • "KEY_IN_USE"
  • "SERVER_ERROR"
  • "SERVICE_UNAVAILABLE"
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.