Configure Postman for NSX REST API Requests

Products

• VMware NSX

Issue/Introduction

NSX administrators may need to interact with the NSX API for automation, bulk configuration changes, or to retrieve detailed system information that is not fully visible in the UI.  API clients such as Postman are often used for this purpose.  

This article provides Postman configuration steps to ensure successful communication with NSX Manager.

Environment

VMware NSX

Resolution

1. Download and install Postman from https://www.postman.com/downloads/.
   
   
2. Provide Postman with NSX Manager authentication details:
   
   • Authorization Tab > Select Type 'Basic Auth'   
     (Enter a relevant NSX Manager username and password)
     
     
     
3. Set required Headers:
   
   • Headers Tab > Key is 'Content-Type' and Value is 'application/json'   
     (NSX Manager expects API requests and responses to be encoded in JSON)
     
     
     
     
4. Disable SSL Certificate Verification if necessary:
   
   • Settings (gear icon in the top right) > General > Toggle SSL Certificate Verification to Off
     (To allow connections to NSX Managers using self-signed certificates)

 

5. Execute a Functional Test:

• • Set the method to GET.
  • Enter and example API call:  https://<NSX Manager IP or FQDN>/api/v1/cluster
  • Click Send
    (You should receive a 200 OK status response and a JSON body containing the API response data)
    

Additional Information

NSX API Guide

NSX API Usage

Troubleshooting NSX API Calls