Getting a specific 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 get information about a specific encryption key by specifying the ID of the key. You can use this API request to get information about a key whose type is DEK or FREE. To get information about a key whose type is CEK or KEK, use the API request that gets information about a list of encryption keys.

Execution permission

Security Administrator (View Only)

Request line

GET 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) ID of the key

Query parameters: None.

Body: None.

Response message

Body

{
    "keyId": "7",
    "createdTime": "2018-10-29T04:32:26Z",
    "keyType": "DEK",
    "uuid": "-",
    "targetDeviceLocation": "HDD00-09",
    "keyGeneratedLocation": "DKC",
    "numOfBackups": 4
}

Attribute	Type	Description
keyId	string	ID of the key
createdTime	ISO8601string	Date and time when the key was created
keyType	string	Type of the key `DEK`: Encryption key The key is used to encrypt stored data. `FREE`: Unused key that has not been assigned an encryption key
uuid	string	UUID of the key A hyphen (`-`) is always output.
targetDeviceLocation	string	Device to which the key is assigned Location number of the drive (if the key type is DEK) A hyphen (`-`) (if the key type is FREE)
keyGeneratedLocation	string	Location where the key was created `DKC`: Storage system `KMS`: Key management server
numOfBackups	int	Number of times the key was backed up

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