CloudStack v2.2.13 - 2.2.14 Root Admin API Reference

listTemplates

List all public, private, and privileged templates.

Request parameters

Parameter NameDescriptionRequired
templatefilterpossible values are "featured", "self", "self-executable", "executable", and "community".* featured-templates that are featured and are public* self-templates that have been registered/created by the owner* selfexecutable-templates that have been registered/created by the owner that can be used to deploy a new VM* executable-all templates that can be used to deploy a new VM* community-templates that are public.true
hypervisorthe hypervisor for which to restrict the searchfalse
idthe template IDfalse
namethe template namefalse
projectidlist firewall rules by projectfalse
zoneidlist templates by zoneIdfalse

Response Tags

Response NameDescription
idthe template ID
accountthe account name to which the template belongs
accountidthe account id to which the template belongs
bootabletrue if the ISO is bootable, false otherwise
checksumchecksum of the template
createdthe date this template was created
crossZonestrue if the template is managed across all Zones, false otherwise
detailsadditional key/value details tied with template
displaytextthe template display text
domainthe name of the domain to which the template belongs
domainidthe ID of the domain to which the template belongs
formatthe format of the template.
hostidthe ID of the secondary storage host for the template
hostnamethe name of the secondary storage host for the template
hypervisorthe hypervisor on which the template runs
isextractabletrue if the template is extractable, false otherwise
isfeaturedtrue if this template is a featured template, false otherwise
ispublictrue if this template is a public template, false otherwise
isreadytrue if the template is ready to be deployed from, false otherwise.
namethe template name
ostypeidthe ID of the OS type for this template.
ostypenamethe name of the OS type for this template.
passwordenabledtrue if the reset password feature is enabled, false otherwise
projectthe project name of the template
projectidthe project id of the template
removedthe date this template was removed
sizethe size of the template
sourcetemplateidthe template ID of the parent template if present
statusthe status of the template
templatetagthe tag of this template
templatetypethe type of the template
zoneidthe ID of the zone for this template
zonenamethe name of the zone for this template