Cloud Director Service API

VMware Cloud Director Service API

Introduction

The VMware Cloud Director Service API is a REST API that you can use as the entry point to all the features of the VMware Cloud Director service.

As a service provider, you can use the VMware Cloud Director Service API to list all the available environments in your Cloud Provider service organization or to get summary information about all the VMWare Cloud Director instances in your CSP organization.

Authorization

You use API tokens to authenticate yourself to the VMware Cloud Director service API. For more information, see the VMware Cloud Director Service API Programming guide.

Key Concepts

The API contains endpoints that provide a global overview of the VMware Cloud Director service.

Organization endpoint

The first time you log in to the VMware Cloud Director service API, you must run a GET call to retrieve the ID (URN) of the organization associated with your API token.

Environments

All VMware Cloud Director instances are managed in environments. By using the API, you can list all the environments that are marked as default environments assigned to you.

Topology

The VMware Cloud Director service maintains a cache of high-level objects, such as instances and VDCs This cache helps eliminate the necessity to make data acquisition calls to all environments within a VMware Cloud organization. You can make calls to the topology API to retrieve the information in this cache. To retrieve up-to-date information directly, you must make direct calls to the instances in your organization.