Help Center
Choose product document...
Veeam Backup & Replication 9.5
RESTful API Reference

(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

GET http://<Enterprise-Manager>:9399/api/vCloud/orgConfigs/{ID}

or

GET http://<Enterprise-Manager>:9399/api/vCloud/orgConfigs/{ID}?format=Entity

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.

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 — the default configuration is disabled. Self-service backup is unavailable for vCloud Director organizations that do not have individual configurations.
  • False — the default configuration is enabled. vCloud Director organizations for which individual configurations were not created can perform self-service backup.

True

True

JobSchedulerType

String

Job scheduling options. Possible values:

  • FullvCloud Director organization administrator has full access to all job scheduling options.
  • PartialvCloud Director organization administrator can create daily and monthly jobs only.
  • RandomvCloud Director organization administrator can create daily jobs with randomized start time within the backup window.
  • DisabledvCloud Director organization administrator can create only jobs with no schedule assigned.

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 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/xml.

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 http://localhost:9399/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640?format=Entity

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<VCloudOrganizationConfig xmlns="http://www.veeam.com/ent/v1.0" Type="VCloudOrganizationConfig" Href="http://localhost:9399/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640?format=Entity" Name="org1" UID="urn:veeam:VCloudOrganizationConfig:ee1018b4-6f52-489e-80b7-8005e0b2d640">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/1cf4ea89-89d9-4b4e-a285-71bd8c705222" Name="172.17.53.2" />
   <Link Rel="Alternate" Type="VCloudOrganizationConfigReference" Href="http://localhost:9399/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640" Name="org1" />
   <Link Rel="Edit" Type="VCloudOrganizationConfigReference" Href="http://localhost:9399/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640" Name="org1" />
   <Link Rel="Disable" Href="http://localhost:9399/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640?action=disable" />
   <Link Rel="Delete" Href="http://localhost:9399/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640" />
   <Link Rel="Down" Type="VCloudOrganizationConfigBackupJobSettings" Href="http://localhost:9399/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640/backupJobSettings" Name="org1" />
 </Links>
 <BackupServerUid>urn:veeam:BackupServer:1cf4ea89-89d9-4b4e-a285-71bd8c705222</BackupServerUid>
 <RepositoryUid>urn:veeam:Repository:df9903aa-d2b6-4edd-9a0b-057bc8dd4451</RepositoryUid>
 <QuotaGb>100</QuotaGb>
 <JobSettings>
   <CustomSettings>true</CustomSettings>
   <JobSchedulerType>Full</JobSchedulerType>
 </JobSettings>
 <IsDisabled>false</IsDisabled>
</VCloudOrganizationConfig>

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation