vCloud API Programming Guide for Service Providers
This edition of the vCloud API Programming Guide for Service Providers provides information about version 32.0 of the vCloud API.
VMware provides many different APIs and SDKs for applications and goals. This guide provides information about the vCloud API for developers who are interested in creating RESTful clients of VMware vCloud Director.
Accelerated API Deprecation
Due to removal of their functions, the following APIs are under accelerated deprecation and vCloud Director 9.7 is the last version in which they are present.
| Operation | Description |
|---|---|
| POST /admin/org/{orgId}/role/{id}/action/relinkToTemplate | Relink a role to the template specified by its defaultRoleId. |
| POST /admin/org/{orgId}/role/{id}/action/unlinkFromTemplate | Unlink a role from the template specified by its defaultRoleId. |
| POST /admin/role/{id}/action/relinkToTemplate | Relink a role to the template specified by its defaultRoleId. |
| POST /admin/role/{id}/action/unlinkFromTemplate | Unlink a role from the template specified by its defaultRoleId. |
| Operation | Description |
|---|---|
| POST /admin/extension/host/{id}/action/disable | Disable a host. |
| POST /admin/extension/host/{id}/action/enable | Enable a host. |
| POST /admin/extension/host/{id}/action/prepare | Prepare a host. |
| POST /admin/extension/host/{id}/action/repair | Repair a host. |
| POST /admin/extension/host/{id}/action/unprepare | Unprepare a host. |
| POST /admin/extension/host/{id}/action/upgrade | Upgrade the vCloud Director host agent on a host after you have upgraded vCloud Director software. |
Revision History
The vCloud API version number is incremented whenever any of its types or operations changes. The vCloud API Programming Guide for Service Providers is revised with each release of VMware vCloud Director. Versions of the vCloud API that were not introduced in a VMware vCloud Director release are documented in the vCloud Air Compute Service Programming Guide . An API version can be deprecated whenever a newer version of the API supports an equivalent set of features. Use of a deprecated API version is not recommended. Support for an API version may be removed in the release following deprecation.
| Revision Date | Description | Release Vehicle | Status |
|---|---|---|---|
| 28 MAR 2019 | API Version 32.0 | vCloud Director 9.7 | supported |
| 04 OCT 2018 | API Version 31.0 | vCloud Director 9.5 | supported |
| 27 FEB 2018 | API Version 30.0 | vCloud Director 9.1 | supported |
| 25 SEP 2017 | API Version 29.0 | vCloud Director 9.0 | supported |
| 21 FEB 2017 | API Version 27.0 | vCloud Director 8.20 | deprecated |
| 26 MAY 2016 | API Version 20.0 | vCloud Director 8.10 | Deprecated along with API Versions 21.0 to 26.0. Unsupported after vCloud Director 9.7 |
| N/A | API Version 19.0 | vCloud Air Compute Service | not supported |
| N/A | API Version 18.0 | vCloud Air Compute Service | not supported |
| 25 JAN 2016 | API Version 17.0 | vCloud Air Compute Service | not supported |
| N/A | API Version 16.0 | vCloud Air Compute Service | not supported |
| 15 DEC 2015 | API Version 14.0 | vCloud Air Compute Service | not supported |
| 21 SEP 2015 | API Version 13.0 | vCloud Air Compute Service | not supported |
| 22 AUG 2015 | API Version 12.0 | vCloud Air Compute Service | not supported |
| 10 JUL 2015 | API Version 11.0 | vCloud Air Compute Service | not supported |
| 10 SEP 2015 | API Version 9.0 | vCloud Director 8.0, vCloud Air Compute Service | not supported |
| 15 APR 2015 | API Version 7.0. | vCloud Air Compute Service | not supported |
| 16 MAR 2015 | API Version 6.0 | vCloud Air Compute Service | not supported |
| 13 JAN 2015 | API Version 5.11 | vCloud Air Compute Service | not supported |
| 24 OCT 2014 | API Version 5.10 | vCloud Air Compute Service | not supported |
| 19 SEP 2014 | API Version 5.9 | vCloud Air Compute Service | not supported |
| 05 SEP 2014 | API Version 5.8 | vCloud Air Compute Service | not supported |
| 01 AUG 2014 | API Version 5.7. | vCloud Air Compute Service | not supported |
| 07 OCT 2014 | API Version 5.6 | vCloud Director 5.6 | not supported |
| 19 SEP 2013 | API Version 5.5 | vCloud Director 5.5 | not supported |
| 10 SEP 2012 | API Version 5.1 | vCloud Director 5.1 | not supported |
| 01 SEP 2011 | API Version 1.5 | vCloud Director 1.5 | not supported |
| 30 AUG 2010 | API Version 1.0 | vCloud Director 1.0 | not supported |
| 14 APR 2010 | API Version 0.9 | N/A | not supported |
Intended Audience
This guide is intended for software developers who are building VMware Ready Cloud Services, including interactive clients of VMware vCloud Director. This guide discusses Representational State Transfer (REST) and RESTful programming conventions, the Open Virtualization Format Specification, and VMware Virtual machine technology. You must be familiar with these and other widely deployed technologies such as XML, HTTP, and the Windows or Linux operating system.
Related Publications
The vCloud API Schema Reference includes reference material for all elements, types, queries, and operations in the vCloud API. It also includes the schema definition files. The schema reference is available at https://code.vmware.com.
The VMware vCloud Director Administrator's Guide and VMware vCloud Director User’s Guide contain detailed information about many of the objects and operations referred to in this guide. Most users of the vCloud API will find the information in those documents valuable when developing client applications. To access the current versions of these and other VMware publications, go to https://docs.vmware.com/.
Starting with version 9.5, vCloud Director integrates OpenAPI. For information about vCloud OpenAPI, see Getting Started with vCloud OpenAPI at https://code.vmware.com.