Apache CloudStack 4.23.0.0 Root Admin API Reference
listKMSKeys
Lists KMS keys available to the caller
Request parameters
| Parameter Name | Description | Required |
| account | List resources by Account. Must be used with the domainId parameter. | false |
| domainid | List only resources belonging to the domain specified | false |
| enabled | Filter by enabled status | false |
| hsmprofileid | Filter by HSM profile ID | false |
| id | List KMS key by UUID | false |
| isrecursive | Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| keyword | List by keyword | false |
| listall | If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter. | false |
| page | false | |
| pagesize | false | |
| projectid | List objects by project; if projectid=-1 lists All Instances | false |
| zoneid | Filter by zone ID | 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 |