Apache CloudStack 4.23.0.0 Root Admin API Reference

rotateKMSKey

Rotates KMS key (KEK) by creating new version and scheduling gradual re-encryption

Request parameters

Parameter NameDescriptionRequired
idKMS Key UUID to rotatetrue
hsmprofileidThe target HSM profile ID for the new KEK version. If provided, migrates the key to this HSM.false
keybitsKey size for new KEK (default: same as current)false

Response Tags

Response NameDescription
accountThe Account that executed the async command
accountidThe Account ID that executed the async command
cmdThe async command executed
completedThe completed date of the job
createdThe created date of the job
domainidThe domain ID that executed the async command
domainpathThe domain that executed the async command
jobinstanceidThe unique ID of the Instance/entity object related to the job
jobinstancetypeThe Instance/entity object related to the job
jobprocstatusThe progress information of the PENDING job
jobresultThe result reason
jobresultcodeThe result code for the job
jobresulttypeThe result type
managementserveridThe MSID of the management server on which the job is running
managementservernamethe management server name of the host
useridThe User that executed the async command
jobidthe ID of the async job