Backing up 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 back up encryption keys to a file on the REST API client. In the request header of this API function, specify application/octet-stream for Accept.

Note:

When you create an encryption key, be sure to back it up. We also recommend that you periodically back up encryption keys.
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

This API request downloads an encryption key file to the REST API client. Specify application/octet-stream for the Accept of the request header.

Request line

POST base-URL/v1/objects/encryption-keys/file/actions/backup/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

{
    "parameters": {
        "password": "backuppassword"
    }
}

Attribute	Type	Description
password	string	(Required) Password. Specify a character string consisting of 6 to 255 characters. You can use the following characters: Alphanumeric characters `!` `"` `#` `$` `%` `&` `'` `(` `)` `*` `+` `,` `-` `.` `/` `:` `;` `<` `=` `>` `?` `@` `[` `\` `]` `^` `_` ` `{` `\|` `}` `~` You will need this password when you restore the encryption key.

Attribute

Type

Description

password

string

(Required) Password.

Specify a character string consisting of 6 to 255 characters.

You can use the following characters:

Alphanumeric characters
! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

You will need this password when you restore the encryption key.

Response header

This API request returns the following response header.

Header	Description
Content-Disposition	`attachment`
Content-Length	The size of the backup data (in bytes)
Content-type	`application/octet-stream`

Response message

Body: None.

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/octet-stream" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/encryption-keys/file/actions/backup/invoke -o "backupfile.ekf"