- About Veeam Backup & Replication REST API
- Overview
- How To
- Changelog
- Login
- Service
- Services
- Credentials
- getGet All Credentials
- postAdd Credentials Record
- getGet Credentials Record
- putEdit Credentials Record
- delRemove Credentials Record
- postChange Password
- postChange Linux Private Key
- postChange Linux Root Password
- getGet All Cloud Credentials
- postAdd Cloud Credentials Record
- postGet Microsoft Entra ID Verification Code
- postRegister Microsoft Entra ID Application
- postGet Google Authentication Information
- getGet Cloud Credentials Record
- putEdit Cloud Credentials Record
- delRemove Cloud Credentials Record
- postChange Secret Key
- postChange Google Service Account
- postChange Certificate
- getGet All Helper Appliances
- postAdd or Edit Helper Appliance
- getGet Helper Appliance
- delRemove Helper Appliance
- Encryption
- getGet All Encryption Passwords
- postAdd Encryption Password
- getGet Encryption Password
- putEdit Encryption Password Hint
- delRemove Encryption Password
- postChange Encryption Password
- postVerify Encryption Password
- getGet All KMS Servers
- postAdd KMS Server
- getGet KMS Server
- putEdit KMS Server
- delRemove KMS Server
- postChange KMS Server Certificate
- License
- postInstall License
- getGet Installed License
- postRemove License
- postCreate License Usage Report
- postRenew Installed License
- getGet Consumption of Socket Licenses
- postRevoke Socket License
- getGet Instance Licenses Consumption
- postAssign Instance License
- postRevoke Instance License
- postRemove Instance License
- getGet Capacity License Consumption
- postRevoke Capacity License From Unstructured Data Workload
- postUpdate License
- postEnable or Disable License Auto Update
- postEnable or Disable Instance Consumption for Unlicensed Agents
- Connection
- Cloud Browser
- Inventory Browser
- getGet All VMware vSphere Servers
- getGet VMware vSphere Server Objects
- postRescan Inventory Objects
- postGet All Servers
- postGet Inventory Objects
- postGet All Protection Groups
- postGet Inventory Objects for Specific Protection Group
- getGet All Unstructured Data Servers
- getGet Unstructured Data Servers
- getGet All Microsoft Entra ID Tenants
- postAdd Microsoft Entra ID Tenant
- getGet Microsoft Entra ID Tenant
- putEdit Microsoft Entra ID Tenant
- delRemove Microsoft Entra ID Tenant
- getGet Active Directory Objects from Domain
- Traffic Rules
- General Options
- Global Exclusions
- Security
- postStart Security & Compliance Analyzer
- getGet Security & Compliance Analyzer Last Run
- getGet Security & Compliance Analyzer Schedule
- putModify Security & Compliance Analyzer Schedule
- postReset All Security & Compliance Analyzer Statuses
- getGet Security & Compliance Analyzer Results
- postSuppress Security & Compliance Analyzer Best Practice Status
- postReset Security & Compliance Analyzer Status
- getGet All Authorization Events
- getGet Authorization Event
- Malware Detection
- Configuration Backup
- Deployment
- Managed Servers
- getGet All Servers
- postAdd Server
- postGet vCenter Servers Attached to Cloud Director Server
- postGet Hyper-V Servers Managed by Hyper-V Cluster or SCVMM Server
- getGet Server
- putEdit Server
- delRemove Server
- postChange to Single-Use Credentials
- getGet Volumes for Hyper-V Standalone Server
- putEdit Volumes on Hyper-V Standalone Server
- postRescan All Managed Servers
- postRescan Managed Server
- getDefault Set of Optional Managed Server Components
- postUpdate Managed Server Components
- Repositories
- getGet All Repositories
- postAdd Repository
- postRescan Repositories
- getGet All Repository States
- getGet Repository
- putEdit Repository
- delRemove Repository
- getGet All Scale-Out Backup Repositories
- postAdd Scale-Out Backup Repository
- getGet Scale-Out Backup Repository
- putEdit Scale-Out Backup Repository
- delRemove Scale-Out Backup Repository
- postEnable Sealed Mode
- postDisable Sealed Mode
- postEnable Maintenance Mode
- postDisable Maintenance Mode
- Mount Servers
- Proxies
- WAN Accelerators
- Jobs
- Backups
- Backup Objects
- Restore Points
- Restore
- getGet All Instant Recovery Mount Points of VMware vSphere VMs
- postStart Instant Recovery of VMware vSphere VM
- getGet Instant Recovery Mount Point of VMware vSphere VM
- postStop Publishing VMware vSphere VM
- postStart Migrating VMware vSphere VM
- getGet All Instant Recovery Mount Points of Microsoft Hyper-V VMs
- postStart Instant Recovery of Microsoft Hyper-V VM
- getGet Instant Recovery Mount Point of Microsoft Hyper-V VM
- postStop Publishing Microsoft Hyper-V VM
- postStart Migrating Microsoft Hyper-V VM
- getGet All Mount Points for Instant Recovery to Azure
- postStart Instant Recovery to Azure
- getGet Mount Point for Instant Recovery to Azure
- getGet All Mount Sessions for Instant Recovery to Azure
- postStop Publishing Machine to Azure
- postStart Migrating Machine to Azure
- getGet Settings for Switchover to Azure
- putUpdate Settings for Switchover to Azure
- postStart Switchover to Azure
- postRestore Entire VMware vSphere VM
- postRestore Entire VMware Cloud Director VM
- postRestore Entire Microsoft Hyper-V VM
- getGet All FCD Mount Points
- postStart Instant FCD Recovery
- getGet FCD Mount Point
- postStop FCD Publishing
- postStart FCD Migration
- postStart File Restore
- postUnmount File System
- postGet User Code for Delegated Restore of Microsoft Entra ID Items
- postGet Credentials for Delegated Restore of Microsoft Entra ID Items
- postMount Microsoft Entra ID Tenant
- postStart Microsoft Entra ID Tenant Restore from Copy
- postUnmount Microsoft Entra ID Tenant
- postStart Microsoft Entra ID Audit Log Restore
- postUnmount Microsoft Entra ID Audit Logs
- Data Integration API
- Backup Browsers
- postValidate Target Machine Credentials
- getGet All File Restore Mount Points
- getGet File Restore Mount Point
- getGet Restored Files Audit
- postBrowse File System
- postCompare Attributes
- postCompare Files and Folders
- postSearch for Files and Folders
- postBrowse Search Results
- postRestore Files and Folders to Original Location
- postRestore Files and Folders to Another Location
- postPrepare Files and Folders for Download
- postDownload Files and Folders
- getGet All Unstructured Data Mount Points
- getGet Unstructured Data Mount Point
- postBrowse Unstructured Data File System
- postSearch for Files and Folders in Unstructured Data Source
- postBrowse Search Results
- postCopy Files and Folders to Specific Folder
- getGet Mount Points of All Entra ID Tenants
- getGet Mount Point of Microsoft Entra ID Tenant
- postGet Restore Points of Microsoft Entra ID Tenant
- getGet Protection Scope of Microsoft Entra ID Tenant
- postGet Microsoft Entra ID Items
- postGet Microsoft Entra ID Item
- postGet Restore Points of Microsoft Entra ID Item
- postValidate Microsoft Entra ID Items
- postCheck Microsoft Entra ID Items in Production
- postGenerate Microsoft Entra ID User Passwords
- postRestore Microsoft Entra ID Items
- postRestore Microsoft Entra ID Item Properties
- postCompare Microsoft Entra ID Item Properties
- postStart Comparing Microsoft Entra ID Item Properties
- getGet Comparison Results for Microsoft Entra ID Items
- postStart Comparing Microsoft Entra ID Conditional Access Policy
- getGet Comparison Results for Microsoft Entra ID Conditional Access Policy
- postExport Microsoft Entra ID Items
- postUpload Microsoft Entra ID Users
- postUpload Microsoft Entra ID Groups
- postUpload Microsoft Entra ID Administrative Units
- postUpload Microsoft Entra ID Roles
- postUpload Microsoft Entra ID Applications
- postUpload Microsoft Entra ID Conditional Access Policies
- getGet All Restore Sessions of Microsoft Entra ID Tenant
- getGet Restore Session of Microsoft Entra ID Tenant
- getGet Restore Session Logs of Microsoft Entra ID Tenant
- postStop Restore Session of Microsoft Entra ID Tenant
- Tasks
- Replicas
- Replica Restore Points
- Failover
- Failback
- Sessions
- Agents
- getGet All Recovery Tokens
- postCreate Recovery Token
- getGet Recovery Token
- putEdit Recovery Token
- delDelete Recovery Token
- getGet All Protected Computers
- getGet Protected Computer
- getGet Discovered Entities
- postRescan Discovered Entities
- postInstall Agent on Discovered Entities
- postUninstall Agent from Discovered Entities
- postUninstall All Components from Discovered Entities
- getGet Discovered Entity
- delRemove Discovered Entity
- getGet Linux Agent Packages
- getGet Unix Agent Packages
- Protection Groups
- Active Directory Domains
- Automation
- postImport Jobs
- postExport Jobs
- postImport Credentials
- postExport Credentials
- postImport Cloud Credentials
- postExport Cloud Credentials
- postImport Proxies
- postExport Proxies
- postImport Servers
- postExport Servers
- postImport Repositories
- postExport Repositories
- postImport Encryption Passwords
- postExport Encryption Passwords
- getGet All Automation Sessions
- getGet Automation Session
- getGet Automation Session Logs
- postStop Automation Session
- Log export
The Jobs section defines paths and operations for managing jobs that are coordinated by the backup server.
In this version, the REST API supports the following job types:
VSphereBackup
— VMware vSphere backup jobsvSphereReplica
— VMware vSphere replication jobsHyperVBackup
— Microsoft Hyper-V backup jobsCloudDirectorBackup
— VMware Cloud Director backup jobsWindowsAgentBackup
— Veeam Agent backup jobs for Windows computersLinuxAgentBackup
— Veeam Agent backup jobs for Linux computersEntraIDTenantBackup
— Microsoft Entra ID tenant backup jobsEntraIDAuditLogBackup
— Microsoft Entra ID audit log backup jobs
Get All Jobs
The HTTP GET request to the /api/v1/jobs
path allows you to get an array of all jobs coordinated by the backup server.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.
query Parameters
skip | integer <int32> Number of jobs to skip. |
limit | integer <int32> Default: 200 Maximum number of jobs to return. |
orderColumn | string (EJobFiltersOrderColumn) Sorts jobs by one of the job parameters. |
orderAsc | boolean If |
nameFilter | string Filters jobs by the |
typeFilter | string (EJobType) Filters jobs by job type. |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
OK
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 401
- 403
- 500
{- "data": [
- {
- "isHighPriority": false,
- "virtualMachines": {
- "includes": [
- {
- "inventoryObject": {
- "type": "VirtualMachine",
- "hostName": "vcenter01.tech.local",
- "name": "filesrv02",
- "objectId": "vm-45006"
}, - "size": "43.5 GB"
}
], - "excludes": {
- "vms": [ ],
- "disks": [
- {
- "disksToProcess": "AllDisks",
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "vcenter01.tech.local",
- "name": "filesrv02",
- "objectId": "vm-45006"
}, - "disks": [ ],
- "removeFromVMConfiguration": true
}
], - "templates": {
- "isEnabled": true,
- "excludeFromIncremental": true
}
}
}, - "storage": {
- "backupRepositoryId": "88101045-8755-4117-9221-bca81fbfabc4",
- "backupProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "retentionPolicy": {
- "type": "Days",
- "quantity": 7
}, - "gfsPolicy": {
- "isEnabled": false,
- "weekly": {
- "desiredTime": "sunday",
- "isEnabled": false,
- "keepForNumberOfWeeks": 1
}, - "monthly": {
- "desiredTime": "First",
- "isEnabled": false,
- "keepForNumberOfMonths": 1
}, - "yearly": {
- "desiredTime": "January",
- "isEnabled": false,
- "keepForNumberOfYears": 1
}
}, - "advancedSettings": {
- "backupModeType": "Incremental",
- "synthenticFulls": {
- "isEnabled": true,
- "days": [
- "saturday"
]
}, - "activeFulls": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": true,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "monday",
- "dayNumberInMonth": "First",
- "isEnabled": false,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "backupHealth": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "friday"
]
}, - "monthly": {
- "dayOfWeek": "friday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "fullBackupMaintenance": {
- "RemoveData": {
- "isEnabled": false,
- "afterDays": 14
}, - "defragmentAndCompact": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}
}, - "storageData": {
- "compressionLevel": "Optimal",
- "storageOptimization": "LocalTarget",
- "inlineDataDedupEnabled": true,
- "excludeSwapFileBlocks": true,
- "excludeDeletedFileBlocks": true,
- "encryption": {
- "isEnabled": false,
- "encryptionPasswordId": "00000000-0000-0000-0000-000000000000",
- "encryptionPasswordUniqueId": null
}
}, - "notifications": {
- "sendSNMPNotifications": false,
- "emailNotifications": {
- "notificationType": null,
- "isEnabled": false,
- "recipients": [ ],
- "customNotificationSettings": null
}, - "vmAttribute": {
- "isEnabled": false,
- "notes": "Notes",
- "appendToExistingValue": true
}
}, - "vSphere": {
- "enableVMWareToolsQuiescence": false,
- "changedBlockTracking": {
- "isEnabled": true,
- "enableCBTautomatically": true,
- "resetCBTonActiveFull": true
}
}, - "storageIntegration": {
- "isEnabled": true,
- "processedVmsLimitEnabled": false,
- "processedVmsCount": 10,
- "failoverToStandardBackup": false
}, - "scripts": {
- "periodicityType": "BackupSessions",
- "preCommand": {
- "isEnabled": false,
- "command": ""
}, - "postCommand": {
- "isEnabled": false,
- "command": ""
}, - "runScriptEvery": 1,
- "dayOfWeek": [
- "saturday"
]
}
}
}, - "guestProcessing": {
- "appAwareProcessing": {
- "isEnabled": false,
- "appSettings": [ ]
}, - "guestFSIndexing": {
- "isEnabled": true,
- "indexingSettings": [
- {
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "vcenter01.tech.local",
- "name": "filesrv02",
- "objectId": "vm-45006"
}, - "WindowsIndexing": {
- "guestFSIndexingMode": "indexAllExcept",
- "indexingList": [
- "%windir%",
- "%ProgramFiles%",
- "%ProgramFiles(x86)%",
- "%ProgramW6432%",
- "%TEMP%"
]
}, - "LinuxIndexing": {
- "guestFSIndexingMode": "indexAllExcept",
- "indexingList": [
- "/cdrom",
- "/dev",
- "/media",
- "/mnt",
- "/proc",
- "/tmp",
- "/lost+found"
]
}
}
]
}, - "guestInteractionProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "guestCredentials": {
- "credentialsType": "Standard",
- "credentialsId": "4fbeb05c-c158-4510-84f3-6744554fb350",
- "credentialsPerMachine": [ ]
}
}, - "schedule": {
- "runAutomatically": true,
- "daily": {
- "dailyKind": "Everyday",
- "isEnabled": true,
- "localTime": "10:00",
- "days": [
- "sunday",
- "monday",
- "tuesday",
- "wednesday",
- "thursday",
- "friday",
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Fourth",
- "isEnabled": false,
- "localTime": "10:00",
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}, - "periodically": {
- "periodicallyKind": "Hours",
- "isEnabled": false,
- "frequency": 1,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}, - "startTimeWithinAnHour": 0
}, - "continuously": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}, - "afterThisJob": {
- "isEnabled": false,
- "jobName": null
}, - "retry": {
- "isEnabled": true,
- "retryCount": 3,
- "awaitMinutes": 10
}, - "backupWindow": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}
}, - "type": "Backup",
- "id": "ef1f0227-80e1-40f8-b2a2-5119172d2c36",
- "name": "Backup Job 2",
- "description": "Created by ENTERPRISE01\\Administrator",
- "isDisabled": false
}
], - "pagination": {
- "total": 3,
- "count": 1,
- "skip": 0,
- "limit": 1
}
}
Create Job
The HTTP POST request to the /api/v1/jobs
path allows you to create a new job that has the specified parameters.
Available to: Veeam Backup Administrator.
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
name required | string Name of the job. |
type required | string (EJobType) Type of the job. |
description required | string Description of the job. |
required | object (BackupJobVirtualMachinesSpec) Included and excluded objects. |
isHighPriority | boolean Default: false If |
object (BackupJobStorageModel) VMware vSphere backup storage settings. | |
object (BackupJobGuestProcessingModel) Guest processing settings. | |
object (BackupScheduleModel) Job scheduling options. |
Job has been created.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "type": "Backup",
- "name": "Backup Job 3",
- "description": "Created by ENTERPRISE01\\Administrator",
- "isHighPriority": false,
- "virtualMachines": {
- "includes": [
- {
- "type": "ResourcePool",
- "vcName": "vcenter01.tech.local",
- "name": "ResourcePool01",
- "objectId": "resgroup-32774"
}
], - "excludes": {
- "vms": [
- {
- "type": "VirtualMachine",
- "vcName": "vcenter01.tech.local",
- "name": "srv01",
- "objectId": "vm-34739"
}, - {
- "type": "VirtualMachine",
- "vcName": "vcenter01.tech.local",
- "name": "srv02",
- "objectId": "vm-32843"
}
], - "disks": [
- {
- "disksToProcess": "SelectedDisks",
- "vmObject": {
- "type": "ResourcePool",
- "vcName": "vcenter01.tech.local",
- "name": "ResourcePool01",
- "objectId": "resgroup-32774"
}, - "disks": [
- "SCSI 0:0 (2000)",
- "IDE 0:0 (3000)"
]
}
], - "templates": {
- "isEnabled": true,
- "excludeFromIncremental": false
}
}
}, - "storage": {
- "backupRepositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
- "backupProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "retentionPolicy": {
- "type": "RestorePoints",
- "quantity": 7
}, - "gfsPolicy": {
- "isEnabled": false,
- "weekly": {
- "desiredTime": "sunday",
- "isEnabled": false,
- "keepForNumberOfWeeks": 1
}, - "monthly": {
- "desiredTime": "First",
- "isEnabled": false,
- "keepForNumberOfMonths": 1
}, - "yearly": {
- "desiredTime": "January",
- "isEnabled": false,
- "keepForNumberOfYears": 1
}
}, - "advancedSettings": {
- "backupModeType": "Incremental",
- "synthenticFulls": {
- "isEnabled": true,
- "days": [
- "saturday"
]
}, - "activeFulls": {
- "isEnabled": true,
- "weekly": {
- "isEnabled": true,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "monday",
- "dayNumberInMonth": "First",
- "isEnabled": false,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "backupHealth": {
- "isEnabled": true,
- "weekly": {
- "isEnabled": false,
- "days": [
- "friday"
]
}, - "monthly": {
- "dayOfWeek": "monday",
- "dayNumberInMonth": "First",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "fullBackupMaintenance": {
- "RemoveData": {
- "isEnabled": false,
- "afterDays": 14
}, - "defragmentAndCompact": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}
}, - "storageData": {
- "compressionLevel": "Optimal",
- "storageOptimization": "LocalTarget",
- "inlineDataDedupEnabled": true,
- "excludeSwapFileBlocks": true,
- "excludeDeletedFileBlocks": true,
- "encryption": {
- "isEnabled": false,
- "passwordId": "00000000-0000-0000-0000-000000000000"
}
}, - "notifications": {
- "sendSNMPNotifications": true,
- "emailNotifications": {
- "notificationType": null,
- "isEnabled": false,
- "recipients": [ ],
- "customNotificationSettings": null
}, - "vmAttribute": {
- "isEnabled": false,
- "notes": "Notes",
- "appendToExistingValue": true
}
}, - "vSphere": {
- "enableVMWareToolsQuiescence": false,
- "changedBlockTracking": {
- "isEnabled": true,
- "enableCBTautomatically": true,
- "resetCBTonActiveFull": true
}
}, - "storageIntegration": {
- "isEnabled": true,
- "processedVmsLimitEnabled": true,
- "processedVmsCount": 13,
- "failoverToStandardBackup": true
}, - "scripts": {
- "preCommand": {
- "periodicityType": "BackupSessions",
- "isEnabled": false,
- "command": "",
- "runScriptEvery": 1,
- "dayOfWeek": [
- "saturday"
]
}, - "postCommand": {
- "periodicityType": "BackupSessions",
- "isEnabled": false,
- "command": "",
- "runScriptEvery": 1,
- "dayOfWeek": [
- "saturday"
]
}
}
}
}, - "guestProcessing": {
- "appAwareProcessing": {
- "isEnabled": true,
- "appSettings": [
- {
- "vss": "requireSuccess",
- "transactionLogs": "process",
- "vmObject": {
- "type": "ResourcePool",
- "vcName": "vcenter01.tech.local",
- "name": "ResourcePool01",
- "objectId": "resgroup-32774"
}, - "sql": {
- "logsProcessing": "backup",
- "retainLogBackups": "untilBackupDeleted",
- "backupMinsCount": 15,
- "keepDaysCount": null,
- "logShippingServers": {
- "autoSelection": true,
- "shippingServerIds": [ ]
}
}, - "oracle": {
- "archiveLogs": "deleteExpiredGBs",
- "retainLogBackups": "untilBackupDeleted",
- "useGuestCredentials": false,
- "credentialsId": "a1b84070-9767-4f47-99cd-e25f57cd65dc",
- "deleteHoursCount": null,
- "deleteGBsCount": 10240,
- "backupLogs": true,
- "backupMinsCount": 23,
- "keepDaysCount": 15,
- "logShippingServers": {
- "autoSelection": true,
- "shippingServerIds": [ ]
}
}, - "exclusions": {
- "exclusionPolicy": "disabled",
- "itemsList": [ ]
}, - "scripts": {
- "scriptProcessingMode": "disableExec",
- "windowsScripts": null,
- "linuxScripts": null
}
}
]
}, - "guestFSIndexing": {
- "isEnabled": true,
- "indexingSettings": [
- {
- "vmObject": {
- "type": "ResourcePool",
- "vcName": "vcenter01.tech.local",
- "name": "ResourcePool01",
- "objectId": "resgroup-32774"
}, - "WindowsIndexing": {
- "guestFSIndexingMode": "indexAllExcept",
- "indexingList": [
- "%windir%",
- "%ProgramFiles%",
- "%ProgramFiles(x86)%",
- "%ProgramW6432%",
- "%TEMP%"
]
}, - "LinuxIndexing": {
- "guestFSIndexingMode": "indexAllExcept",
- "indexingList": [
- "/cdrom",
- "/dev",
- "/media",
- "/mnt",
- "/proc",
- "/tmp",
- "/lost+found"
]
}
}
]
}, - "guestInteractionProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "guestCredentials": {
- "windowsCredsId": "a1b84070-9767-4f47-99cd-e25f57cd65dc",
- "linuxCredsId": "00000000-0000-0000-0000-000000000000",
- "credentialsPerMachine": [
- {
- "windowsCredsId": "a1b84070-9767-4f47-99cd-e25f57cd65dc",
- "linuxCredsId": "00000000-0000-0000-0000-000000000000",
- "vmObject": {
- "type": "ResourcePool",
- "vcName": "vcenter01.tech.local",
- "name": "ResourcePool01",
- "objectId": "resgroup-32774"
}
}
]
}
}, - "schedule": {
- "isEnabled": true,
- "daily": {
- "dailyKind": "Everyday",
- "isEnabled": true,
- "localTime": "10:00",
- "days": [
- "sunday",
- "monday",
- "tuesday",
- "wednesday",
- "thursday",
- "friday",
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Fourth",
- "isEnabled": false,
- "localTime": "10:00",
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}, - "periodically": {
- "periodicallyKind": "Hours",
- "isEnabled": false,
- "frequency": 0,
- "continuously": {
- "BackupWindow": {
- "days": [
- {
- "day": "monday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "tuesday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "wednesday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "thursday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "friday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "saturday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "sunday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}
]
}
}
}, - "retry": {
- "isEnabled": true,
- "retryCount": 3,
- "awaitMinutes": 10
}, - "backupWindow": {
- "isEnabled": false,
- "WindowSetting": {
- "days": [
- {
- "day": "monday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "tuesday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "wednesday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "thursday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "friday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "saturday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}, - {
- "day": "sunday",
- "hours": "0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0"
}
]
}
}
}
}
- 201
- 400
- 401
- 403
- 500
{- "isHighPriority": false,
- "virtualMachines": {
- "includes": [
- {
- "inventoryObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "size": "152.5 GB"
}
], - "excludes": {
- "vms": [ ],
- "disks": [
- {
- "disksToProcess": "AllDisks",
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "disks": [ ],
- "removeFromVMConfiguration": true
}
], - "templates": {
- "isEnabled": true,
- "excludeFromIncremental": true
}
}
}, - "storage": {
- "backupRepositoryId": "49607f55-4cc4-4ea5-a2c9-e750318d0f34",
- "backupProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "retentionPolicy": {
- "type": "RestorePoints",
- "quantity": 7
}, - "gfsPolicy": {
- "isEnabled": false,
- "weekly": {
- "desiredTime": "sunday",
- "isEnabled": false,
- "keepForNumberOfWeeks": 1
}, - "monthly": {
- "desiredTime": "First",
- "isEnabled": false,
- "keepForNumberOfMonths": 1
}, - "yearly": {
- "desiredTime": "January",
- "isEnabled": false,
- "keepForNumberOfYears": 1
}
}, - "advancedSettings": {
- "backupModeType": "Incremental",
- "synthenticFulls": {
- "isEnabled": false,
- "days": [
- "saturday"
]
}, - "activeFulls": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": true,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "monday",
- "dayNumberInMonth": "First",
- "isEnabled": false,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "backupHealth": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "friday"
]
}, - "monthly": {
- "dayOfWeek": "friday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "fullBackupMaintenance": {
- "RemoveData": {
- "isEnabled": false,
- "afterDays": 14
}, - "defragmentAndCompact": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}
}, - "storageData": {
- "compressionLevel": "Optimal",
- "storageOptimization": "LocalTarget",
- "inlineDataDedupEnabled": true,
- "excludeSwapFileBlocks": true,
- "excludeDeletedFileBlocks": true,
- "encryption": {
- "isEnabled": false,
- "encryptionPasswordId": "00000000-0000-0000-0000-000000000000",
- "encryptionPasswordUniqueId": null
}
}, - "notifications": {
- "sendSNMPNotifications": false,
- "emailNotifications": {
- "notificationType": null,
- "isEnabled": false,
- "recipients": [ ],
- "customNotificationSettings": null
}, - "vmAttribute": {
- "isEnabled": false,
- "notes": "Notes",
- "appendToExistingValue": true
}
}, - "vSphere": {
- "enableVMWareToolsQuiescence": false,
- "changedBlockTracking": {
- "isEnabled": true,
- "enableCBTautomatically": true,
- "resetCBTonActiveFull": true
}
}, - "storageIntegration": {
- "isEnabled": true,
- "processedVmsLimitEnabled": false,
- "processedVmsCount": 10,
- "failoverToStandardBackup": false
}, - "scripts": {
- "periodicityType": "BackupSessions",
- "preCommand": {
- "isEnabled": false,
- "command": ""
}, - "postCommand": {
- "isEnabled": false,
- "command": ""
}, - "runScriptEvery": 1,
- "dayOfWeek": [
- "saturday"
]
}
}
}, - "guestProcessing": {
- "appAwareProcessing": {
- "isEnabled": true,
- "appSettings": [
- {
- "vss": "requireSuccess",
- "transactionLogs": "process",
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "usePersistentGuestAgent": false,
- "sql": {
- "logsProcessing": "truncate",
- "retainLogBackups": null,
- "backupMinsCount": null,
- "keepDaysCount": null,
- "logShippingServers": null
}, - "oracle": {
- "archiveLogs": "preserve",
- "retainLogBackups": "untilBackupDeleted",
- "useGuestCredentials": true,
- "credentialsId": null,
- "deleteHoursCount": null,
- "deleteGBsCount": null,
- "backupLogs": true,
- "backupMinsCount": 15,
- "keepDaysCount": 15,
- "logShippingServers": {
- "autoSelection": true,
- "shippingServerIds": [ ]
}
}, - "exclusions": {
- "exclusionPolicy": "disabled",
- "itemsList": [ ]
}, - "scripts": {
- "scriptProcessingMode": "disableExec",
- "windowsScripts": null,
- "linuxScripts": null
}
}
]
}, - "guestFSIndexing": {
- "isEnabled": false,
- "indexingSettings": [ ]
}, - "guestInteractionProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "guestCredentials": {
- "credentialsType": "Standard",
- "credentialsId": "6454c893-d5c6-4de8-be38-d984ea30dae4",
- "credentialsPerMachine": [ ]
}
}, - "schedule": {
- "runAutomatically": true,
- "daily": {
- "dailyKind": "Everyday",
- "isEnabled": true,
- "localTime": "4:00",
- "days": [
- "sunday",
- "monday",
- "tuesday",
- "wednesday",
- "thursday",
- "friday",
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Fourth",
- "isEnabled": false,
- "localTime": "9:00",
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}, - "periodically": {
- "periodicallyKind": "Hours",
- "isEnabled": false,
- "frequency": 1,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}, - "startTimeWithinAnHour": 0
}, - "continuously": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}, - "afterThisJob": {
- "isEnabled": false,
- "jobName": null
}, - "retry": {
- "isEnabled": true,
- "retryCount": 3,
- "awaitMinutes": 10
}, - "backupWindow": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}
}, - "type": "Backup",
- "id": "75fc491a-d158-4380-a433-ebc42a28e4df",
- "name": "Oracle Backup",
- "description": "Created by GAMMA\\Administrator",
- "isDisabled": false
}
Get All Job States
The HTTP GET request to the /api/v1/jobs/states
path allows you to get an array of all job states. The states include brief job information that you can also find under the Jobs node in the Veeam Backup & Replication console.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.
query Parameters
skip | integer <int32> Number of job states to skip. |
limit | integer <int32> Default: 200 Maximum number of job states to return. |
orderColumn | string (EJobStatesFiltersOrderColumn) Sorts job states by one of the state parameters. |
orderAsc | boolean If |
idFilter | string <uuid> Filters job states by job ID. |
nameFilter | string Filters job states by the |
typeFilter | string (EJobType) Filters job states by job type. |
lastResultFilter | string (ESessionResult) Filters job states by status with which jobs must finish. |
statusFilter | string (EJobStatus) Filters job states by current status of the job. |
workloadFilter | string (EJobWorkload) Filters job states by workloads that jobs must process. |
lastRunAfterFilter | string <date-time> Returns job states for jobs that have run after the specified date and time. |
lastRunBeforeFilter | string <date-time> Returns job states for jobs that have not run after the specified date and time. |
isHighPriorityJobFilter | boolean If |
repositoryIdFilter | string <uuid> Filters job states by repository ID. |
objectsCountFilter | integer Filters job states by number of objects processed by the job. |
afterJobIdFilter | string <uuid> Filters job states by the ID of the job after which the current job will run. |
afterJobNameFilter | string Filters job states by the name of the job after which the current job will run. |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
OK
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 401
- 403
- 500
{- "data": [
- {
- "type": "VSphereBackup",
- "status": "stopped",
- "lastResult": "Success",
- "workload": "vm",
- "id": "e35ef047-8cfa-4c3e-979e-de2e5399142f",
- "name": "Linux backup job",
- "description": "Created by .\\veeamadmin at 7/28/2025 10:41 AM.",
- "lastRun": "2025-07-28T10:44:39.694588+02:00",
- "nextRun": "2025-07-30T19:00:00+02:00",
- "nextRunPolicy": "7/30/2025 7:00 PM",
- "repositoryId": "751421e3-d93e-44cc-b79a-15793af16e1b",
- "repositoryName": "Veeam Data Cloud Vault repository",
- "objectsCount": 1,
- "sessionId": "6c76bb17-8695-4f7c-981f-670789edd8f3",
- "highPriority": false,
- "progressPercent": 100,
- "sessionProgress": {
- "bottleneck": "Proxy",
- "duration": "00:26:04",
- "processingRate": "18.3 MB/s",
- "processedSize": 17179869184,
- "readSize": 8074035200,
- "transferredSize": 3882512848,
- "progressPercent": 100
}, - "isStorageSnapshot": false
}, - {
- "type": "VSphereBackup",
- "status": "running",
- "lastResult": "None",
- "workload": "application",
- "id": "508ae9cb-cc94-4705-8dda-5522a9ed60da",
- "name": "PostgreSQL backup",
- "description": "Created by .\\veeamadmin at 7/30/2025 4:33 PM.",
- "lastRun": "2025-07-30T16:36:14.921469+02:00",
- "nextRunPolicy": "After [Linux backup job]",
- "repositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
- "repositoryName": "Default Backup Repository",
- "objectsCount": 1,
- "sessionId": "cab27d13-244e-4e6e-84c1-063a80b74117",
- "highPriority": true,
- "progressPercent": 0,
- "sessionProgress": {
- "bottleneck": "NotDefined",
- "duration": "00:03:37",
- "processingRate": "N/A",
- "processedSize": 0,
- "readSize": 0,
- "transferredSize": 0,
- "progressPercent": 0
}, - "runAfterJob": {
- "jobName": "Linux backup job",
- "jobId": "e35ef047-8cfa-4c3e-979e-de2e5399142f"
}, - "isStorageSnapshot": false
}
], - "pagination": {
- "total": 2,
- "count": 2
}
}
Get Job
The HTTP GET request to the /api/v1/jobs/{id}
path allows you to get a job that has the specified id
.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator.
path Parameters
id required | string <uuid> Job ID. To get the ID, run the Get All Jobs request. |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
OK
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 401
- 403
- 404
- 500
{- "isHighPriority": false,
- "virtualMachines": {
- "includes": [
- {
- "inventoryObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "size": "152.5 GB"
}
], - "excludes": {
- "vms": [ ],
- "disks": [
- {
- "disksToProcess": "AllDisks",
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "disks": [ ],
- "removeFromVMConfiguration": true
}
], - "templates": {
- "isEnabled": true,
- "excludeFromIncremental": true
}
}
}, - "storage": {
- "backupRepositoryId": "49607f55-4cc4-4ea5-a2c9-e750318d0f34",
- "backupProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "retentionPolicy": {
- "type": "RestorePoints",
- "quantity": 7
}, - "gfsPolicy": {
- "isEnabled": false,
- "weekly": {
- "desiredTime": "sunday",
- "isEnabled": false,
- "keepForNumberOfWeeks": 1
}, - "monthly": {
- "desiredTime": "First",
- "isEnabled": false,
- "keepForNumberOfMonths": 1
}, - "yearly": {
- "desiredTime": "January",
- "isEnabled": false,
- "keepForNumberOfYears": 1
}
}, - "advancedSettings": {
- "backupModeType": "Incremental",
- "synthenticFulls": {
- "isEnabled": false,
- "days": [
- "saturday"
]
}, - "activeFulls": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": true,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "monday",
- "dayNumberInMonth": "First",
- "isEnabled": false,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "backupHealth": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "friday"
]
}, - "monthly": {
- "dayOfWeek": "friday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "fullBackupMaintenance": {
- "RemoveData": {
- "isEnabled": false,
- "afterDays": 14
}, - "defragmentAndCompact": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}
}, - "storageData": {
- "compressionLevel": "Optimal",
- "storageOptimization": "LocalTarget",
- "inlineDataDedupEnabled": true,
- "excludeSwapFileBlocks": true,
- "excludeDeletedFileBlocks": true,
- "encryption": {
- "isEnabled": false,
- "encryptionPasswordId": "00000000-0000-0000-0000-000000000000",
- "encryptionPasswordUniqueId": null
}
}, - "notifications": {
- "sendSNMPNotifications": false,
- "emailNotifications": {
- "notificationType": null,
- "isEnabled": false,
- "recipients": [ ],
- "customNotificationSettings": null
}, - "vmAttribute": {
- "isEnabled": false,
- "notes": "Notes",
- "appendToExistingValue": true
}
}, - "vSphere": {
- "enableVMWareToolsQuiescence": false,
- "changedBlockTracking": {
- "isEnabled": true,
- "enableCBTautomatically": true,
- "resetCBTonActiveFull": true
}
}, - "storageIntegration": {
- "isEnabled": true,
- "processedVmsLimitEnabled": false,
- "processedVmsCount": 10,
- "failoverToStandardBackup": false
}, - "scripts": {
- "periodicityType": "BackupSessions",
- "preCommand": {
- "isEnabled": false,
- "command": ""
}, - "postCommand": {
- "isEnabled": false,
- "command": ""
}, - "runScriptEvery": 1,
- "dayOfWeek": [
- "saturday"
]
}
}
}, - "guestProcessing": {
- "appAwareProcessing": {
- "isEnabled": true,
- "appSettings": [
- {
- "vss": "requireSuccess",
- "transactionLogs": "process",
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "usePersistentGuestAgent": false,
- "sql": {
- "logsProcessing": "truncate",
- "retainLogBackups": null,
- "backupMinsCount": null,
- "keepDaysCount": null,
- "logShippingServers": null
}, - "oracle": {
- "archiveLogs": "preserve",
- "retainLogBackups": "untilBackupDeleted",
- "useGuestCredentials": true,
- "credentialsId": null,
- "deleteHoursCount": null,
- "deleteGBsCount": null,
- "backupLogs": true,
- "backupMinsCount": 15,
- "keepDaysCount": 15,
- "logShippingServers": {
- "autoSelection": true,
- "shippingServerIds": [ ]
}
}, - "exclusions": {
- "exclusionPolicy": "disabled",
- "itemsList": [ ]
}, - "scripts": {
- "scriptProcessingMode": "disableExec",
- "windowsScripts": null,
- "linuxScripts": null
}
}
]
}, - "guestFSIndexing": {
- "isEnabled": false,
- "indexingSettings": [ ]
}, - "guestInteractionProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "guestCredentials": {
- "credentialsType": "Standard",
- "credentialsId": "6454c893-d5c6-4de8-be38-d984ea30dae4",
- "credentialsPerMachine": [ ]
}
}, - "schedule": {
- "runAutomatically": true,
- "daily": {
- "dailyKind": "Everyday",
- "isEnabled": true,
- "localTime": "4:00",
- "days": [
- "sunday",
- "monday",
- "tuesday",
- "wednesday",
- "thursday",
- "friday",
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Fourth",
- "isEnabled": false,
- "localTime": "9:00",
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}, - "periodically": {
- "periodicallyKind": "Hours",
- "isEnabled": false,
- "frequency": 1,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}, - "startTimeWithinAnHour": 0
}, - "continuously": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}, - "afterThisJob": {
- "isEnabled": false,
- "jobName": null
}, - "retry": {
- "isEnabled": true,
- "retryCount": 3,
- "awaitMinutes": 10
}, - "backupWindow": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}
}, - "type": "Backup",
- "id": "75fc491a-d158-4380-a433-ebc42a28e4df",
- "name": "Oracle Backup",
- "description": "Created by GAMMA\\Administrator",
- "isDisabled": false
}
Edit Job
The HTTP PUT request to the /api/v1/jobs/{id}
path allows you to edit a job that has the specified id
.
Available to: Veeam Backup Administrator.
path Parameters
id required | string <uuid> Job ID. To get the ID, run the Get All Jobs request. |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
id required | string <uuid> Job ID. |
name required | string Name of the job. |
type required | string (EJobType) Type of the job. |
isDisabled required | boolean If |
description required | string Description of the job. |
required | object (BackupJobGuestProcessingModel) Guest processing settings. |
isHighPriority required | boolean If |
required | object (BackupScheduleModel) Job scheduling options. |
required | object (BackupJobStorageModel) VMware vSphere backup storage settings. |
required | object (BackupJobVirtualMachinesModel) Included and excluded objects. |
Job has been updated.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "isHighPriority": false,
- "virtualMachines": {
- "includes": [
- {
- "inventoryObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "size": "152.5 GB"
}
], - "excludes": {
- "vms": [ ],
- "disks": [
- {
- "disksToProcess": "AllDisks",
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "disks": [ ],
- "removeFromVMConfiguration": true
}
], - "templates": {
- "isEnabled": true,
- "excludeFromIncremental": true
}
}
}, - "storage": {
- "backupRepositoryId": "49607f55-4cc4-4ea5-a2c9-e750318d0f34",
- "backupProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "retentionPolicy": {
- "type": "RestorePoints",
- "quantity": 7
}, - "gfsPolicy": {
- "isEnabled": false,
- "weekly": {
- "desiredTime": "sunday",
- "isEnabled": false,
- "keepForNumberOfWeeks": 1
}, - "monthly": {
- "desiredTime": "First",
- "isEnabled": false,
- "keepForNumberOfMonths": 1
}, - "yearly": {
- "desiredTime": "January",
- "isEnabled": false,
- "keepForNumberOfYears": 1
}
}, - "advancedSettings": {
- "backupModeType": "Incremental",
- "synthenticFulls": {
- "isEnabled": false,
- "days": [
- "saturday"
]
}, - "activeFulls": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": true,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "monday",
- "dayNumberInMonth": "First",
- "isEnabled": false,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "backupHealth": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "friday"
]
}, - "monthly": {
- "dayOfWeek": "friday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "fullBackupMaintenance": {
- "RemoveData": {
- "isEnabled": false,
- "afterDays": 14
}, - "defragmentAndCompact": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}
}, - "storageData": {
- "compressionLevel": "Optimal",
- "storageOptimization": "LocalTarget",
- "inlineDataDedupEnabled": true,
- "excludeSwapFileBlocks": true,
- "excludeDeletedFileBlocks": true,
- "encryption": {
- "isEnabled": false,
- "encryptionPasswordId": "00000000-0000-0000-0000-000000000000",
- "encryptionPasswordUniqueId": null
}
}, - "notifications": {
- "sendSNMPNotifications": false,
- "emailNotifications": {
- "notificationType": null,
- "isEnabled": false,
- "recipients": [ ],
- "customNotificationSettings": null
}, - "vmAttribute": {
- "isEnabled": false,
- "notes": "Notes",
- "appendToExistingValue": true
}
}, - "vSphere": {
- "enableVMWareToolsQuiescence": false,
- "changedBlockTracking": {
- "isEnabled": true,
- "enableCBTautomatically": true,
- "resetCBTonActiveFull": true
}
}, - "storageIntegration": {
- "isEnabled": true,
- "processedVmsLimitEnabled": false,
- "processedVmsCount": 10,
- "failoverToStandardBackup": false
}, - "scripts": {
- "periodicityType": "BackupSessions",
- "preCommand": {
- "isEnabled": false,
- "command": ""
}, - "postCommand": {
- "isEnabled": false,
- "command": ""
}, - "runScriptEvery": 1,
- "dayOfWeek": [
- "saturday"
]
}
}
}, - "guestProcessing": {
- "appAwareProcessing": {
- "isEnabled": true,
- "appSettings": [
- {
- "vss": "requireSuccess",
- "transactionLogs": "process",
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "usePersistentGuestAgent": false,
- "sql": {
- "logsProcessing": "truncate",
- "retainLogBackups": null,
- "backupMinsCount": null,
- "keepDaysCount": null,
- "logShippingServers": null
}, - "oracle": {
- "archiveLogs": "preserve",
- "retainLogBackups": "untilBackupDeleted",
- "useGuestCredentials": true,
- "credentialsId": null,
- "deleteHoursCount": null,
- "deleteGBsCount": null,
- "backupLogs": true,
- "backupMinsCount": 15,
- "keepDaysCount": 15,
- "logShippingServers": {
- "autoSelection": true,
- "shippingServerIds": [ ]
}
}, - "exclusions": {
- "exclusionPolicy": "disabled",
- "itemsList": [ ]
}, - "scripts": {
- "scriptProcessingMode": "disableExec",
- "windowsScripts": null,
- "linuxScripts": null
}
}
]
}, - "guestFSIndexing": {
- "isEnabled": false,
- "indexingSettings": [ ]
}, - "guestInteractionProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "guestCredentials": {
- "credentialsType": "Standard",
- "credentialsId": "6454c893-d5c6-4de8-be38-d984ea30dae4",
- "credentialsPerMachine": [ ]
}
}, - "schedule": {
- "runAutomatically": true,
- "daily": {
- "dailyKind": "Everyday",
- "isEnabled": true,
- "localTime": "4:00",
- "days": [
- "sunday",
- "monday",
- "tuesday",
- "wednesday",
- "thursday",
- "friday",
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Fourth",
- "isEnabled": false,
- "localTime": "9:00",
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}, - "periodically": {
- "periodicallyKind": "Hours",
- "isEnabled": false,
- "frequency": 1,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}, - "startTimeWithinAnHour": 0
}, - "continuously": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}, - "afterThisJob": {
- "isEnabled": false,
- "jobName": null
}, - "retry": {
- "isEnabled": true,
- "retryCount": 3,
- "awaitMinutes": 10
}, - "backupWindow": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}
}, - "type": "Backup",
- "id": "75fc491a-d158-4380-a433-ebc42a28e4df",
- "name": "Oracle Backup",
- "description": "Created by GAMMA\\Administrator",
- "isDisabled": false
}
- 200
- 400
- 401
- 403
- 404
- 500
{- "isHighPriority": false,
- "virtualMachines": {
- "includes": [
- {
- "inventoryObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "size": "152.5 GB"
}
], - "excludes": {
- "vms": [ ],
- "disks": [
- {
- "disksToProcess": "AllDisks",
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "disks": [ ],
- "removeFromVMConfiguration": true
}
], - "templates": {
- "isEnabled": true,
- "excludeFromIncremental": true
}
}
}, - "storage": {
- "backupRepositoryId": "49607f55-4cc4-4ea5-a2c9-e750318d0f34",
- "backupProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "retentionPolicy": {
- "type": "RestorePoints",
- "quantity": 7
}, - "gfsPolicy": {
- "isEnabled": false,
- "weekly": {
- "desiredTime": "sunday",
- "isEnabled": false,
- "keepForNumberOfWeeks": 1
}, - "monthly": {
- "desiredTime": "First",
- "isEnabled": false,
- "keepForNumberOfMonths": 1
}, - "yearly": {
- "desiredTime": "January",
- "isEnabled": false,
- "keepForNumberOfYears": 1
}
}, - "advancedSettings": {
- "backupModeType": "Incremental",
- "synthenticFulls": {
- "isEnabled": false,
- "days": [
- "saturday"
]
}, - "activeFulls": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": true,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "monday",
- "dayNumberInMonth": "First",
- "isEnabled": false,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "backupHealth": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "friday"
]
}, - "monthly": {
- "dayOfWeek": "friday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}, - "fullBackupMaintenance": {
- "RemoveData": {
- "isEnabled": false,
- "afterDays": 14
}, - "defragmentAndCompact": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}
}
}, - "storageData": {
- "compressionLevel": "Optimal",
- "storageOptimization": "LocalTarget",
- "inlineDataDedupEnabled": true,
- "excludeSwapFileBlocks": true,
- "excludeDeletedFileBlocks": true,
- "encryption": {
- "isEnabled": false,
- "encryptionPasswordId": "00000000-0000-0000-0000-000000000000",
- "encryptionPasswordUniqueId": null
}
}, - "notifications": {
- "sendSNMPNotifications": false,
- "emailNotifications": {
- "notificationType": null,
- "isEnabled": false,
- "recipients": [ ],
- "customNotificationSettings": null
}, - "vmAttribute": {
- "isEnabled": false,
- "notes": "Notes",
- "appendToExistingValue": true
}
}, - "vSphere": {
- "enableVMWareToolsQuiescence": false,
- "changedBlockTracking": {
- "isEnabled": true,
- "enableCBTautomatically": true,
- "resetCBTonActiveFull": true
}
}, - "storageIntegration": {
- "isEnabled": true,
- "processedVmsLimitEnabled": false,
- "processedVmsCount": 10,
- "failoverToStandardBackup": false
}, - "scripts": {
- "periodicityType": "BackupSessions",
- "preCommand": {
- "isEnabled": false,
- "command": ""
}, - "postCommand": {
- "isEnabled": false,
- "command": ""
}, - "runScriptEvery": 1,
- "dayOfWeek": [
- "saturday"
]
}
}
}, - "guestProcessing": {
- "appAwareProcessing": {
- "isEnabled": true,
- "appSettings": [
- {
- "vss": "requireSuccess",
- "transactionLogs": "process",
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "172.17.52.34",
- "name": "srv45",
- "objectId": "vm-61281"
}, - "usePersistentGuestAgent": false,
- "sql": {
- "logsProcessing": "truncate",
- "retainLogBackups": null,
- "backupMinsCount": null,
- "keepDaysCount": null,
- "logShippingServers": null
}, - "oracle": {
- "archiveLogs": "preserve",
- "retainLogBackups": "untilBackupDeleted",
- "useGuestCredentials": true,
- "credentialsId": null,
- "deleteHoursCount": null,
- "deleteGBsCount": null,
- "backupLogs": true,
- "backupMinsCount": 15,
- "keepDaysCount": 15,
- "logShippingServers": {
- "autoSelection": true,
- "shippingServerIds": [ ]
}
}, - "exclusions": {
- "exclusionPolicy": "disabled",
- "itemsList": [ ]
}, - "scripts": {
- "scriptProcessingMode": "disableExec",
- "windowsScripts": null,
- "linuxScripts": null
}
}
]
}, - "guestFSIndexing": {
- "isEnabled": false,
- "indexingSettings": [ ]
}, - "guestInteractionProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "guestCredentials": {
- "credentialsType": "Standard",
- "credentialsId": "6454c893-d5c6-4de8-be38-d984ea30dae4",
- "credentialsPerMachine": [ ]
}
}, - "schedule": {
- "runAutomatically": true,
- "daily": {
- "dailyKind": "Everyday",
- "isEnabled": true,
- "localTime": "4:00",
- "days": [
- "sunday",
- "monday",
- "tuesday",
- "wednesday",
- "thursday",
- "friday",
- "saturday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Fourth",
- "isEnabled": false,
- "localTime": "9:00",
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}, - "periodically": {
- "periodicallyKind": "Hours",
- "isEnabled": false,
- "frequency": 1,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}, - "startTimeWithinAnHour": 0
}, - "continuously": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}, - "afterThisJob": {
- "isEnabled": false,
- "jobName": null
}, - "retry": {
- "isEnabled": true,
- "retryCount": 3,
- "awaitMinutes": 10
}, - "backupWindow": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}
}, - "type": "Backup",
- "id": "75fc491a-d158-4380-a433-ebc42a28e4df",
- "name": "Oracle Backup",
- "description": "Created by GAMMA\\Administrator",
- "isDisabled": false
}
Delete Job
The HTTP DELETE request to the /api/v1/jobs/{id}
path allows you to delete a job that has the specified id
.
Available to: Veeam Backup Administrator.
path Parameters
id required | string <uuid> Job ID. To get the ID, run the Get All Jobs request. |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Removed.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 204
- 401
- 403
- 404
- 500
{ }
Start Job
The HTTP POST request to the /api/v1/jobs/{id}/start
path allows you to start a job that has the specified id
.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Tape Operator.
path Parameters
id required | string <uuid> Job ID. To get the ID, run the Get All Jobs request. |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonoptional
performActiveFull required | boolean Default: false If |
startChainedJobs | boolean Default: false If |
syncRestorePoints | string (EBackupCopyRestorePoints) Restore point type for syncing backup copy jobs with the immediate copy mode. |
A BackupJob
(or ReplicaJob
) session has been started. To check the progress, track the session state
.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "performActiveFull": true,
- "startChainedJobs": true
}
- 201
- 400
- 401
- 403
- 404
- 500
{- "sessionType": "Job",
- "state": "Starting",
- "id": "b1380736-18a9-4fac-adfe-20abc570e8de",
- "name": "Oracle Backup",
- "jobId": "75fc491a-d158-4380-a433-ebc42a28e4df",
- "creationTime": "2024-02-04T20:46:49.067+03:00",
- "endTime": null,
- "progressPercent": 0,
- "result": null,
- "resourceId": null,
- "resourceReference": null,
- "parentSessionId": null,
- "usn": 0
}
Stop Job
The HTTP POST request to the /api/v1/jobs/{id}/stop
path allows you to stop a job that has the specified id
.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Tape Operator.
path Parameters
id required | string <uuid> Job ID. To get the ID, run the Get All Jobs request. |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonoptional
gracefulStop required | boolean Default: true If |
cancelChainedJobs | boolean Default: false If |
Stopping the BackupJob
(or ReplicaJob
) session. To check the progress, track the session state
.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "gracefulStop": true
}
- 201
- 400
- 401
- 403
- 404
- 500
{- "sessionType": "Job",
- "state": "Starting",
- "id": "b1380736-18a9-4fac-adfe-20abc570e8de",
- "name": "Oracle Backup",
- "jobId": "75fc491a-d158-4380-a433-ebc42a28e4df",
- "creationTime": "2024-02-04T20:46:49.067+03:00",
- "endTime": null,
- "progressPercent": 0,
- "result": null,
- "resourceId": null,
- "resourceReference": null,
- "parentSessionId": null,
- "usn": 0
}
Retry Job
The HTTP POST request to the /api/v1/jobs/{id}/retry
path allows you to retry a job that has the specified id
.
Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Tape Operator.
path Parameters
id required | string <uuid> Job ID. To get the ID, run the Get All Jobs request. |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonoptional
startChainedJobs | boolean Default: false If |
Retrying the BackupJob
(or ReplicaJob
) session. To check the progress, track the session state
.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "startChainedJobs": true
}
- 201
- 400
- 401
- 403
- 404
- 500
{- "sessionType": "BackupJob",
- "state": "Starting",
- "platformName": "VMware",
- "id": "9ab42b13-7fa7-4fad-ab80-b0e27c606ea6",
- "name": "Linux VM backup",
- "jobId": "a2187e67-e287-4079-8f75-c7f6f4cfbf9e",
- "creationTime": "2025-05-20T17:08:21.412856+02:00",
- "progressPercent": 0,
- "result": {
- "result": "None",
- "message": "",
- "isCanceled": false
}, - "usn": 141117,
- "platformId": "00000000-0000-0000-0000-000000000000"
}
Disable Job
The HTTP POST request to the /api/v1/jobs/{id}/disable
path allows you to disable a job that has the specified id
.
Available to: Veeam Backup Administrator.
path Parameters
id required | string <uuid> Job ID. To get the ID, run the Get All Jobs request. |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Job has been disabled.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 400
- 401
- 403
- 404
- 500
{ }
Enable Job
The HTTP POST request to the /api/v1/jobs/{id}/enable
path allows you to enable a job that has the specified id
.
Available to: Veeam Backup Administrator.
path Parameters
id required | string <uuid> Job ID. To get the ID, run the Get All Jobs request. |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Job has been enabled.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 400
- 401
- 403
- 404
- 500
{ }
Clone job
The HTTP POST request to the /api/v1/jobs/{id}/clone
path allows you to clone a job that has the specified id
.
Available to: Veeam Backup Administrator.
path Parameters
id required | string <uuid> Job ID. To get the ID, run the Get All Jobs request. |
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Job has been cloned.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 201
- 400
- 401
- 403
- 404
- 500
{- "description": "Created by .\\veeamadmin at 5/20/2025 2:47 PM.",
- "isHighPriority": false,
- "virtualMachines": {
- "includes": [
- {
- "type": "VirtualMachine",
- "hostName": "vcenter01.tech.local",
- "name": "linbase02",
- "objectId": "vm-53224",
- "isEnabled": true,
- "platform": "VSphere",
- "size": "20.7 GB"
}
], - "excludes": {
- "vms": [ ],
- "disks": [
- {
- "disksToProcess": "AllDisks",
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "vcenter01.tech.local",
- "name": "linbase02",
- "objectId": "vm-53224",
- "isEnabled": true,
- "platform": "VSphere",
- "size": "20.7 GB"
}, - "disks": [ ],
- "removeFromVMConfiguration": true
}
], - "templates": {
- "isEnabled": true,
- "excludeFromIncremental": true
}
}
}, - "storage": {
- "backupRepositoryId": "88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec",
- "backupProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "retentionPolicy": {
- "type": "Days",
- "quantity": 3
}, - "gfsPolicy": {
- "isEnabled": false,
- "weekly": {
- "desiredTime": "sunday",
- "isEnabled": false,
- "keepForNumberOfWeeks": 1
}, - "monthly": {
- "desiredTime": "First",
- "isEnabled": false,
- "keepForNumberOfMonths": 1
}, - "yearly": {
- "desiredTime": "January",
- "isEnabled": false,
- "keepForNumberOfYears": 1
}
}, - "advancedSettings": {
- "backupModeType": "Incremental",
- "synthenticFulls": {
- "isEnabled": true,
- "weekly": {
- "isEnabled": true,
- "days": [
- "saturday"
], - "localTime": ""
}, - "monthly": {
- "dayOfWeek": "monday",
- "dayNumberInMonth": "First",
- "isEnabled": false,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
], - "localTime": ""
}
}, - "activeFulls": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": true,
- "days": [
- "saturday"
], - "localTime": ""
}, - "monthly": {
- "dayOfWeek": "monday",
- "dayNumberInMonth": "First",
- "isEnabled": false,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
], - "localTime": ""
}
}, - "backupHealth": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "saturday"
], - "localTime": "05:00"
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
], - "localTime": "05:00"
}
}, - "fullBackupMaintenance": {
- "RemoveData": {
- "isEnabled": false,
- "afterDays": 14
}, - "defragmentAndCompact": {
- "isEnabled": false,
- "weekly": {
- "isEnabled": false,
- "days": [
- "saturday"
], - "localTime": ""
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Last",
- "isEnabled": true,
- "dayOfMonth": 1,
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
], - "localTime": ""
}
}
}, - "storageData": {
- "compressionLevel": "Optimal",
- "storageOptimization": "1MB",
- "inlineDataDedupEnabled": true,
- "excludeSwapFileBlocks": true,
- "excludeDeletedFileBlocks": true,
- "encryption": {
- "encryptionType": "ByUserPassword",
- "isEnabled": false
}
}, - "notifications": {
- "sendSNMPNotifications": false,
- "emailNotifications": {
- "isEnabled": false
}, - "vmAttribute": {
- "isEnabled": false,
- "notes": "Notes",
- "appendToExistingValue": true
}
}, - "vSphere": {
- "enableVMWareToolsQuiescence": false,
- "changedBlockTracking": {
- "isEnabled": true,
- "enableCBTautomatically": true,
- "resetCBTonActiveFull": true
}
}, - "storageIntegration": {
- "isEnabled": true,
- "processedVmsLimitEnabled": false,
- "processedVmsCount": 10,
- "failoverToStandardBackup": false
}, - "scripts": {
- "periodicityType": "BackupSessions",
- "preCommand": {
- "isEnabled": false,
- "command": ""
}, - "postCommand": {
- "isEnabled": false,
- "command": ""
}, - "runScriptEvery": 1,
- "dayOfWeek": [
- "saturday"
]
}
}
}, - "guestProcessing": {
- "appAwareProcessing": {
- "isEnabled": false
}, - "guestFSIndexing": {
- "isEnabled": false
}, - "guestInteractionProxies": {
- "autoSelectEnabled": true,
- "proxyIds": [ ]
}, - "guestCredentials": {
- "useAgentManagementCredentials": false,
- "credentials": {
- "credentialsType": "Linux",
- "credentialsId": "00000000-0000-0000-0000-000000000000"
}, - "credentialsPerMachine": [
- {
- "windowsCredsId": "00000000-0000-0000-0000-000000000000",
- "linuxCredsId": "00000000-0000-0000-0000-000000000000",
- "vmObject": {
- "type": "VirtualMachine",
- "hostName": "vcenter01.tech.local",
- "name": "linbase02",
- "objectId": "vm-53224",
- "isEnabled": false,
- "platform": "VSphere",
- "size": "0 B"
}, - "default": true
}
]
}
}, - "schedule": {
- "runAutomatically": false,
- "daily": {
- "dailyKind": "Everyday",
- "isEnabled": true,
- "localTime": "22:00",
- "days": [
- "monday",
- "tuesday",
- "wednesday",
- "thursday",
- "friday",
- "saturday",
- "sunday"
]
}, - "monthly": {
- "dayOfWeek": "saturday",
- "dayNumberInMonth": "Fourth",
- "isEnabled": false,
- "localTime": "22:00",
- "months": [
- "January",
- "February",
- "March",
- "April",
- "May",
- "June",
- "July",
- "August",
- "September",
- "October",
- "November",
- "December"
]
}, - "periodically": {
- "periodicallyKind": "Hours",
- "isEnabled": false,
- "frequency": 1,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}, - "startTimeWithinAnHour": 0
}, - "continuously": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}, - "afterThisJob": {
- "isEnabled": false
}, - "retry": {
- "isEnabled": true,
- "retryCount": 3,
- "awaitMinutes": 10
}, - "backupWindow": {
- "isEnabled": false,
- "backupWindow": {
- "days": [
- {
- "day": "sunday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "monday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "tuesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "wednesday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "thursday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "friday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}, - {
- "day": "saturday",
- "hours": "1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1"
}
]
}
}
}, - "type": "Backup",
- "id": "3d1682bc-c171-4cf2-b63a-3fde54625c9d",
- "name": "Linux VM backup_clone1",
- "isDisabled": false
}
Start Quick Backup
The HTTP POST request to the /api/v1/jobs/quickBackup/vSphere
path allows you to perform quick backup for the specified VMware vSphere or VMware Cloud Director VM.
Available to: Veeam Backup Administrator, Veeam Backup Operator.
header Parameters
x-api-version required | string Default: 1.3-rev0 Version and revision of the client REST API. Must be in the following format: |
Request Body schema: application/jsonrequired
platform required | string (EInventoryPlatformType) Platform type of inventory object. |
name required | string Name of the VMware vSphere object. |
type required | string (EVmwareInventoryType) Type of the VMware vSphere object. |
hostName required | string Name of the VMware vSphere server that hosts the object. |
size | string Object size. |
objectId | string ID of the VMware vSphere object. The parameter is required for all VMware vSphere objects except vCenter Servers and standalone ESXi hosts. |
urn | string Uniform Resource Name (URN) of the object. |
isEnabled | boolean Indicates whether the VMware vSphere object is enabled or disabled. |
Array of objects (CommonMetaInfo) Array of meta information about vmware object model. |
A BackupJob
session has been started. To check the progress, track the session state
.
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "type": "VirtualMachine",
- "hostName": "vcenter01.tech.local",
- "name": "linbase01",
- "objectId": "vm-45541",
- "urn": "vc:vcenter01.tech.local;folder:group-d1;datacenter:datacenter-1001;folder:group-h1003;computeresource:domain-s1006;hostsystem:host-1008;resourcepool:resgroup-1023;virtualmachine:vm-45541",
- "platform": "VMware",
- "size": "19.8 GB"
}
- 201
- 400
- 401
- 403
- 500
{- "sessionType": "BackupJob",
- "state": "Starting",
- "platformName": "VMware",
- "id": "9ff48f05-3367-42a8-af03-d875a5969295",
- "name": "Backup Job 1",
- "jobId": "6bf39221-c79b-49ff-8537-26a37b0a9080",
- "creationTime": "2024-10-29T11:11:49.839619+01:00",
- "endTime": null,
- "progressPercent": 0,
- "result": {
- "result": "None",
- "message": "",
- "isCanceled": false
}, - "resourceId": null,
- "resourceReference": null,
- "parentSessionId": null,
- "usn": 149421,
- "platformId": "00000000-0000-0000-0000-000000000000"
}