5.1
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
- Summary of vCloud API Browsing Requests
- Retrieve the Login URL and List of Supported API Versions
- Create a Login Session Using the Integrated Identity Provider
- Retrieve a List of Organizations Accessible to You
- Retrieve an Administrative View of a Cloud
- Retrieve a List of vSphere Platform Operations and Objects for a Cloud
- Provisioning an Organization
- Summary of vCloud API Provisioning Requests
- Upload an OVF Package to Create a vApp Template
- Download a vApp Template as OVF
- Upload a Media Image
- Copying and Moving with the vCloud API
- Capturing and Importing vApps
- Cataloging vApp Templates and Media Images
- Creating and Using Independent Disks
- View or Change the Owner of an Object
- 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
- Provide User Input Requested by a Virtual Machine
- Attach or Detach an Independent Disk
- Creating and Using vApp Snapshots
- Operate a vApp
- Configuring vApps and Virtual Machines
- Retrieve the Configuration Links for a vApp
- Retrieve the Configuration Links for a Virtual Machine
- Update Multiple Sections of 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
- Update the Storage Profile for a Virtual Machine
- Creating and Managing Organizations
- Summary of Administrative Requests
- Administrator Credentials and Privileges
- Organization Administration
- vDC Administration
- Network Administration
- Catalog Administration
- User and Group Administration
- Working With Roles and Rights
- Controlling Access to vApps and Catalogs
- Managing and Monitoring a Cloud
- Summary of vSphere Platform Extension Requests
- Retrieve or Update System Settings
- Attach a vCenter Server
- Finding Available vCenter Resources
- Create a Provider vDC
- Create an External Network
- Create a Network Pool
- Import a Virtual Machine from vCenter
- Relocate a Virtual Machine to a Different Datastore
- Truststore and Keytab Maintenance
- Retrieve the vSphere URL of an Object
- Working With Object Metadata
- Using the Query Service
- Configuring and Using Blocking Tasks and Notifications
- vCloud Director Extension Services
- XML Representations in the vCloud API
- Index
Table 3-1. Summary of vCloud API Browsing Requests
Operation Request Request Body Response
Show login URL and list of
supported API versions
GET API-URL/versions None
SupportedVersions
Log in POST API-URL/sessions None
Session
Log out 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
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 metadata for an
object such as an
organization, network,
vApp, virtual machine,
media image, or independent
disk.
GET API-
URL/object/id/metadata
None
Metadata
Retrieve a list of IP addresses
allocated to a network.
[NEW]
GET API-
URL/network/
id/allocatedAddresses
None
AllocatedIpAddresses
vCloud API Programming Guide
42 VMware, Inc.