Apache CloudStack 4.21.0.0 Root Admin API Reference

updateCustomAction

Update the custom action

Request parameters

Parameter NameDescriptionRequired
idID of the custom actiontrue
allowedroletypesList of role types allowed for the actionfalse
cleanupdetailsOptional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this action, details field ignored; if false or not set, no action)false
cleanupparametersOptional boolean field, which indicates if parameters should be cleaned up or not (If set to true, parameters will be removed for this action, parameters field ignored; if false or not set, no action)false
descriptionThe description of the commandfalse
detailsDetails in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0false
enabledWhether the action is enabled or notfalse
errormessageError message that will be used on failure during execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Failed to complete {{actionName}} for {{extensionNamefalse
parametersParameters mapping for the action using keys - name, type, required. 'name' is mandatory. If 'type' is not specified then STRING will be used. If 'required' is not specified then false will be used. Example: parameters[0].name=xxx&parameters[0].type=BOOLEAN&parameters[0].required=truefalse
resourcetypeType of the resource for actionsfalse
successmessageSuccess message that will be used on successful execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Successfully complete {{actionName}} for {{extensionNamefalse
timeoutSpecifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 secondsfalse

Response Tags

Response NameDescription
displaytextany text associated with the success or failure
successtrue if operation is executed successfully