GET /selfService/vSphere/Configs/{ID}/backupJobSettings
Returns job settings applied to backup jobs for the vSphere Self-Service Backup Portal tenant that has individual configuration with the specified ID.
Request
To get the backup job settings used in the vSphere Self-Service Backup Portal tenant job, send the GET HTTP request to the URL of the /selfService/vSphere/Configs/{ID}/backupJobSettings resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/selfService/vSphere/Configs/{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. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values: - application/xml — the client can send this value in the header to accept response in the XML format.
- application/json — the client must send this value in the header to accept the request in the JSON format.
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
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: - application/xml
- application/json
|
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /selfService/vSphere/Configs/{ID}/backupJobSettings resource.
Example
The example below returns a resource representation of the /selfService/vSphere/Configs/{ID}/backupJobSettings resource.
Request: GET https://localhost:9398/api/selfService/vSphere/Configs/228fef7b-6e5e-4107-886e-40c8f482b5c7/backupJobSettings Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 OK Response Body: <VSphereSelfServiceConfigJobSettings Href="https://localhost:9398/api/vCloud/orgConfigs/bc9c6d31-42ff-4418-94ce-999c0a3102b8/backupJobSettings" Type="VCloudOrganizationConfigBackupJobSettings" 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">
<Links>
<Link Href="https://localhost:9398/api/backupServers/5b75dac8-812a-47a5-b2be-7088114628a6" Name="backupsrv.tech.local" Type="BackupServerReference" Rel="Up"/>
<Link Href="https://localhost:9398/api/vCloud/orgConfigs/bc9c6d31-42ff-4418-94ce-999c0a3102b8?format=Entity" Name="tech\william.fox" Type="VCloudOrganizationConfig" Rel="Up"/>
</Links>
<UseDefaultJobSettings>true</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>
<ResetChangeTrackingOnActiveFull>true</ResetChangeTrackingOnActiveFull>
</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>
</VSphereSelfServiceConfigJobSettings> |