VMware Horizon Community
BBittner
Enthusiast
Enthusiast
Jump to solution

Horizon 7 REST API documentation

Hi,

since the newAdmin-Interface is running pure HTML and REST, I'm looking for any documentation for that REST-API.

At the moment the VMware API Explorer does not list details for it, just for the classical/PowerShell API.

(Or at least I can't find it)

So is there anywhere a documentation for it?

Tags (2)
1 Solution

Accepted Solutions
sjesse
Leadership
Leadership
Jump to solution

I'll put it this way, there isn't a published rest api reference otherwise the person from VMware that commented would have shared that. I've looked for it before and it wouldn't work. Once they release the newadmin interface that may change, but its the same issue with appvolumes there is an undocumented rest api, but they never officially release it and it requires following an unofficial reference and experimentation.

---------------------------------------------------------------------------------------------------------

Was it helpful? Let us know by completing this short survey here.

View solution in original post

Reply
0 Kudos
11 Replies
vJoeG
VMware Employee
VMware Employee
Jump to solution

You might want to cross-post this to the Powercli board.

Does this help?

https://code.vmware.com/apis/445/view

------------------
Joe Graziano
Senior Solution Engineer - EUC Federal
VCP7-DTM, VCP6-DM, VCP6-DCV
vExpert, vExpertPro
jgraziano@vmware.com
Reply
0 Kudos
BBittner
Enthusiast
Enthusiast
Jump to solution

Thanks for the Link, but that's the one I mentioned in my first post.

As far as I can see it, there are no information about the REST-API in it.

So I'm not sure if it helps to cross-post this to the PowerCLI-board, because it is not the REST-Board - But I can try it there...

Reply
0 Kudos
mchadwick19
Hot Shot
Hot Shot
Jump to solution

What are you trying to look at?

The API explorer provides all the query, methods, and possible data types that are available when accessing the View API.

The (more recent) View PowerCLI modules are all written using View API queries and methods behind the scenes.

Another good place to look is the VMware github, specifically the Horizon.Hv.Helper piece is awesome for View admins.

VDI Engineer VCP-DCV, VCP7-DTM, VCAP7-DTM Design
BBittner
Enthusiast
Enthusiast
Jump to solution

I'm looking for the documentation for the HTTP REST API.

URL would be something like https://<Connection-Server>/view-vlsi/rest/v1/

I want to use automation or monitoring via basic tools like curl.

I don't know what API/interface the PowerCLI is using, but also, I can't find details on it.

Reply
0 Kudos
sjesse
Leadership
Leadership
Jump to solution

Other then the link mentioned earlier there really isn't much out there directly.  You can find most of these by google but a few references I've used are

Horizon View API - The SLOG - SimonLong/Blog - The SLOG – SimonLong/Blog

https://www.retouw.nl/vexpert/horizon-view-apis-back-to-basics-part-1-connecting/

these generally have enough to get you started in what you need, but for the most part looking at and being able to read the api documentation directly will help

Reply
0 Kudos
sjesse
Leadership
Leadership
Jump to solution

There isn't a rest api, only the powercli commands though, but they aren't like the older ones. The hv.helper ones are trying to replicate that.

Reply
0 Kudos
BBittner
Enthusiast
Enthusiast
Jump to solution

Thanks for your feedback/help, but I don't have powershell on the system where I need to access Horizon automatically.

Also, there is a REST API for sure!

I can see it in my browser-request when using the "newadmin" interface which is HTML based (not the Flash-App!) - I guess they added it together with the new web-html-gui.

BTW: the URL has also the name "REST" in it Smiley Wink

EDIT: At least Version 7.5 and newer has a REST-API

Reply
0 Kudos
sjesse
Leadership
Leadership
Jump to solution

I'll put it this way, there isn't a published rest api reference otherwise the person from VMware that commented would have shared that. I've looked for it before and it wouldn't work. Once they release the newadmin interface that may change, but its the same issue with appvolumes there is an undocumented rest api, but they never officially release it and it requires following an unofficial reference and experimentation.

---------------------------------------------------------------------------------------------------------

Was it helpful? Let us know by completing this short survey here.

Reply
0 Kudos
sjesse
Leadership
Leadership
Jump to solution

oh if anyone tries, the last time I tried the horizon powercli commands didn't' work on Linux, but hopefully that changes.

BBittner
Enthusiast
Enthusiast
Jump to solution

Thanks for this clarification, so I/we have to wait for the official release of the REST API.

Till then I try to use what I have, thanks to everybody for their contributions!

Reply
0 Kudos
chrisdhalstead
VMware Employee
VMware Employee
Jump to solution

Just to follow up - there has been a supported REST API for Horizon since 7.10

It is documented here:  VMware Horizon Server API - VMware API Explorer - VMware {code}

I also maintain Postman collections for the REST API since 7.10 which are available here:  GitHub - chrisdhalstead/vmware-horizon7-postman: Postman Collection for VMware Horizon 7 REST API 

Chris Halstead
Senior Staff Architect, EUC Technical Marketing
chalstead@vmware.com
Twitter: @chrisdhalstead