Changing 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
You can change the encryption environment settings. If you change the settings to enable the encryption environment, encryption is applied. If you change the settings to disable the encryption environment, the encryption environment settings are initialized.
Note:

If you locked any resources of the target storage system by using the REST API, you will not be able to use this API function. In such cases, unlock the resources before running the API function.

Execution permission

Security Administrator (View & Modify)

Request line

PATCH 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
{
      "isEnabled": true
}

Attribute

Type

Description

isEnabled

boolean

(Required) Specify whether to enable the encryption environment.
  • true: Enables the encryption environment
  • false: Disables (initialize) the encryption environment

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute

Description

affectedResources

URL of the encryption environment settings specified for the storage system

Action template

None.

Status codes

For details on 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 PATCH --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/encryption-settings/instance