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

(GET) /vCloud/orgConfigs/backupJobSettings

Returns job settings applied to backup jobs for the vCloud Director organization that has individual configuration with the specified ID.

Request

To get backup job settings used in the vCloud Director organization configuration, you need to send the GET HTTP request to the URL of the /vCloud/orgConfigs/{ID}/backupJobSettings resource.

HTTP Request

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

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

None.

Query Parameters

None.

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}/backupJobSettings resource.

Example

The example below returns a resource representation of the /vCloud/orgConfigs/{ID}/backupJobSettings resource.

Request:

GET http://localhost:9399/api/vCloud/orgConfigs/228fef7b-6e5e-4107-886e-40c8f482b5c7/backupJobSettings

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<VCloudOrganizationConfigBackupJobSettings xmlns="http://www.veeam.com/ent/v1.0" Type="VCloudOrganizationConfigBackupJobSettings" Href="http://localhost:9399/api/vCloud/orgConfigs/228fef7b-6e5e-4107-886e-40c8f482b5c7/backupJobSettings">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/1cf4ea89-89d9-4b4e-a285-71bd8c705222" Name="172.17.53.2" />
   <Link Rel="Up" Type="VCloudOrganizationConfig" Href="http://localhost:9399/api/vCloud/orgConfigs/228fef7b-6e5e-4107-886e-40c8f482b5c7?format=Entity" Name="org1" />
 </Links>
 <UseDefaultJobSettings>false</UseDefaultJobSettings>
 <AdvancedSettings>
   <BackupSettings>
     <BackupMode>
       <Incremental>
         <SyntheticFull Enabled="true">
           <OptionsDaily Enabled="true">
             <Days>Saturday</Days>
           </OptionsDaily>
           <TransformPreviousBackupChains>false</TransformPreviousBackupChains>
         </SyntheticFull>
       </Incremental>
     </BackupMode>
     <ActiveFullBackup Enabled="false">
       <OptionsWeekly Enabled="true">
         <Days>Saturday</Days>
       </OptionsWeekly>
     </ActiveFullBackup>
   </BackupSettings>
   <MaintenanceSettings>
     <BackupFilesHealthCheck Enabled="false">
       <OptionsMonthly Enabled="true">
         <DayNumberInMonth>Last</DayNumberInMonth>
         <DayOfWeek>Friday</DayOfWeek>
         <Months>January</Months>
         <Months>February</Months>
         <Months>March</Months>
         <Months>April</Months>
         <Months>May</Months>
         <Months>June</Months>
         <Months>July</Months>
         <Months>August</Months>
         <Months>September</Months>
         <Months>October</Months>
         <Months>November</Months>
         <Months>December</Months>
       </OptionsMonthly>
     </BackupFilesHealthCheck>
     <FullBackupFileMaintenance>
       <RemoveDeletedVms Enabled="false">
         <RemoveAfter>14</RemoveAfter>
       </RemoveDeletedVms>
       <DefragmentFullBackupFile Enabled="false">
         <OptionsMonthly Enabled="true">
           <DayNumberInMonth>Last</DayNumberInMonth>
           <DayOfWeek>Saturday</DayOfWeek>
           <Months>January</Months>
           <Months>February</Months>
           <Months>March</Months>
           <Months>April</Months>
           <Months>May</Months>
           <Months>June</Months>
           <Months>July</Months>
           <Months>August</Months>
           <Months>September</Months>
           <Months>October</Months>
           <Months>November</Months>
           <Months>December</Months>
         </OptionsMonthly>
       </DefragmentFullBackupFile>
     </FullBackupFileMaintenance>
   </MaintenanceSettings>
   <StorageSettings>
     <DataReduction>
       <EnableInlineDataDeduplication>true</EnableInlineDataDeduplication>
       <EnableSwapFileBlocks>true</EnableSwapFileBlocks>
       <EnableDeletedFileBlocks>true</EnableDeletedFileBlocks>
       <CompressionLevel>Optimal</CompressionLevel>
       <StorageOptimization>LocalTarget</StorageOptimization>
     </DataReduction>
     <Encryption Enabled="false" />
   </StorageSettings>
   <NotificationsSettings>
     <SendSnmpNotifications>false</SendSnmpNotifications>
     <VmAttributeNotifications Enabled="false">
       <SetSuccessfulBackupDetailsToVmAttr>Notes</SetSuccessfulBackupDetailsToVmAttr>
       <AppendToExistingAttrValue>true</AppendToExistingAttrValue>
     </VmAttributeNotifications>
   </NotificationsSettings>
   <vSphereSettings>
     <GuestQuiescence Enabled="false" />
     <ChangedBlockTracking Enabled="true">
       <EnableForAllProtectedVms>true</EnableForAllProtectedVms>
     </ChangedBlockTracking>
   </vSphereSettings>
   <IntegrationSettings>
     <BackupFromStorageSnapshots Enabled="true">
       <LimitProcessedVmCountPerStorageSnapshot>10</LimitProcessedVmCountPerStorageSnapshot>
       <FailoverToStandartBackup>false</FailoverToStandartBackup>
     </BackupFromStorageSnapshots>
   </IntegrationSettings>
   <ScriptsSettings>
     <PostJobScript Enabled="false">
       <ScriptPath />
     </PostJobScript>
     <PreJobScript Enabled="false">
       <ScriptPath />
     </PreJobScript>
     <RunScriptsEveryBackupSession>
       <RunEveryBackupSession>1</RunEveryBackupSession>
     </RunScriptsEveryBackupSession>
   </ScriptsSettings>
 </AdvancedSettings>
 <SourceProxyAutoDetect>true</SourceProxyAutoDetect>
</VCloudOrganizationConfigBackupJobSettings>

 

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 Endpoint Backup Documentation

Veeam Management Pack Documentation