Apache CloudStack 4.23.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, s390x | 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 Instance 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 |
| forcks | if true, the templates would be available for deploying CKS clusters | false |
| isdynamicallyscalable | True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance 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 |
| templatetype | the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only). | 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. |