External DocumentationTo learn more, visit the Veeam Backup Replication documentation.
Parameters
| Parameter | Description |
|---|---|
| Job UID | The unique ID of the required job. |
Example Output
{
"Job": {
"Links": {
"Link": [
{
"_Rel": "Up",
"_Type": "BackupServerReference",
"_Href": "https://srv12.tech.local:9398/api/backupServers/d1444f74-27e6-4399-81a9-d28ba98913f0",
"_Name": "srv12.tech.local"
},
{
"_Rel": "Alternate",
"_Type": "JobReference",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e",
"_Name": "DB Backup"
},
{
"_Rel": "Edit",
"_Type": "JobReference",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e",
"_Name": "DB Backup"
},
{
"_Rel": "Clone",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e?action=clone"
},
{
"_Rel": "ToggleScheduleEnabled",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e?action=toggleScheduleEnabled"
},
{
"_Rel": "Down",
"_Type": "ObjectInJobList",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e/includes"
},
{
"_Rel": "Down",
"_Type": "BackupJobSessionReferenceList",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e/backupSessions"
},
{
"_Rel": "Create",
"_Type": "ObjectInJob",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e/includes"
},
{
"_Rel": "Start",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e?action=start"
},
{
"_Rel": "Stop",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e?action=stop"
},
{
"_Rel": "Retry",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e?action=retry"
}
]
},
"JobType": "Backup",
"Platform": "HyperV",
"Description": "Backup of MS SQL Server DB",
"ScheduleConfigured": "true",
"ScheduleEnabled": "true",
"NextRun": "2020-02-01T17:00:00Z",
"JobScheduleOptions": {
"Standart": {
"RetryOptions": {
"RetryTimes": "3",
"RetryTimeout": "10",
"RetrySpecified": "true"
},
"WaitForBackupCompletion": "true",
"BackupCompetitionWaitingPeriodMin": "180",
"OptionsDaily": {
"Kind": "Everyday",
"Days": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"Time": "18:00:00.0000000+01:00",
"TimeOffsetUtc": "1",
"_Enabled": "true"
},
"OptionsMonthly": {
"Time": "22:00:00.0000000+01:00",
"TimeOffsetUtc": "1",
"DayNumberInMonth": "Fourth",
"DayOfWeek": "Saturday",
"Months": [
"January",
"February",
"March",
"April",
"May",
"June",
"July",
"August",
"September",
"October",
"November",
"December"
],
"DayOfMonth": "1",
"_Enabled": "false"
},
"OptionsPeriodically": {
"Kind": "Hours",
"FullPeriod": "1",
"Schedule": {
"Day": [
{
"_Name": "Sunday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Monday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Tuesday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Wednesday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Thursday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Friday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Saturday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
},
"_Enabled": "false"
},
"OptionsContinuous": {
"Schedule": {
"Day": [
{
"_Name": "Sunday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Monday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Tuesday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Wednesday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Thursday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Friday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Saturday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
},
"_Enabled": "false"
},
"OptionsBackupWindow": {
"TimePeriods": {
"Day": [
{
"_Name": "Sunday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Monday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Tuesday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Wednesday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Thursday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Friday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
},
{
"_Name": "Saturday",
"__text": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
},
"_Enabled": "false"
},
"OptionsDaisyChaining": {
"PreviousJobUid": "",
"_Enabled": "false"
}
}
},
"JobInfo": {
"BackupJobInfo": {
"Includes": {
"ObjectInJob": {
"ObjectInJobId": "0493ea16-2c1f-4d02-b74b-994bd438b89a",
"HierarchyObjRef": "urn:HyperV:Vm:8e7fef9f-87a8-48b4-bed1-632c3035a1a1.020aa5ab-3523-4946-b658-b8ad5b372439",
"Name": "sqlsrv03",
"DisplayName": "sqlsrv03",
"GuestProcessingOptions": {
"VssSnapshotOptions": {
"VssSnapshotMode": "RequireSuccess",
"IsCopyOnly": "false",
"UsePersistentGuestAgent": "false"
},
"WindowsGuestFSIndexingOptions": {
"FileSystemIndexingMode": "ExceptSpecifiedFolders",
"IncludedIndexingFolders": "",
"ExcludedIndexingFolders": {
"Path": [
"%windir%",
"%ProgramFiles%",
"%ProgramFiles(x86)%",
"%ProgramW6432%",
"%TEMP%"
]
}
},
"LinuxGuestFSIndexingOptions": {
"FileSystemIndexingMode": "ExceptSpecifiedFolders",
"IncludedIndexingFolders": "",
"ExcludedIndexingFolders": {
"Path": [
"/cdrom",
"/dev",
"/media",
"/mnt",
"/proc",
"/tmp",
"/lost+found"
]
}
},
"SqlBackupOptions": {
"TransactionLogsProcessing": "Backup",
"BackupLogsFrequencyMin": "60",
"UseDbBackupRetention": "false",
"RetainDays": "5"
},
"WindowsCredentialsId": "",
"LinuxCredentialsId": ""
},
"_Type": "ObjectInJob",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e/includes/0493ea16-2c1f-4d02-b74b-994bd438b89a"
}
},
"GuestProcessingOptions": {
"VssSnapshotOptions": {
"VssSnapshotMode": "RequireSuccess",
"IsCopyOnly": "false"
},
"WindowsGuestFSIndexingOptions": {
"FileSystemIndexingMode": "EveryFolders",
"IncludedIndexingFolders": "",
"ExcludedIndexingFolders": ""
},
"LinuxGuestFSIndexingOptions": {
"FileSystemIndexingMode": "ExceptSpecifiedFolders",
"IncludedIndexingFolders": "",
"ExcludedIndexingFolders": ""
},
"SqlBackupOptions": {
"TransactionLogsProcessing": "OnlyOnSuccessJob",
"BackupLogsFrequencyMin": "15",
"UseDbBackupRetention": "true",
"RetainDays": "15"
},
"WindowsCredentialsId": "7255bb17-aa93-44d0-9a24-00b9cd1da6c4",
"LinuxCredentialsId": ""
},
"AdvancedStorageOptions": {
"PasswordKeyId": "3d152e9d-a473-4990-bc2f-27710833ba20"
},
"GfsRetentionPolicy": {
"Weekly": {
"Enabled": "true",
"RetentionPeriod": "2",
"SelectedDay": "Sunday"
},
"Monthly": {
"Enabled": "true",
"RetentionPeriod": "3",
"SelectedWeek": "First"
},
"Yearly": {
"Enabled": "true",
"RetentionPeriod": "1",
"SelectedMonth": "January"
},
"_Enabled": "true"
},
"SimpleRetentionPolicy": {
"RetainCycles": "5",
"RetainDaysToKeep": "7",
"RetainLimitType": "Cycles"
}
}
},
"_xmlns": "http://www.veeam.com/ent/v1.0",
"_Type": "Job",
"_Href": "https://srv12.tech.local:9398/api/jobs/5658281f-625e-4627-89dd-d2a0c48be99e?format=Entity",
"_Name": "DB Backup",
"_UID": "urn:veeam:Job:5658281f-625e-4627-89dd-d2a0c48be99e"
}
}
Workflow Library Example
Get Job with Veeam Backup Replication and Send Results Via Email