VMware Cloud Director™ API Programming Guide for Service Providers
This edition of the VMware Cloud Director API Programming Guide provides information about version 34.0 of the VMware Cloud Director API.
VMware provides many different APIs and SDKs for applications and goals. This guide provides information about the VMware Cloud Director API for developers who are interested in creating RESTful clients of VMware Cloud Director.
Removal of APIs Under Accelerated Deprecation
Starting with API version 34.0, the following APIs are no longer present.
| Operation | Description |
|---|---|
| POST /admin/extension/settings/ldapSettings/action/updateLdapSspiKeytab | Updates the system LDAP SSPI keytab. |
| POST /admin/extension/settings/ldapSettings/action/resetLdapSspiKeytab | Resets the system LDAP SSPI keytab. |
| POST /admin/org/{id}/settings/ldap/action/updateLdapSspiKeytab | Updates the organization LDAP SSPI keytab. |
| POST /admin/org/{id}/settings/ldap/action/resetLdapSspiKeytab | Resets the organization LDAP SSPI keytab. |
| POST /admin/org/{id}/settings/ldap/action/updateLdapCertificate | Updates the organization LDAP SSL certificate. |
| POST /admin/org/{id}/settings/ldap/action/updateLdapKeyStore | Updates the organization LDAP keystore. |
| POST /admin/org/{id}/settings/ldap/action/resetLdapCertificate | Resets the organization LDAP SSL certificate. |
| POST /admin/org/{id}/settings/ldap/action/resetLdapKeyStore | Resets the organization LDAP keystore. |
| Operation | Description |
|---|---|
| PUT /admin/extension/settings/kerberosSettings | Update the system Kerberos settings. |
| GET /admin/extension/settings/kerberosSettings | Retrieve the system Kerberos settings. |
| POST /admin/extension/settings/ldapSettings/action/updateLdapSspiKeytab | Updates the system LDAP SSPI key tab. |
| POST /admin/extension/settings/ldapSettings/action/resetLdapSspiKeytab | Resets the system LDAP SSPI key tab. |
| POST /admin/extension/settings/ldapSettings/action/updateLdapCertificate | Updates the system LDAP SSL certificate. |
| POST /admin/extension/settings/ldapSettings/action/updateLdapKeyStore | Updates the system LDAP keystore. |
| POST /admin/extension/settings/ldapSettings/action/resetLdapCertificate | Resets the system LDAP SSL certificate. |
| POST /admin/extension/settings/ldapSettings/action/resetLdapKeyStore | Resets the system LDAP keystore. |
Revision History
The VMware Cloud Director API version number is incremented whenever any of its types or operations changes. The VMware Cloud Director API Programming Guide is revised with each release of VMware Cloud Director. Versions of the VMware Cloud Director API that were not introduced in a VMware Cloud 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 |
|---|---|---|---|
| 9 Apr 2020 | API Version 34.0 | VMware Cloud Director 10.1 | supported |
| 19 Sep 2019 | API Version 33.0 | vCloud Director for Service Providers 10.0 | supported |
| 28 MAR 2019 | API Version 32.0 | vCloud Director for Service Providers 9.7 | supported |
| 04 OCT 2018 | API Version 31.0 | vCloud Director for Service Providers 9.5 | supported |
| 27 FEB 2018 | API Version 30.0 | vCloud Director 9.1 | deprecated |
| 25 SEP 2017 | API Version 29.0 | vCloud Director 9.0 | deprecated Unsupported after VMware Cloud Director 10.1. |
| 21 FEB 2017 | API Version 27.0 | vCloud Director 8.20 | deprecated Unsupported after VMware Cloud Director 10.1. |
| N/A | API Version 20.0 and earlier | vCloud Director 8.10 | not supported |
Intended Audience
This guide is intended for software developers who are building VMware Ready Cloud Services, including interactive clients of VMware Cloud 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 VMware Cloud Director API Schema Reference includes reference material for all elements, types, queries, and operations in the VMware Cloud Director API. It also includes the schema definition files. The schema reference is available at https://code.vmware.com.
The VMware Cloud Director Service Provider Admin Portal Guide and VMware Cloud Director Tenant Portal Guide contain detailed information about many of the objects and operations referred to in this guide. Most users of the VMware Cloud Director 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, VMware Cloud Director integrates OpenAPI. For information about VMware Cloud Director OpenAPI, see Getting Started with VMware Cloud Director OpenAPI at https://code.vmware.com.