(GET) /vCloud/orgConfigs/{ID}
Returns a resource representation of a vCloud Director organization configuration with the specified ID.
Request
To get a resource representation of the vCloud Director organization configuration, you need to send the GET HTTP request to the URL of the /vCloud/orgConfigs/{ID} resource:
HTTP Request
or
Request Headers
The request contains the following headers:
Header | Required | Description |
---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Query Parameters
The following parameters can be used in queries:
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
---|---|---|---|---|
Uid | URN | ID of the vCloud Director organization configuration resource, for example: urn:veeam:BackupFile:0874ab95-10e5-4f25-84df-2782ad81f3e5. | True | True |
Name | String | Name of the vCloud Director organization configuration resource, for example: org1. | True | True |
RepositoryUid | URN | ID of the backup repository on which the storage quota for the vCloud Director organization is created, for example: urn:veeam:Repository:82db96c3-445c-4a7e-9587-f2d523e839f4. | True | True |
QuotaGb | Long | Size of the storage quota assigned to the vCloud Director organization (in GB). | True | True |
Disabled | Boolean | Defines if the default vCloud Director organization configuration is in the disabled or enabled state. Possible values:
| True | True |
JobSchedulerType | String | Job scheduling options. Possible values:
| True | True |
UsedQuota | Long | Amount of space on the storage quota consumed by the vCloud Director organization (in MB). | True | True |
BackupServerUid | URN | ID of the Veeam backup server parent to the vCloud Director organization configuration resource. | True | True |
BackupServerName | String | Name of the Veeam backup server parent to the vCloud Director organization configuration resource. | True | True |
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns response code 200 OK.
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. Possible values:
|
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /vCloud/orgConfigs/{ID} resource.
Example
The example below returns an entity representation of the configuration with ID ee1018b4-6f52-489e-80b7-8005e0b2d640.
Request: GET https://localhost:9398/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <VCloudOrganizationConfig xmlns="http://www.veeam.com/ent/v1.0" Type="VCloudOrganizationConfig" Href="https://localhost:9398/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640?format=Entity" Name="org1" UID="urn:veeam:VCloudOrganizationConfig:ee1018b4-6f52-489e-80b7-8005e0b2d640"> |