Deleting an encryption key

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 delete unused (FREE) keys by specifying the ID of the key you want to delete. Keys whose type is CEK or DEK cannot be deleted.
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

DELETE base-URL/v1/objects/encryption-keys/object-ID

Request message

Object ID

Specify the value for keyId that you acquired by running the API request to obtain a list of encryption keys.

Attribute

Type

Description

keyId

string

(Required) The key ID

Query parameters

None.

Body
None.

Response message

Body

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

Attribute

Description

affectedResources

The URL of the key that was deleted

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 DELETE https://192.0.2.100/ConfigurationManager/v1/objects/encryption-keys/4