Apache CloudStack Root Admin API Reference


upload an existing ISO into the CloudStack cloud.

Request parameters

Parameter NameDescriptionRequired
displaytextthe display text of the ISO. This is usually used for display purposes.true
formatthe format for the volume/template. Possible values include QCOW2, OVA, and VHD.true
namethe name of the ISOtrue
namethe name of the volume/templatetrue
zoneidthe ID of the zone you wish to register the ISO to.true
zoneidthe ID of the zone the volume/template is to be hosted ontrue
accountan optional accountName. Must be used with domainId.false
bootabletrue if this ISO is bootable. If not passed explicitly its assumed to be truefalse
checksumthe checksum value of this volume/template The parameter containing the checksum will be considered a MD5sum if it is not prefixed and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to use another algorithm the hexadecimal string is to be prefixed with a string of the form, "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not contain an algorithm called SHA256 or one called sha-256, only SHA-256.false
domainidan optional domainId. If the account parameter is used, domainId must also be used.false
isextractabletrue if the ISO or its derivatives are extractable; default is falsefalse
isfeaturedtrue if you want this ISO to be featuredfalse
ispublictrue if you want to register the ISO to be publicly available to all users, false otherwise.false
ostypeidthe ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passedfalse
projectidUpload volume/template for the projectfalse

Response Tags

Response NameDescription
idthe template/volume ID
expiresthe timestamp after which the signature expires
metadataencrypted data to be sent in the POST request.
postURLPOST url to upload the file to
signaturesignature to be sent in the POST request.