Loading

×Sorry to interrupt
This page has an error. You might just need to refresh it.
[NoErrorObjectAvailable] Uncaught ReferenceError: addCTracking is not defined
Failing descriptor: {markup://c:KM_ArticleThemeLayout}

Refresh

Cookie Preference Center

General Information on cookies

When you visit our website, we use cookies to ensure that we give you the best experience. This information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies by clicking on the different category headings to find out more and change your settings. However, blocking some types of cookies may impact your experience on the site and the services we are able to offer. Further information can be found in our

Cookie Policy.

Strictly Necessary

Strictly Necessary

Always Active

Strictly Necessary

Strictly necessary cookies are always enabled since they are essential for our website to function. They enable core functionality such as security, network management, and website accessibility. You can set your browser to block or alert you about these cookies, but this may affect how the website functions. For more information please visit www.aboutcookies.org or www.allaboutcookies.org.

Cookie Details‎

Performance

Performance

Performance

Performance cookies are used to analyze the user experience to improve our website by collecting and reporting information on how you use it. They allow us to know which pages are the most and least popular, see how visitors move around the site, optimize our website and make it easier to navigate.

Cookie Details‎

Please confirm your settings by refreshing the page.

Functional

Functional

Functional

Functional cookies help us keep track of your past browsing choices so we can improve usability and customize your experience. These cookies enable the website to remember your preferred settings, language preferences, location and other customizable elements such as font or text size. If you do not allow these cookies, then some or all of these services may not function properly.

Cookie Details‎

Advertising

Advertising

Advertising

Advertising cookies are used to send you relevant advertising and promotional information. They may be set through our site by third parties to build a profile of your interests and show you relevant advertisements on other sites. These cookies do not directly store personal information, but their function is based on uniquely identifying your browser and internet device.

Cookie Details‎

Advertising Cookies

Consent Leg.Interest

Select All Vendors

Select All Vendors

Select All Hosts

Select All

Clear Filters

Information storage and access

Apply

Confirm My Choices Reject All Allow All

My Subscriptions

Loading

Knowledge Base

Configure POSTMAN for REST API Calls with NSX V (54016)

Last Updated: 3/12/2021Categories: How toTotal Views: 8040Language:
English

1 like this article

Subscribe to get an email
newsletter with new updates

1 people found this helpful Please provide article feedback:

Symptoms

Customer may need to run RESTful API calls against NSX Manager but not have a RESTful client set up. This KB aims to assist in setting up POSTMAN in a customer environment and test proper configuration

Purpose

Empower customer to run RESTful API calls like those mentioned in:

https://docs.vmware.com/en/VMware-NSX-for-vSphere/6.2/nsx_62_api.pdf

https://docs.vmware.com/en/VMware-NSX-for-vSphere/6.3/nsx_63_api.pdf

https://docs.vmware.com/en/VMware-NSX-for-vSphere/6.4/nsx_64_api.pdf

Impact / Risks

API calls to the NSX Manager are commits just like GUI configuration changes.

GET commands retrieve information

POST commands create new content

PUT overwrites content

DELETE removes content

Resolution

Visit getpostman.com

(Note that we want to install the full application, not the Chrome plugin, as it has some settings we'll want to adjust)

Select "Download the App"

Choose your platform and select "Download"

Once the file has downloaded, run the exe

On first startup, POSTMAN will offer a sign up page. You can either sign up, or below, you can select "Take me straight to the app. I'll create an account another time."

Under the Authorization tab,

Select "Basic Auth" from the Type dropdown box

Next to that, put in the Username and Password for the NSX Manager

Note: Username is almost always "admin"

Under the Headers tab,

We'll add a new Key with a specific Value

Under Key, begin typing "Content-Type" and select it from the dropdown

Under Value, type "application/xml" and select that value from the options

In the top right of the application is a Wrench symbol, click that

Select "Settings" from the drop down

A new window will open, click on the "General" tab

Find the "SSL certificate verification" and toggle this to "OFF"

Close the Setting Window with the X at the top right

Now we'll test API calls to the NSX environment to make sure everything is set up correctly

In the URL bar next to the "GET" type the following:

https://<NSX-Manager-IP-Address>/api/2.0/vdn/controller

Make sure to replace the <NSX-Manager-IP-Address> with the actual IP Address or FQDN of the NSX Manager

This command retrieves details and runtimes of all controllers in the environment. This should provide output if the environment has controllers or not, and is safe to run during production hours.

Expected output should look something like this:

Responses:

Status Code: 200

Body: application/xml

<controllers>

<controller>

<id></id>

<name></name>

<description></description>

<ipAddress></ipAddress>

<status></status>

</controller>

</controllers>

If this GET command returns valued, REST API is configured correctly and can be used for further REST API calls.

Detectable by VMware SkylineTM

Actions

Copy

link to clipboard
copied!

Print

Language:
English

Attachments

Additional Resources

KB
•
End Of General Availability of the Free vSphere Hypervisor (ESXi 7.x and 8.x) (2107518)

KB
•
Download and Install VMware Fusion (2014097)

Results 1-2 of 2

Ask The Community

Get answers quickly from VMware experts in the community

Post Subject

CONTINUE IN COMMUNITIES

Related Products:

VMware NSX for vSphere

VMware NSX Data Center for vSphere

Related Versions:

VMware NSX for vSphere 6.2.x

VMware NSX Data Center for vSphere 6.4.x

Take Our Survey

Support Assistant