Cosmic Admin API Reference

listGuestOsMapping

Lists all available OS mappings for given hypervisor

Request parameters

Parameter NameDescriptionRequired
hypervisorlist Guest OS mapping by hypervisorfalse
hypervisorversionlist Guest OS mapping by hypervisor version. Must be used with hypervisor parameterfalse
idlist mapping by its UUIDfalse
keywordList by keywordfalse
ostypeidlist mapping by Guest OS Type UUIDfalse
pagefalse
pagesizefalse

Response Tags

Response NameDescription
idthe ID of the Guest OS mapping
hypervisorthe hypervisor
hypervisorversionversion of the hypervisor for mapping
isuserdefinedis the mapping user defined
osdisplaynamestandard display name for the Guest OS
osnameforhypervisorhypervisor specific name for the Guest OS
ostypeidthe ID of the Guest OS type