How to connect to vCloud director using REST API clients ?

-


We all have had the use case to connect to vCloud director via API to pull some details. Below is the detailed process on how to connect using REST client.

I am using the Postman windows client. The procedure will remain the same for the other REST client applications too.

Step 1 :

Download the postman client
https://www.getpostman.com/downloads/

Step 2 (Optional) : 

You may have to disable the SSL certificate verification if you are trying this on a test environment and do not have trusted certificates


Step 3:


  • Enter the credentials under the Authorization tab
You must append either @system to the username or @orgname. This depends on the role you have. As a system administrator, you must use @system because your admin user is not bound to a special organization. As org admin or org user, you must append your organization name.

For example: administrator@system or orgadmin@wecloud



  • Enter the Accept header under the Headers tabs
Key : Accept 
Value : application/*+xml;version=32.0

The version can any supported value. The list of supported version can be exported using the below process. 

GET  https://vcd_url/api/versions



In my case, I am using version 32.0 which the latest supported for vCD 9.7




Step 4:

Create a Session by clicking on Send and this will generate an authorization token



  • The Status 200 OK means the query responded with no issues.
  • x-vcloud-authorization is the session authentication token for retrieving or updating future queries

Step 5 : 

  • Update the x-vcloud-authorization and its value under Headers section 


Example API query : 

How to list all organizations?


  1. Create a session using the above mentioned steps 
  2. Use the generated authorization token under Headers tab
  3. Run the below API query


GET https://vcd.wecloud.lab/api/org



This is it! The above procedure will allow you to connect to your VCD instance using API. You can refer to the VCD API reference guide to browse through all the API queries.

vCloud director API reference documents for different versions can be found in the below link  :

https://docs.vmware.com/en/vCloud-Director/index.html

Hope it helps 😀

Comments

Post a Comment

Popular posts from this blog

vCloud director 9.7 appliance deployment step by step guide

-
Image
With the new vCloud director releasing and making it full appliance with embedded vpostgres, I though I will put up a post with the complete installation guide. There have been some challenges in the getting the deployment successful. Prerequisite : Reverse DNS proxy must be configured for the eth0 ipaddress. This is to get the correct hostname for the appliance.  The NFS share is setup for the VCD transfer directory. It is recommended to have the eth0 and eth1 in different subnets. eth0 is for the vcd cell and eth1 is for the vPostgres .The reason for the having 2 subnets is to avoid duplicate entries in the route table.  Installing vCloud director step by step guide :  I should ideally be using different submets as per the VMware documentation but since I do not have a different portgroup setup, I am going with the same subnet.  As mentioned in the prereq section, the reason for the having 2 subnets is to avoid duplicate entries in the route tab
Read more

How to Install and Uninstall Guest agent for vRA Windows machines

-
Image
Connect to the vRA appliance using the IP or hostname  Choose the appropriate setup for your Windows server  Extract the files to C:\VRMGuestAgent\ . In my case, I have already extracted it.  Before you install the guest agent download and install the IAAS manager server certificate into the windows machine  Save the file as Cert.cer  Install the Cert into the Local machine and Trusted root store Rename the cert.cer to cert.pem and move it to folder C:\VRMGuestAgent\ Now, copy the certificate file into the vRMGuestAgent Extracted folder  Open the command prompt as admin and navigate to C:\VRMGuestAgent. In this case 192.168.2.15 is my Manager server . The default port is 443.  You will see the Guest agent service in the services list. Manually start the service.  Your windows guest agent is installed :)  How to Uninstall Guest agent on windows machine  To uninsta
Read more

VM console fails to connect - vCloud director 9.7

-
Image
I deployed a new vCloud director 9.7 and the VM console fails to connect even though the certificates and URLs are updated correctly in Public Addresses. The chrome browser console (ctrl+shift+j) fails like below :  failed: Error during WebSocket handshake: Unexpected response code: 404 After reading the VMware documentation which says " For an installation with a single IP address, you can customize the console proxy address from the  vCloud Director  Web Console. For example, for the  vCloud Director  appliance, you must customize the console proxy address to  vcloud.example.com :8443 " From vCloud director 9.7, the second network (eth1) is dedicated to vpostgres database and console proxy uses (eth0) with a custom port 8443 Fix :  Update the console proxy address with custom port 8443 under vCD portal --> Administrator --> Public addresses Tadaa!  Thanks for reading. Hope it helps :) 
Read more