Apache CloudStack v4.1.0 User API Reference


Lists projects and provides detailed information for listed projects

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
displaytextlist projects by display textfalse
domainidlist only resources belonging to the domain specifiedfalse
idlist projects by project IDfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf 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 falsefalse
namelist projects by namefalse
statelist projects by statefalse
tagsList projects by tags (key/value pairs)false

Response Tags

Response NameDescription
idthe id of the project
accountthe account name of the project's owner
displaytextthe displaytext of the project
domainthe domain name where the project belongs to
domainidthe domain id the project belongs to
namethe name of the project
statethe state of the project
tags(*)the list of resource tags associated with vm
accountthe account associated with the tag
customercustomer associated with the tag
domainthe domain associated with the tag
domainidthe ID of the domain associated with the tag
keytag key name
projectthe project name where tag belongs to
projectidthe project id the tag belongs to
resourceidid of the resource
resourcetyperesource type
valuetag value