This edition of the VMware Cloud Director API Programming Guide provides information about version 38.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.

Changes to API Login and Logout

Starting with VMware Cloud Director API version 38.0, the following APIs are no longer available. You must log in through the corresponding cloudapi login. VMware Cloud Director API version 37.2 and earlier continue to support these APIs as per the backward compatibility commitment of VMware Cloud Director.
Operation Description
POST /api/sessions Create a login session.
DELETE /api/session

Delete the current user session.

Note: GET /api/session is not deprecated and VMware Cloud Director API version 38.0 continues to support it.

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 Guide and VMware Cloud Director Tenant 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/.