VMware Cloud Director API clients and VMware Cloud Director servers communicate over HTTPS, exchanging XML representations of VMware Cloud Director API objects.

VMware Cloud Director API clients and the Compute Service in vCloud Air Virtual Private Cloud OnDemand communicate over HTTPS, exchanging XML representations of VMware Cloud Director API objects.

This simplified example of a RESTful workflow includes requests that discover and deploy a particular vApp, in this case, an FTP server with a connection to the public Internet.

These examples assume that you have access to a catalog that includes a vApp template with certain characteristics and an organization network that supports connections to the public Internet. The workflow and examples are flexible, and can accommodate various vApp templates and cloud capabilities.

Prerequisites

If you want to run the Hello vCloud examples, verify that the following conditions are met.

  • You have met the pre-requisite conditions described in #GUID-8084EE5C-CD8C-4CB7-81FD-D75569C5DF14.
  • Your VMware Cloud Director API client has authenticated to vCloud Air Virtual Private Cloud OnDemand and has a valid OAuth access token. To obtain the OAuth access token complete the steps described in #GUID-8084EE5C-CD8C-4CB7-81FD-D75569C5DF14.
  • You have at least the set of rights associated with the vCloud Air End User role. For a list of the rights associated with each vCloud Air predefined role, see #GUID-FF2B12FC-D42D-42E6-B3E1-7D7D66DB8674.
  • Your organization contains at least one VDC that has at least one network. For information about creating VDCs and networks, see #GUID-D8863952-791A-4D4C-BAC8-D871DFB1079D.
  • You have the login credentials of a user with the predefined vApp Author role or another role that has an equivalent set of rights.
  • Your organization contains at least one VDC that has at least one network. For information about creating VDCs and networks, see Managing an Organization.
  • Your organization contains a catalog in which at least one vApp template is available. For information about adding a vApp template to a catalog, see Provisioning an Organization.