1.5
Table Of Contents
- vCloud API Programming Guide
- Contents
- vCloud API Programming Guide
- About the VMware vCloud API
- Hello vCloud: A Simplified RESTful Workflow
- Exploring a Cloud
- Provisioning an Organization with vApps, Templates, and Media
- Deploying and Operating vApps
- Summary of vCloud API vApp and Virtual Machine Operations Requests
- Create a vApp From a Template
- Compose a vApp From Existing Virtual Machines
- Recompose a vApp to Add or Remove Virtual Machines
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Retrieve or Update a Modifiable Section
- Update a vApp Network Configuration
- Update the NetworkConnectionSection of a Virtual Machine
- Retrieve or Modify the CPU Configuration of a Virtual Machine
- Retrieve or Modify the GuestCustomizationSection of a Virtual Machine
- Retrieve or Modify ProductSection Elements
- Retrieve or Modify Groups of Related Sections in a Virtual Machine
- Retrieve or Modify the Hard Disk Configuration of a Virtual Machine
- Creating, Provisioning, and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- Network Administration
- vDC Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Using vCloud API Extensions to Provision and Manage a Cloud
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- XML Representations in the vCloud API
- Index
Table 3-1. Summary of vCloud API Browsing Requests (Continued)
Operation Request Request Body Response
Log out [NEW] DELETE API-URL/session None 200 OK
Log in [DEPRECATED] POST API-URL/login None
OrgLIst
Log out [DEPRECATED] POST API-URL/login None 200 OK
Retrieve a list of entry points
for browsing operations
[NEW]
GET API-URL/session None 200 OK
Retrieve a list of
organizations to which you
have access
GET API-URL/org/ None
OrgList
Retrieve the contents of an
organization
GET API-URL/org/id None
Org
Retrieve properties of a
network
GET API-URL/network/id None
OrgNetwork
Retrieve the contents of a
catalog
GET API-URL/catalog/id None
Catalog
Retrieve properties of a
catalog item
GET API-
URL/catalogItem/id
None
CatalogItem
Retrieve the contents of a
vDC
GET API-URL/vdc/id None
Vdc
Retrieve properties of a
media image
GET API-URL/media/id None
Media
Retrieve a vApp template GET API-
URL/vAppTemplate/vappT
emplate-id
None
VAppTemplate
Retrieve properties of a vApp GET API-URL/vApp/vapp-
id
None
VApp
Retrieve properties of a
virtual machine
GET API-URL/vApp/vm-id None
Vm
Retrieve the Login URL and List of Supported API Versions
Every cloud has a login URL that a client can obtain by making an unauthenticated GET request to the
vCloud Director api/versions URL. The response to this request also lists vCloud API versions that the server
supports.
Procedure
1 Make an API version request to vCloud Director to obtain the login URL for the REST API.
See the request portion of “Example: Versions Request and Response,” on page 43.
2 Examine the response to find the login URLs.
Each version of the vCloud API that the server supports has its own login URL. Look for a line of the
following form:
<LoginUrl>http://vcloud.example.com/api/...</LoginUrl>
3 Use the login URL to log in to the cloud.
vCloud API Programming Guide
42 VMware, Inc.