Apache CloudStack 4.23.0.0 Root Admin API Reference

updateKMSKey

Updates KMS key name, description, or enabled status

Request parameters

Parameter NameDescriptionRequired
idThe UUID of the KMS key to updatetrue
descriptionNew description for the keyfalse
enabledwhether the key should be enabledfalse
nameNew name for the keyfalse

Response Tags

Response NameDescription
idthe UUID of the key
accountthe account owning the key
accountidthe account ID owning the key
algorithmthe encryption algorithm
createdthe creation timestamp
descriptionthe description of the key
domainthe domain name of the key
domainidthe domain ID of the key
domainpaththe domain path of the key
enabledwhether the key is enabled
hsmprofilethe zone name where the key is valid
hsmprofileidthe zone ID where the key is valid
keklabelthe provider-specific KEK label (admin only)
keybitsthe key size in bits
namethe name of the key
projectthe project name of the key
projectidthe project ID of the key
versionthe key size in bits
zoneidthe zone ID where the key is valid
zonenamethe zone name where the key is valid