Get encryption state

Content Platform for Cloud Scale Management API Reference

Version
2.5.x
Audience
anonymous
Part Number
MK-HCPCS007-08

You can get the state of encryption for the HCP for cloud scale system.

HTTP request syntax (URI)

POST https://host_ip:9099/mapi/v1/s3_encryption/get

Request structure

Not applicable.

Response structure

The response body structure is:

{
  MAPIS3EncryptionSetting {
    "value": "{true|false}"
    }
  }

Parameter

Type

Description

MAPIS3EncryptionSetting Boolean true if encryption is on, false otherwise.

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 a storage component. Resend using POST.

Example

Request example:

POST https://10.10.24.195:9099/mapi/v1/s3_encryption/get

JSON response:

{
  MAPIS3EncryptionSetting {
    "value": "true"
    }
  }