This repository holds the API specifications for the VMware VCF products.
VCF 9.1 provides officially supported ready to use VCF component SDK modules for Java and Python developers. All packages are available at Maven Central and PyPI except for the VCF real-time metrics component. A detailed getting started guideline, including code samples demonstrating the API usage, can be found in the respective repository: vcf-java-sdk-samples and vcf-python-sdk-samples.
Developers who use other programming languages, as well as Java/Python developers whose needs are not fulfilled by the Broadcom provided SDK, available at Maven Central/PyPI, can use the API definitions located in the specifications folder to manually generate stubs. The scripts folder contains example build scripts for WSDL-defined APIs, which emit bindings for a particular language. Please note that Broadcom cannot guarantee compatibility of generated stubs or seamless integration of API definitions with third-party technologies.
The API specifications are published for the following VCF components:
| VCF Component | Specification Type |
|---|---|
| vSphere | WSDL, OpenAPI ** |
| NSX | OpenAPI # |
| SDDC Manager | OpenAPI |
| VCF Installer | OpenAPI |
| VSAN Data protection | OpenAPI |
| VCF Fleet lifecycle | OpenAPI |
| VCF SDDC lifecycle | OpenAPI |
| VCF Operations | OpenAPI |
| VCF Operations for networks | OpenAPI |
| VCF Log Management | OpenAPI |
| VCF Real-time metrics | OpenAPI |
Note:
** The /specifications/vsphere/openapi contains REST and VI JSON (REST like) API specifications which are in the /automation and /vi-json folders respectively.
# The /specifications/nsx are OpenAPI 2.0 based unlike other VCF components which are based on OpenAPI 3.0
For community support, please start a Discussion.
Please note that the build scripts in /scripts folder is not officially supported. It's only for the reference purposes.