Restoring encryption keys

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 restore encryption key file that was previously backed up. In the request header of this API function, specify multipart/form-data for Content-Type.
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 header

In this API, the request body is sent in the format of multipart/form-data. Specify multipart/form-data for the Content-Type of the request header.

Request line

POST base-URL/v1/objects/encryption-keys/file/actions/restore/invoke

Request message

Object ID

Specify a value for file.

When backing up encryption keys to a file or restoring encryption keys from a file, the value of file is a fixed value (the object ID).

Query parameters

None.

Body

Attribute

Type

Description

password

string

(Required) The password that was specified when the encryption key was backed up.

file

file

(Required) The backed-up encryption key file.

Specify the most recent backup file.

Encryption keys that are not up to date (for example, encryption keys that were changed after the file was backed up) cannot be restored.

Response message

Body

A job object is returned. For details on the schema of job objects, see the description of job objects. Note, however, that this API function does not display the affectedResources attribute.

Action template

None.

Status codes

The following table describes the meaning of the status code of the request for this operation. For details on other status codes, see the description of HTTP status codes.

Status code

Message

Description

412

Precondition Failed

The microcode version of the storage system does not support this operation.

Coding example

curl -v -H "Accept:application/json" -H "Content-Type: multipart/form-data" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -H "Expect:" -X POST -F "file=@C:\backupfile.ekf" -F "password=backuppassword" https://192.0.2.100/ConfigurationManager/v1/objects/encryption-keys/file/actions/restore/invoke