Page History

...

• Request
  • name: the name of the template : required
    
  • format: the format of the template to be uploaded. Possible values for template include QCOW2, RAW and VHD : required
    
  • zoneid: the UUID of the zone the template is associated to : required
  • displaytext: the display text of the template. This is used for setting a suitable name for display purposes. : required
  • hypervisor: the target hypervisor for the template : required
  • ostypeid: the UUID of the OS type that best represents the OS of this template : required
  • checksum: the MD5 checksum of template to be uploaded. If specified this is used to validate the content of the uploaded template for integrity.
  • account: an optional account name. Must be used with 'domainid' parameter below. Defaulted to account name of caller if not specified.
  • domainid: an optional domain to which the account belongs. If the account parameter is used, 'domainid' must also be used. Defaulted to domain of the caller if not specified.
  • projectid: the UUID of the project if the template needs to be associated with one
  • bits: specifies if template supports 32 or 64 bit. Default is 64 bit.
  • details: additional template details in key/value pairs
  • isdynamicallyscalable: true if template contains XS/VMWare tools in order to support dynamic scaling of VM cpu/memory
  • isextractable: true if the template or its derivatives are extractable. Default is false
  • isfeatured: true if the template is a featured template. Default is false. : admin only
  • ispublic: true if the template is available to all users. Default is true. Regular users are allowed to create public templates based on global config 'allow.public.user.templates'
  • isrouting: true if the template type is routing i.e. if template is used to deploy router : admin only
  • passwordenabled: true if the template supports the password reset feature. Default is false.
  • requireshvm: true if this template requires hardware assisted virtualization support
  • sshkeyenabled: true if the template supports the sshkey upload feature. Default is false.
  • templatetag: the tag for this template. Used to deploy VMs on hosts with this tag. : admin only

• Response
  • uuidid: Unique UUID to identify the template. This is used to query the status of template after successful completion of upload
  • postURL: POST url to upload the file to; for e.g. "https://1-2-3-4.xyz.com/upload/uuid", where 1-2-3-4 is derived from SSVM public IP 1.2.3.4, and xyz.com is the domain name registered with Cloudstack. For more details refer to section "POST URL" below.
  • metadata: encrypted data to be sent in the POST request. This is used to transfer some internal meta-data required for upload
  • expires: the timestamp after which the signature expires
  • signature: signature is SHA1 key generated using PSK based on 'postURL', 'metadata' and 'expires' in the response. This is used to validate that the actual POST request to upload data is a genuine one

...

{ 
postURL:https://1-2-3-4.xyz.com/upload/C7D351D2-F167-4CC8-A9FF-3BECB0A625C4,
metadata:TKPFeuz2nHmE/kcREEu24mnj1MrLdzOeJIHXR9HLIGgk56bkRJHaD0RRL2lds1rKKhrro4/PuleEh4YhRinhxaAmPpU4e55eprG8gTCX0ItyFAtlZViVdKXMew5Dfp4Qg8W9I1/IsDJd2Kas9/ftDQLiemAlPt0uS7Ou6asOCpifnBaKvhM4UGEjHSnni1KhBzjgEyDW3Y42HKJSSv58Sgmxl9LCewBX8vtn9tXKr+j4afj7Jlh7DFhyo9HOPC5ogR4hPBKqP7xF9tHxAyq6YqfBzsng3Xwe+Pb8TU1kFHg1l2DM4tY6ooW2h8lOhWUkrJu4hOAOeTeRtCjW3H452NKoeA1M8pKWuqMo5zRMti2u2hNZs0YY2yOy8oWMMG+lG0hvIlajqEU=,
signature:de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9,
expires: 2014-10-17T12:00:00+0530,
uuidid:C7D351D2-F167-4CC8-A9FF-3BECB0A625C4
}

...

{ 
postURL:https://1-2-3-4.xyz.com/upload/DD0A9FC6-C17E-4180-963C-870B9D03A80A,
metadata:TKPFeuz2nHmE/kcREEu24mnj1MrLdzOeJIHXR9HLIGgk56bkRJHaD0RRL2lds1rKKhrro4/PuleEh4YhRinhxaAmPpU4e55eprG8gTCX0ItyFAtlZViVdKXMew5Dfp4Qg8W9I1/IsDJd2Kas9/ftDQLiemAlPt0uS7Ou6asOCpifnBaKvhM4UGEjHSnni1KhBzjgEyDW3Y42HKJSSv58Sgmxl9LCewBX8vtn9tXKr+j4afj7Jlh7DFhyo9HOPC5ogR4hPBKqP7xF9tHxAyq6YqfBzsng3Xwe+Pb8TU1kFHg1l2DM4tY6ooW2h8lOhWUkrJu4hOAOeTeRtCjW3H452NKoeA1M8pKWuqMo5zRMti2u2hNZs0YY2yOy8oWMMG+lG0hvIlajqEU=,
signature:de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9,
expires: 2014-10-17T12:00:00+0530,
uuidid:DD0A9FC6-C17E-4180-963C-870B9D03A80A
}

...