Creating a DSM Key
Use the post /v1/cckm/dsm/keys
API to create a new key on DSM.
Syntax
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authorization token. |
domain | string | Name or ID of the DSM domain where the key is to be created. Refer to Getting DSM Domains to get a domain's ID. |
dsm_params | JSON | Parameters to specify properties of the DSM key. Refer to DSM Parameters for details. |
extractable | boolean | Whether the key is extractable. Set to true to make extractable, false to make non-extractable. |
object_type | string | Object type of the DSM key. The options are: • asymmetric • symmetric" The default type is symmetric . |
DSM Parameters
Parameter | Type | Description |
---|---|---|
algorithm | string | Algorithm of the key. The supported algorithms are: • RSA1024 (asymmetric) • RSA2048 (asymmetric) • RSA3072 (asymmetric) • RSA4096 (asymmetric) • AES256 (symmetric) • AES128 (symmetric) • ARIA128 (symmetric) • ARIA256 (symmetric) |
name | string | Name for the DSM key. |
description | string | Description of the DSM the key. |
encryptionMode | string | (Applicable to AES Symmetric keys) Encryption mode of the DSM key. The options are: • CBC • CBC_CS1 • XTS |
expirationTime | string | Expiration time of the key. The key will expire after the specified time. |
keyVersionLifeSpan | integer | Life span of the key versioning. |
Example Request
Example Response
A new key named test-key
is created on the DSM.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.