Getting information about the encryption environment settings

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request gets information about the encryption environment settings.

Execution permission

Security Administrator (View & Modify)

Request line

GET base-URL/v1/objects/encryption-settings/instance

Request message

Object ID

Specify instance.

If an object has only one instance, the instance is the fixed value that specifies the object ID.

Query parameters
None.
Body

None.

Response message

Body
{
    "isEnabled": true,
    "detectsError": false
}

Attribute

Type

Description

isEnabled

boolean

Whether the encryption environment is enabled
  • true: The encryption environment is enabled
  • false: The encryption environment is disabled

detectsError

boolean

Whether an error occurred while the encryption environment settings were being changed

  • true: An error occurred.
  • false: No error occurred.

If this value is true, data encryption cannot be performed. Disable (initialize) the encryption environment settings by running the API request that changes the encryption environment settings, and then enable the encryption environment settings again.

Status codes

For details about the status codes of the request for this operation, see the description of HTTP status codes.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/encryption-settings/instance