Apache CloudStack 4.23.0.0 Root Admin API Reference
createKMSKey
Creates a new KMS key (Key Encryption Key) for encryption
Request parameters
| Parameter Name | Description | Required |
| hsmprofileid | ID of HSM profile to create key in | true |
| name | Name of the KMS key | true |
| zoneid | Zone ID where the key will be valid | true |
| account | Account name (for creating keys for child accounts - requires domain admin or admin) | false |
| description | Description of the KMS key | false |
| domainid | Domain ID (for creating keys for child accounts - requires domain admin or admin) | false |
| keybits | Key size in bits: 128, 192, or 256 (default: 256) | false |
| projectid | ID of the project to create the KMS key for | false |
Response Tags
| Response Name | Description |
| id | the UUID of the key |
| account | the account owning the key |
| accountid | the account ID owning the key |
| algorithm | the encryption algorithm |
| created | the creation timestamp |
| description | the description of the key |
| domain | the domain name of the key |
| domainid | the domain ID of the key |
| domainpath | the domain path of the key |
| enabled | whether the key is enabled |
| hsmprofile | the zone name where the key is valid |
| hsmprofileid | the zone ID where the key is valid |
| keklabel | the provider-specific KEK label (admin only) |
| keybits | the key size in bits |
| name | the name of the key |
| project | the project name of the key |
| projectid | the project ID of the key |
| version | the key size in bits |
| zoneid | the zone ID where the key is valid |
| zonename | the zone name where the key is valid |