ESX Virtualization

VMware ESXi, vSphere, VMware Backup, Hyper-V... how-to, videos....

Nakivo Backup and Replication - #1 Backup solution for Virtual, physical, cloud, NAS and SaaS

Menu
  • Certification
      • VCP-DCV vSphere 8
          • vcp2024-125.
        • Close
    • Close
  • VMware
    • Configuration Maximums
    • vSphere
      • vSphere 8.0
      • vSphere 7.0
      • vSphere 6.7
      • vSphere 6.5
      • vSphere 6.0
      • Close
    • VMworld
      • VMware EXPLORE 2024
      • VMware EXPLORE 2023
      • VMware EXPLORE 2022
      • VMworld 2019
      • VMworld 2018
      • VMworld 2017
      • VMworld 2016
      • VMworld 2015
      • VMworld 2014
      • VMworld 2013
      • VMworld 2012
      • VMworld 2011
      • Close
    • Close
  • Microsoft
    • Windows Server 2012
    • Windows Server 2016
    • Windows Server 2019
    • Close
  • Categories
    • Tips – VMware, Microsoft and General IT tips and definitions, What is this?, How this works?
    • Server Virtualization – VMware ESXi, ESXi Free Hypervizor, VMware vSphere Server Virtualization, VMware Cloud and Datacenter Virtualization
    • Backup – Virtualization Backup Solutions, VMware vSphere Backup and ESXi backup solutions.
    • Desktop Virtualization – Desktop Virtualization, VMware Workstation, VMware Fusion, VMware Horizon View, tips and tutorials
    • How To – ESXi Tutorials, IT and virtualization tutorials, VMware ESXi 4.x, ESXi 5.x and VMware vSphere. VMware Workstation and other IT tutorials.
    • Free – Free virtualization utilities, ESXi Free, Monitoring and free backup utilities for ESXi and Hyper-V. Free IT tools.
    • Videos – VMware Virtualization Videos, VMware ESXi Videos, ESXi 4.x, ESXi 5.x tips and videos.
    • Home Lab
    • Reviews – Virtualization Software and reviews, Disaster and backup recovery software reviews. Virtual infrastructure monitoring software review.
    • Close
  • Partners
    • NAKIVO
    • StarWind
    • Zerto
    • Xorux
    • Close
  • This Web
    • News
    • ESXi Lab
    • About
    • Advertise
    • Archives
    • Disclaimer
    • PDFs and Books
    • Close
  • Free
  • Privacy policy

VMware API Explorer Is a Free Built-in Utility in VCSA

By Vladan SEGET | Last Updated: November 15, 2022

Shares

VMware bundles a tool along with vCenter Server Appliance (VCSA). Update: Also for Windows-based vCenter. If you have followed our blog over time you know that we have published quite a few posts about what's new within vCSA 6.5, what's has been added (Backup of vCSA DB and config, vCSA HA, but also the whole deployment process or etc…) and how to set up things. Today, however, we write about a utility VMware API Explorer which is a Built-in Utility in VCSA (and also on Windows VC).

It is kind of hidden for most folks as you have to know an exact URL to access (or you can access it from the link within the introductory page when you connect to your vCenter server). An API Explorer is now included along with VCSA (and Windows). It is preinstalled when you deploy VCSA vCenter Server within your environment.

Learning the vSphere APIs is usually out of reach for most folks, as difficult or not really appealing if you're not a developer. But it is always interesting to know what's possible to do with it, even if you can't code.

The API Explorer utility is there for connect to the API endpoint and browse and interact with available REST-based APIs and their calls, such as different parameters, settings, responses, to see the response status codes meaning and more. It is similar to Managed object browser (MOB). We have used the MOB to delete orphaned vCenter plugin in the past, remember?

The only thing you need to do is to point your browser to:

https://IP_of_VCSA/apiexplorer

to access the API Explorer utility. You'll get to a page

VMware API Explorer

Update: Thanks for Alan Renouf pointing this out. You can also access to the API explorer from the main VMware vCenter Server page. There is a link on the right-hand side.

See the image below.

Link to VMware API Explorer

What is the Login for?

You can click the login and enter SSO login and password of your VCSA. After login, you can interact with the API.

The most common APIs?

Quote from VMware blog:

  • Appliance – handles calls to the underlying VMware appliance
  • CIS – Common Infrastructure Services, handles calls involving tagging
  • Content – handles calls involves the Content Library
  • vAPI – vSphere API, handles calls regarding the API endpoint
  • vCenter – handles calls to involving the vCenter

How about some interaction?

The drop-down selection will also allow you to interact with different APIs. For each selection, you'll get different APIs depending on the role the endpoint has.

As you can see, there is a try it out button called simply “Try It Out” allowing you to test stuff. API Explorer has some other information, for example, an expected response class, different parameters or some response messages examples.

1st click – expands

2nd click – collapses

Clicking on those items expands and collapses additional information where you can read what is the particular operation for.

VMware API Explorer Utility

Wrap Up:

A built-in tool within VMware vCSA and Windows vCenter, for browsing APIs. With VMware API Explorer you can connect to the API endpoint and browse and interact with some REST-based APIs and their calls. You can check for different parameters, values or responses of each of the individual calls can be explored with details.

With the “Try it Out” button the operation is performed directly via your web browser. It gives you a lot of information.

Exploring APIs via VMware API explorer gets you started. If you're curious enough and have developing skills you might get further, learn more and get this knowledge useful within your job.

VMware API Explorer Blog post and getting started guide at VMware are here.

More from ESX Virtualization:

  • Deploy VMware VCSA 6.5 in VMware Workstation 2017 Tech Preview
  • What is VMware VMFS Locking Mechanism?
  • How to patch VMware VCSA 6.5 via ISO patch downloaded from VMware Patch Portal
  • What is VMware Enhanced vMotion Compatibility (EVC)
  • VMware Transparent Page Sharing (TPS) Explained

Stay tuned through RSS, and social media channels (Twitter, FB, YouTube)

Shares
5/5 - (1 vote)

| Filed Under: Free Stuff Tagged With: VMware API Explorer

About Vladan SEGET

This website is maintained by Vladan SEGET. Vladan is as an Independent consultant, professional blogger, vExpert x16, Veeam Vanguard x9, VCAP-DCA/DCD, ESX Virtualization site has started as a simple bookmarking site, but quickly found a large following of readers and subscribers.

Connect on: Facebook. Feel free to network via Twitter @vladan.

Private Sponsors

Featured

  • Thinking about HCI? G2, an independent tech solutions peer review platform, has published its Winter 2023 Reports on Hyperconverged Infrastructure (HCI) Solutions.
  • Zerto: One Platform for Disaster Recovery, Backup & Cloud Mobility: Try FREE Hands-On Labs Today!
Click to Become a Sponsor

Most Recent

  • FREE version of StarWind VSAN vs Trial of Full version
  • Commvault’s Innovations at RSA Conference 2025 San Francisco
  • VMware ESXi FREE is FREE again!
  • Installation of StarWind VSAN Plugin for vSphere
  • Protect Mixed environments with Nakivo Physical Machine recovery (bare metal)
  • No more FREE licenses of VMware vSphere for vExperts – What’s your options?
  • Tails – Your Private OS on USB Stick
  • StarWind V2V Converter Now has CLI
  • Veeam VHR ISO v2 – 2025 Download and Install
  • Deployment OVA and Installation of Nakivo Backup and Replication for VMware

Get new posts by email:

 

 

 

 

Support us on Ko-Fi

 

 

Buy Me a Coffee at ko-fi.com

Sponsors

Free Trials

  • DC Scope for VMware vSphere – optimization, capacity planning, and cost management. Download FREE Trial Here.
  • Augmented Inline Deduplication, Altaro VM Backup v9 For #VMware and #Hyper-V – Grab your copy now download TRIAL.

VMware Engineer Jobs

VMware Engineer Jobs

YouTube

…

Find us on Facebook

ESX Virtualization

…

Copyright © 2025 ·Dynamik-Gen · Genesis Framework · Log in