Search Jobs - Blink Documentation

Get a list of jobs using filters and sorting options.

External DocumentationTo learn more, visit the Veeam Backup Replication documentation.

Basic Parameters

Parameter	Description
Filter	A filter expression to filter all items by using Veeam’s comparison syntax. All filter expressions should follow Veeam filter expression format. Format: `<parameter><operator><value>` Examples: - `name=="Exchange Job"` - Find items with exact name “Exchange Job”. - `name!="vCloud"` - Find items where name is not “vCloud”. - `createdTime>="2023-01-01"` - Find items created on or after January 1, 2023.
Job Type	The type of the required job.
Job UID	The unique ID of a required job.
Name	The name of a required job.
Page	The page number to retrieve. Note: Leave this parameter empty to retrieve all results without pagination.
Page Size	The maximum number of items to retrieve per page. Note: Leave this parameter empty to retrieve all results without pagination.
Platform	The platform for which the job is created.
Sort	Select to sort the items by a specified field and direction.
Sort Asc	The field name to sort all items by.
Sort By	The field name to sort all items by.

Advanced Parameters

Parameter	Description
Backup Server Name	The name of the backup server parent to the job resource.
Backup Server UID	The UID of the backup server parent to the job resource.
Description	The description of the job specified at the time of the job creation.
Format	The representation types to retrieve. For more information about the format parameter, please refer to Veeam API documentation.
Next Run	The timeframe of the next job run. Note: This parameter can be used for scheduled jobs only.
Schedule Configured	Specify whether scheduling options are specified for the job.
Schedule Enabled	Specify whether schedule is enabled for the job.

Example Output

{
	"QueryResult": {
		"Entities": {
			"Jobs": {
				"Job": {
					"Links": {
						"Link": [
							{
								"_Rel": "Up",
								"_Type": "BackupServerReference",
								"_Href": "https://localhost:9398/api/backupServers/7445e6ce-86f5-4171-b909-dac209c66563",
								"_Name": "enterprise06.tech.local"
							},
							{
								"_Rel": "Alternate",
								"_Type": "JobReference",
								"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f",
								"_Name": "Backup Job 5"
							},
							{
								"_Rel": "Edit",
								"_Type": "JobReference",
								"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f",
								"_Name": "Backup Job 5"
							},
							{
								"_Rel": "Clone",
								"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f?action=clone"
							},
							{
								"_Rel": "ToggleScheduleEnabled",
								"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f?action=toggleScheduleEnabled"
							},
							{
								"_Rel": "Down",
								"_Type": "ObjectInJobList",
								"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f/includes"
							},
							{
								"_Rel": "Down",
								"_Type": "BackupJobSessionReferenceList",
								"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f/backupSessions"
							},
							{
								"_Rel": "Create",
								"_Type": "ObjectInJob",
								"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f/includes"
							},
							{
								"_Rel": "Start",
								"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f?action=start"
							},
							{
								"_Rel": "Stop",
								"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f?action=stop"
							},
							{
								"_Rel": "Retry",
								"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f?action=retry"
							}
						]
					},
					"JobType": "Backup",
					"Platform": "vCloud",
					"Description": "Created by TECH\\administrator",
					"ScheduleConfigured": "false",
					"ScheduleEnabled": "true",
					"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": "22:00:00.0000000+02:00",
								"TimeOffsetUtc": "2",
								"_Enabled": "true"
							},
							"OptionsMonthly": {
								"Time": "22:00:00.0000000+02:00",
								"TimeOffsetUtc": "2",
								"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": "b4098b07-33c9-43b8-bbb6-b68bb4a7e17e",
									"HierarchyObjRef": "urn:vCloud:Vm:5d25f98b-90fb-452c-92a7-58e52adf2ed3.urn:vcloud:vm:8a99fd3f-4b79-49cf-a020-71ae70e7aafe",
									"Name": "vm01-LmYv",
									"DisplayName": "vm01",
									"GuestProcessingOptions": {
										"VssSnapshotOptions": {
											"VssSnapshotMode": "RequireSuccess",
											"IsCopyOnly": "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": "OnlyOnSuccessJob",
											"BackupLogsFrequencyMin": "15",
											"UseDbBackupRetention": "true",
											"RetainDays": "15"
										},
										"WindowsCredentialsId": "",
										"LinuxCredentialsId": ""
									},
									"_Type": "ObjectInJob",
									"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f/includes/b4098b07-33c9-43b8-bbb6-b68bb4a7e17e"
								}
							},
							"GuestProcessingOptions": {
								"VssSnapshotOptions": {
									"VssSnapshotMode": "Disabled",
									"IsCopyOnly": "false"
								},
								"WindowsGuestFSIndexingOptions": {
									"FileSystemIndexingMode": "Disabled",
									"IncludedIndexingFolders": "",
									"ExcludedIndexingFolders": ""
								},
								"LinuxGuestFSIndexingOptions": {
									"FileSystemIndexingMode": "Disabled",
									"IncludedIndexingFolders": "",
									"ExcludedIndexingFolders": ""
								},
								"SqlBackupOptions": {
									"TransactionLogsProcessing": "OnlyOnSuccessJob",
									"BackupLogsFrequencyMin": "15",
									"UseDbBackupRetention": "true",
									"RetainDays": "15"
								},
								"WindowsCredentialsId": "",
								"LinuxCredentialsId": ""
							},
							"AdvancedStorageOptions": {
								"PasswordKeyId": ""
							},
							"GfsRetentionPolicy": {
								"Weekly": {
									"Enabled": "false",
									"RetentionPeriod": "1",
									"SelectedDay": "Sunday"
								},
								"Monthly": {
									"Enabled": "false",
									"RetentionPeriod": "1",
									"SelectedWeek": "First"
								},
								"Yearly": {
									"Enabled": "false",
									"RetentionPeriod": "1",
									"SelectedMonth": "January"
								},
								"_Enabled": "false"
							},
							"SimpleRetentionPolicy": {
								"RetainCycles": "7",
								"RetainDaysToKeep": "4",
								"RetainLimitType": "Days"
							}
						}
					},
					"_Type": "Job",
					"_Href": "https://localhost:9398/api/jobs/1406b437-e4eb-470f-876a-60dc2b83728f?format=Entity",
					"_Name": "Backup Job 5",
					"_UID": "urn:veeam:Job:1406b437-e4eb-470f-876a-60dc2b83728f"
				}
			}
		},
		"PagingInfo": {
			"Links": {
				"Link": {
					"_Rel": "First",
					"_Href": "link"
				}
			},
			"_PagesCount": "1",
			"_PageSize": "100",
			"_PageNum": "1"
		},
		"_xmlns": "http://www.veeam.com/ent/v1.0"
	}
}

Workflow Library Example

Search Jobs with Veeam Backup Replication and Send Results Via Email

Preview this Workflow on desktop

Integrations

​Basic Parameters

​Advanced Parameters

​Example Output

​Workflow Library Example

Basic Parameters

Advanced Parameters

Example Output

Workflow Library Example