This edition of the VMware Cloud Director API Programming Guide provides information about version 37.x 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.
Accelerated API Deprecation
Due to removal of their functions, the following APIs are under accelerated deprecation and will be removed in future releases of VMware Cloud Director.
| API Version | API Endpoint | Property of Object | Description |
|---|---|---|---|
| 37.1 | POST /admin/catalog/{id}/action/subscribeToExternalCatalog | ExpectedSslThumbprint |
Expected SSL thumbprint of the endpoint |
| 37.1 | GET /branding | N/A | Gets the system level branding |
| 37.1 | PUT /branding | N/A | Sets default branding |
| 37.1 | GET /branding/logo | N/A | Gets the system level logo |
| 37.1 | PUT /branding/logo | N/A | Sets the system level logo |
| 37.1 | DELETE /branding/logo | N/A | Delete system level logo |
| 37.1 | GET /branding/icon | N/A | Gets the system level browser icon |
| 37.1 | PUT /branding/icon | N/A | Sets the system level icon |
| 37.1 | DELETE /branding/icon | N/A | Delete system level icon |
| 37.1 | GET /branding/tenant/{org} | N/A | Gets organization-specific branding |
| 37.1 | PUT /branding/tenant/{org} | N/A | Sets organization-specific branding |
| 37.1 | DELETE /branding/tenant/{org} | N/A | Remove organization-specific branding |
| 37.1 | GET /branding/tenant/{org}/logo | N/A | Gets the organization-specific logo |
| 37.1 | PUT /branding/tenant/{org}/logo | N/A | Sets the organization-specific logo |
| 37.1 | DELETE /branding/tenant/{org}/logo | N/A | Delete the organization-specific logo |
| 37.1 | GET /branding/tenant/{org}/icon | N/A | Gets the system level browser icon |
| 37.1 | PUT /branding/tenant/{org}/icon | N/A | Sets the system level icon |
| 37.1 | DELETE /branding/tenant/{org}/icon | N/A | Delete system level icon |
| 37.1 | GET /branding/themes | N/A | Get a list of themes |
| 37.1 | POST /branding/themes | N/A | Create a custom theme |
| 37.1 | GET /branding/themes/{name} | N/A | Retrieve a specified theme identified by name |
| 37.1 | PUT /branding/themes/{name} | N/A | Update an existing custom theme |
| 37.1 | DELETE /branding/themes/{name} | N/A | Delete an existing custom theme |
| 37.1 | GET /branding/themes/{name}/css | N/A | Retrieve the custom CSS for this theme, if any |
| 37.1 | POST /branding/themes/{name}/contents | N/A | Upload the contents for this theme |
| 37.1 | DELETE /branding/themes/{name}/contents | N/A | Delete an existing custom theme’s contents |
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.
The life cycle of minor VMware Cloud Director API versions depends on the major product API version. For example, VMware Cloud Director API Version 35.2 reaches end of general support at the same time as VMware Cloud Director API Version 35.0. See the VMware Cloud Director API version life cycle table on https://docs.vmware.com/en/VMware-Cloud-Director/index.html.
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://developer.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://developer.vmware.com/.
