Help Center
Choose product document...
Veeam Availability Console 3.0
RESTful API Reference

Get a vCD Organization

You can get a representation of a vCloud Director Organization with the specified ID.

Request

To get a representation of a specific vCloud Director Organization, send the GET HTTPS request to the URL of the /vcd/organizations/{ID} resource.

HTTP Request

GET https://<Availability-Console>:1281/v2/vcd/organizations/{ID}

Request Headers

The request header must contain the authorization token for the current logon session.

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Availability Console returns a representation of the /vcd/organizations/{ID} resource.

Example Get a vCD Organization

The following example returns a representation of a vCloud Director Organization with ID 13a9493c-252c-4b38-b291-a5454839d3b3.

Request:

GET https://localhost:1281/v2/vcd/organizations/13a9493c-252c-4b38-b291-a5454839d3b3

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response Code:

200 Success

 

Response Body:

 {

   "organizationUid": "13a9493c-252c-4b38-b291-a5454839d3b3",

   "cloudConnectAgentUid": "41ca2bb4-7269-4bc2-b049-6647157d2edb",

   "organizationName": "Organization1",

   "vcdUid": "4cef7e63-f3de-4cc8-bf98-46dc15c8a043",

   "vcdName": "VAC_vCD",

   "dataCenterCount": 1,

   "_links": [

     {

       "rel": "self",

       "method": "GET",

       "href": "https://vac:1281/v2/vcd/organizations/13a9493c-252c-4b38-b291-a5454839d3b3"

     },

     {

       "rel": "related",

       "method": "GET",

       "href": "https://vac:1281/v2/vcd/organizations/13a9493c-252c-4b38-b291-a5454839d3b3/dataCenters"

     }

   ]

 }

Veeam Large Logo

Deployment Guide

Guide for Service Providers

Guide for End Users

Guide for Resellers

Usage Scenarios for Service Providers

RESTful API Reference