[gpfsug-discuss] accessing REST API endpoint details

[Kidger, Daniel]

Imran,

Perhaps the confusion is between the GUI itself and the Gui server?
The RestAPI can be fully accessed from the command line of any machine that can reach the URL of the GUI server.
I do this regularly using small Python scripts.

ie The GUI server provides *both*   the web based GUI and the RestAPI

What the link you posted below (using Swagger) does is provide a way to explore and learn the RestAPI from completely inside a web browser.
Definitely recommended as a teaching aid until you feel comfortable just using say ‘curl’ from the Linux command line or a short piece of Python.

To use the RestAPI, you will need the GUI server process to be running. Also remember it uses the same username/passwords for accessing both. You can create these using /usr/lpp/mmfs/gui/cli/mkuser  I strongly recommend creating a user that only has monitoring permissions for use with the RestAPI. That way you are guaranteed not to break anything from a RestAPI call.

Daniel

Daniel Kidger
HPC Storage Solutions Architect, EMEA
daniel.kidger at hpe.com<mailto:daniel.kidger at hpe.com>

+44 (0)7818 522266

hpe.com<http://www.hpe.com/>


[cid:image001.png at 01DA8CBD.7C8F88E0]

From: gpfsug-discuss <gpfsug-discuss-bounces at gpfsug.org> On Behalf Of Imam Toufique
Sent: Friday, April 12, 2024 9:06 AM
To: gpfsug-discuss at spectrumscale.org
Subject: [gpfsug-discuss] accessing REST API endpoint details

Hello,
I am looking to access the REST API endpoints , this link , https://www.ibm.com/docs/en/storage-scale/5.1.5?topic=ssma-accessing-spectrum-scale-rest-api-endpoint-details-through-swagger-api-explorer#bl1adm_accessingAPIdetails__title__2<https://www.ibm.com/docs/en/storage-scale/5.1.5?topic=ssma-accessing-spectrum-scale-rest-api-endpoint-details-through-swagger-api-explorer#bl1adm_accessingAPIdetails__title__2> , explains about a process accessing this via some GPFS GUI server.  I am not sure what that means.  I have never used any GUI server for any GPFS related setup or config or management.

Does anyone know a CLI method of accessing the REST API endpoint details.

Thanks in advance.
--IT
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://gpfsug.org/pipermail/gpfsug-discuss_gpfsug.org/attachments/20240412/6a53b177/attachment-0002.htm>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image001.png
Type: image/png
Size: 2541 bytes
Desc: image001.png
URL: <http://gpfsug.org/pipermail/gpfsug-discuss_gpfsug.org/attachments/20240412/6a53b177/attachment-0002.png>