Apache CloudStack 4.15.0.0 Root Admin API Reference
listTemplates
List all public, private, and privileged templates.
Request parameters
| Parameter Name | Description | Required |
| templatefilter | possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : templates that have been marked as featured and public. * self : templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns templates that can be used to deploy a new VM. * sharedexecutable : templates ready to be deployed that have been granted to the calling user by another user. * executable : templates that are owned by the calling user, or public templates, that can be used to deploy a VM. * community : templates that have been marked as public but not featured. * all : all templates (only usable by admins). | true |
| account | list resources by account. Must be used with the domainId parameter. | false |
| details | comma separated list of template details requested, value can be a list of [ all, min] | false |
| domainid | list only resources belonging to the domain specified | false |
| hypervisor | the hypervisor for which to restrict the search | false |
| id | the template ID | false |
| ids | the IDs of the templates, mutually exclusive with id | false |
| isrecursive | defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves. | false |
| keyword | List by keyword | false |
| listall | If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false | false |
| name | the template name | false |
| page | false | |
| pagesize | false | |
| parenttemplateid | list datadisk templates by parent template id | false |
| projectid | list objects by project | false |
| showremoved | show removed templates as well | false |
| showunique | If set to true, list only unique templates across zones | false |
| tags | List resources by tags (key/value pairs) | false |
| zoneid | list templates by zoneId | false |
Response Tags
| Response Name | Description |
| id | the template ID |
| account | the account name to which the template belongs |
| accountid | the account id to which the template belongs |
| bits | the processor bit size |
| bootable | true if the ISO is bootable, false otherwise |
| checksum | checksum of the template |
| childtemplates | if root disk template, then ids of the datas disk templates this template owns |
| created | the date this template was created |
| crossZones | true if the template is managed across all Zones, false otherwise |
| deployasis | VMware only: true if template is deployed without orchestrating disks and networks but "as-is" defined in the template. |
| deployasisdetails | VMware only: additional key/value details tied with deploy-as-is template |
| details | additional key/value details tied with template |
| directdownload | KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage |
| displaytext | the template display text |
| domain | the name of the domain to which the template belongs |
| domainid | the ID of the domain to which the template belongs |
| downloaddetails | Lists the download progress of a template across all secondary storages |
| format | the format of the template. |
| hostid | the ID of the secondary storage host for the template |
| hostname | the name of the secondary storage host for the template |
| hypervisor | the hypervisor on which the template runs |
| isdynamicallyscalable | true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory |
| isextractable | true if the template is extractable, false otherwise |
| isfeatured | true if this template is a featured template, false otherwise |
| ispublic | true if this template is a public template, false otherwise |
| isready | true if the template is ready to be deployed from, false otherwise. |
| name | the template name |
| ostypeid | the ID of the OS type for this template. |
| ostypename | the name of the OS type for this template. |
| parenttemplateid | if Datadisk template, then id of the root disk template this template belongs to |
| passwordenabled | true if the reset password feature is enabled, false otherwise |
| physicalsize | the physical size of the template |
| project | the project name of the template |
| projectid | the project id of the template |
| removed | the date this template was removed |
| requireshvm | true if template requires HVM enabled, false otherwise |
| size | the size of the template |
| sourcetemplateid | the template ID of the parent template if present |
| sshkeyenabled | true if template is sshkey enabled, false otherwise |
| status | the status of the template |
| templatetag | the tag of this template |
| templatetype | the type of the template |
| url | the URL which the template/iso is registered from |
| zoneid | the ID of the zone for this template |
| zonename | the name of the zone for this template |
| jobid | the ID of the latest async job acting on this object |
| jobstatus | the current status of the latest async job acting on this object |