Creating 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 create encryption keys by specifying the number of encryption keys you want to create. After creating an encryption key, be sure to back it up.
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

POST base-URL/v1/objects/encryption-keys

Request message

Object ID
None.
Query parameters

None.

Body
{
    "count": 10
}

Attribute

Type

Description

count

int

(Required) The number of encryption keys to be created

Specify a value equal to or greater than 1.

If the sum of the value specified for the count attribute and the number of existing keys exceeds the maximum number of keys that can be created, no keys are created, and an error occurs.

Response message

Body

A job object is returned. See the description for the job object. affectedResources is not displayed for this API. To confirm that the encryption keys have been created, run the API request for obtaining the number of encryption keys or the API request for obtaining a list of encryption keys.

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:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/encryption-keys