Apache CloudStack 4.20.0.0 Root Admin API Reference
getUploadParamsForTemplate
upload an existing template into the CloudStack cloud.
Request parameters
| Parameter Name | Description | Required |
| format | the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD. | true |
| hypervisor | the target hypervisor for the template | true |
| name | the name of the volume/template/iso | true |
| zoneid | the ID of the zone the volume/template/iso is to be hosted on | true |
| account | an optional accountName. Must be used with domainId. | false |
| arch | the CPU arch of the template. Valid options are: x86_64, aarch64 | false |
| bits | 32 or 64 bits support. 64 by default | false |
| checksum | the checksum value of this volume/template/iso 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 |
| deployasis | (VMware only) true if VM deployments should preserve all the configurations defined for this template | false |
| details | Template details in key/value pairs. | false |
| displaytext | the display text of the template. This is usually used for display purposes. | false |
| domainid | an optional domainId. If the account parameter is used, domainId must also be used. | false |
| isdynamicallyscalable | true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory | false |
| isextractable | true if the template or its derivatives are extractable; default is false | false |
| isfeatured | true if this template is a featured template, false otherwise | false |
| ispublic | true if the template is available to all accounts; default is true | false |
| isrouting | true if the template type is routing i.e., if template is used to deploy router | false |
| ostypeid | the ID of the OS Type that best represents the OS of this template. Not required for VMware as the guest OS is obtained from the OVF file. | false |
| passwordenabled | true if the template supports the password reset feature; default is false | false |
| projectid | Upload volume/template/iso for the project | false |
| requireshvm | true if this template requires HVM | false |
| sshkeyenabled | true if the template supports the sshkey upload feature; default is false | false |
| templatetag | the tag for this template. | false |
Response Tags
| Response Name | Description |
| id | the template/volume ID |
| expires | the timestamp after which the signature expires |
| metadata | encrypted data to be sent in the POST request. |
| postURL | POST url to upload the file to |
| signature | signature to be sent in the POST request. |