![](https://www.dell.com/community/assets/105/d65f3d64-ec8c-49e3-9227-adbf636f80c4-1744605839.webp)
Wyse Management Suite
Troubleshooting for Dell Software
Posts
Unsolved
4 Posts
0
1626
January 27th, 2021 12:00
External App Services - API
Hi Guys,
Has any been able to find documentation on WMS External App Services - API? Under portal Admin area.
Responses(7)
No Events found!
mdmann
11 Posts
0
June 18th, 2021 18:00
No. I've been looking for the same.
buffalobound
3 Apprentice
3 Apprentice
•
730 Posts
0
June 21st, 2021 05:00
The Admin guide for WMS contains a link to the API marketplace for documentation.
https://api-marketplace.dell.com/#/overview-doc/3788/7928/docs/Overview.md
#Iwork4Dell
mdmann
11 Posts
0
December 12th, 2021 21:00
Thanks for this link. I'm thinking I am still missing something important. The document states in the Prerequisites section:
"API support is included only for on-premise environment of Wyse Management Suite with a pro license.
The API feature must be enabled by the administrator in the Wyse Management Suite user interface. To enable the feature, do the following:
1) Log in as an administrator.
2) Go to Portal Administration > Other Settings.
3) Select the Enable WMS API check-box.
4) Click Save Settings."
We have the PRO license, and I am an administrator for WMS, but we don't get the "Enable WMS API" option in "Portal Administration -> Other Settings." We are currently on version 3.1.1 580, and we have not had this option for any previous version, either. Am I missing something?
EDIT: Is it available only in version 3.2 and above?
buffalobound
3 Apprentice
3 Apprentice
•
730 Posts
1
December 13th, 2021 05:00
Correct. The API for on-premises was introduced in 3.2. 3.5 (recently released) introduced additional queries supported, and cloud API support but it must be requested to be turned on via support.
mdmann
11 Posts
0
March 20th, 2022 22:00
Thanks for the response, buffalobound. So, we are running WMS 3.3.1 on-prem, and I finally see the "Enable WMS API" checkbox in Portal Administration. It still is not clear from the documentation indicated above how to use this. I get the feeling that there is some additional configuration that must be done on the server. One thing which confuses me is that I can add an External App Service as a global administrator, generating an API key and secret, but I can never activate it as the "Activate" button is always greyed out. Moreover, the documentation doesn't indicate anywhere what one is supposed to do from this point. My thought was that I am supposed to create my app with that name and authenticate it using the key and secret, but It's not evident how one is to do that. I looked at an example python script which authenticates to the server and requests information about the managed resources, but I can't get that script to execute...I get a response from the server that Swagger-UI has not been provided an API definition. There just seems to be a chuck of critical information missing in the documentation. Are you using the External App Services, or know of anyone who has?
buffalobound
3 Apprentice
3 Apprentice
•
730 Posts
1
March 21st, 2022 05:00
@mdmann There were some major changes in the WMI setup beginning in 3.5. Since you are on 3.3.1 I would highly encourage you to upgrade to the latest version to base your testing on. I do not see the "External API Setup" section in 3..6, and I dont believe it is used any longer. There is a forthcoming release, WMS 3.6.1 which I would suggest using as your base for upgrading as it addresses many of the upgrade challenges customers have been seeing. I dont have the exact posting date, but my gut says by 4/10
The best reference for structuring your scripting/application is available in the API library at
https://api-marketplace.dell.com/#/overview-doc/3788/14428/docs/Overview.md
***Keep in mind, the page above won't load until you login to the site.
i am not aware of a public repository of examples customers have used, but if I come across one I will link to it here.
mdmann
11 Posts
0
March 21st, 2022 15:00
Aloha buffalobound,
That reference material you pointed me to is what I have been looking at. There just seems to be something missing or something I am overlooking.
We aren't quite ready to upgrade to 3.5, as we have several older model thin clients in our system. We are in the process of upgrading these. I was hopeful that by at least getting to 3.3.1, I would be able to start investigating what we might do with the API. If you do come across any additional information, I would appreciate a pointer.
There are three hyperlinks in that documentation which don't seem to work (404 Error). They are in regards to the Redfish API and OEM schemas:
https://www.dmtf.org/standards/redfish
https://downloads.dell.com/redfish/bmc/schemas/
https://www.dell.com/support/article/sln310624