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

(POST) /vCloud/orgConfigs

Creates a vCloud Director organization configuration.

Request

To create a vCloud Director organization configuration, you need to send the POST HTTP request to the URL of the /vCloud/orgConfigs resource.

HTTP Request

POST http://<Enterprise-Manager>:9399/api/vCloud/orgConfigs

Request Header

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

In the request body, the client must send parameters of the vCloud Director organization configuration. The body of the request must conform to the XML Schema Definition of Veeam Backup Enterprise Manager RESTful API.

The request body must contain the following elements:

Element

Type

Description

Modifiable

Min/Max Occurrence

OrganizationName

String

Name of the vCloud Director organization for which configuration is created. The vCloud Director organization must be created in advance on a vCloud Director server processed by a Veeam backup server added to Veeam Backup Enterprise Manager.

Yes

1/1

BackupServerUid

URN

ID of the backup server that must process VMs of the vCloud Director organization, for example: urn:veeam:BackupServer:1cf4ea89-89d9-4b4e-a285-71bd8c705222.

Yes

1/1

RepositoryUid

URN

ID of the backup repository on which the storage quota for the vCloud Director organization must be created, for example: urn:veeam:Repository:82db96c3-445c-4a7e-9587-f2d523e839f4.

Yes

1/1

QuotaGb

Long

Size of the storage quota assigned to the vCloud Director organization (in GB).

Yes

1/1

TemplateJobUid

URN

ID of the vCloud Director backup job that will be used as a template for vCloud Director organization VMs processing. The backup job must be created in advance on the Veeam backup server connected to Veeam Backup Enterprise Manager.

Settings of the specified job will be applied to backup jobs created by tenant-side users. If the job ID is not specified, tenant-side jobs will be configured with the default vCloud Director backup job settings.

Job settings applied to backup jobs for the vCloud Director organization will be listed in the representation of the /vCloud/orgConfigs/{ID}/backupJobSettings resource.

Yes

0/1

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.

Yes

1/1

For example:

<?xml version="1.0" encoding="utf-8"?>
<VCloudOrganizationConfigCreateSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <OrganizationName>org01<OrganizationName>
 <BackupServerUid>urn:veeam:BackupServer:1cf4ea89-89d9-4b4e-a285-71bd8c705222</BackupServerUid>
 <RepositoryUid>urn:veeam:Repository:df9903aa-d2b6-4edd-9a0b-057bc8dd4451</RepositoryUid>
 <QuotaGb>100</QuotaGb>
 <TemplateJobUid>urn:veeam:Job:6c6ab2af-df49-4112-a036-72cf9bd28fef</TemplateJobUid>
 <JobSchedulerType>Full</JobSchedulerType>
</VCloudOrganizationConfigCreateSpec>

Query Parameters

None.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 202 Accepted.

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

None.

Example

The example below creates a new configuration for the vCloud Director organization with the name org1. The storage quota of 100 GB is created on the backup repository that has ID df9903aa-d2b6-4edd-9a0b-057bc8dd4451. The backup job with ID 6c6ab2af-df49-4112-a036-72cf9bd28fef is used as a template for tenant-side backup jobs. The vCloud Director organization administrator has full access to all job scheduling options.

Request:

POST http://localhost:9399/api/vCloud/orgConfigs

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Request Body:

<?xml version="1.0" encoding="utf-8"?>
<VCloudOrganizationConfigCreateSpec xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <OrganizationName>org01<OrganizationName>
 <BackupServerUid>urn:veeam:BackupServer:1cf4ea89-89d9-4b4e-a285-71bd8c705222</BackupServerUid>
 <RepositoryUid>urn:veeam:Repository:df9903aa-d2b6-4edd-9a0b-057bc8dd4451</RepositoryUid>
 <QuotaGb>100</QuotaGb>
 <TemplateJobUid>urn:veeam:Job:6c6ab2af-df49-4112-a036-72cf9bd28fef</TemplateJobUid>
 <JobSchedulerType>Full</JobSchedulerType>
</VCloudOrganizationConfigCreateSpec>

 

Response:

202 Accepted

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Running</State>
 <Operation>CreateVCloudOrganizationConfig</Operation>
</Task>

To trace the status of the operation, send the GET HTTP request to the URL of the received task resource:

Request:

GET http://localhost:9399/api/tasks/task-1

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
 <Links>
   <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
   <Link Rel="Related" Type="VCloudOrganizationConfigReference" Href="http://localhost:9399/api/vCloud/orgConfigs/ee1018b4-6f52-489e-80b7-8005e0b2d640" Name="org01" />
 </Links>
 <TaskId>task-1</TaskId>
 <State>Finished</State>
 <Operation>CreateVCloudOrganizationConfig</Operation>
 <Result Success="true">
   <Message>Ok</Message>
 </Result>
</Task>

 

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