Swagger-UI and Postman Collection for VMware Unified Access Gateway

6 May

I aimed to perform a particular VMware Unified Access Gateway (UAG) tasks programatically. After some guidance from Mark Benson he introduced me to the Swagger-UI that is available within the product.

To access the Swagger-UI on UAG open the following URL within the browser and enter your username and password.

https://uagnameorip:9443/swagger-ui/index.html
Swagger-UI – UAG API Calls

One can do alot within the swagger-ui to make various GET, POST, PUT actions. However, my preferred tool is POSTMAN. I needed a way to figure out how to get all the swagger-ui converted to POSTMAN. Upon searching, I came across this method mentioned here.

To fetch all the swagger JSON output, go to this URL on the VMware UAG Appliance.

https://uagnameorip:9443/rest/swagger.json

We have two options here. #Option1 – copy all the data from the webpage and paste it under Postman – Import – Paste Raw Text. You will have all the VMware UAG Access Gateway Rest API listed. #Option2 – Paste the above URL into Postman – Import – Import from link (This didn’t work for me maybe authentication was required)

Postman – Import

Please find attached the POSTMAN export for the VMware Unified Access Gateway Appliance 3.9.1. (Note I believe swagger-ui was availble post UAG 3.7 onwards).

Postman – API Calls UAG

I hope you will find this post useful to start using the Swagger-UI and Postman collections to begin working with UAG appliance. My request if you further create interesting scripts or perform cool activities with UAG appliance, I hope you can share it back with me?

Thanks,
Aresh Sarkari

5 Responses to “Swagger-UI and Postman Collection for VMware Unified Access Gateway”

  1. Dan January 27, 2021 at 8:16 pm #

    Nice article Aresh. Did you test this on a UAG with multiple NIC’s (1 mgmt, and one external)? Do you know if this works with UAG’s with dual NIC’s?

  2. Dan Kahl January 27, 2021 at 8:17 pm #

    Nice article Aresh. Did you test this on a UAG with multiple NIC’s (1 mgmt, and one external)? Do you know if this works with UAG’s with dual NIC’s?

    • askaresh January 27, 2021 at 10:00 pm #

      We currently have a 1 single NIC UAG setup. I am sure it will work for dual NIC too..

      • Dan January 28, 2021 at 1:12 pm #

        Not that I’ve seen or can find online anywhere. When you configure it with multiple NIC’s on different networks I believe it disables SSH/API for the UAG’s since it’s assumed you are putting one externally (DMZ) and one internally and will have a higher level of security so as to not expose SSH/API’s externally.

      • askaresh January 31, 2021 at 10:35 pm #

        You can always enable SSH deployment during the deployment using powershell – sshEnabled=true or/else you have the option in GUI too. You can enable it to perform maintenance and once done disable it.
        There is nothing for API.. Its enabled by default and its has no reliance on SSH.

Leave a Reply to Dan Cancel reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

%d bloggers like this: