Skip to main content

NSphere REST API Guide

A complete HTTP API reference for the NSphere virtualization platform, for developers and integrators.

11 modules grouped by business domain:

  • Operation log, alarm, task
  • Data center, cluster, host
  • VM, VM template, vSwitch
  • Storage management
  • Platform resource statistics

API conventions​

  • Protocol: HTTPS
  • Authentication: see the API authentication section in the NSphere deployment documentation
  • Data format: application/json / application/x-www-form-urlencoded
  • Version: this document targets NSphere E0930

Where to start​

  • Call your first API: Cluster → List clusters
  • Browse by module: use the left sidebar
  • Search for a specific field: use the search box at the top right
note

This site is auto-generated from the Swagger documentation provided by the NSphere team. If you find a missing or incorrect field, please open an issue on GitLab.