The identity and technical contract details declared by the specification.
VmwareObjectDiskModel
object
4 properties
3 required
BackupLinuxScriptModel
object
Paths to pre-freeze and post-thaw scripts for Linux VMs.
2 properties
GFSPolicySettingsWeeklyModel
object
Weekly GFS retention policy.
3 properties
1 required
JobStartSpec
object
2 properties
1 required
JobScriptsSettingsModel
object
Script settings.
5 properties
Error
object
3 properties
2 required
EVmwareDisksTypeToProcess
string
Type of disk selection.
EDayNumberInMonth
string
Week day number in the month.
EJobWorkload
string
Workload which the job must process.
EJobFiltersOrderColumn
string
Orders jobs by the specified column.
GFSPolicySettingsYearlyModel
object
Yearly GFS retention policy.
3 properties
1 required
BackupJobExclusions
object
Objects excluded from the backup.
3 properties
BackupFSExclusionsModel
object
VM guest OS file exclusion.
2 properties
1 required
BackupScheduleModel
object
Job scheduling options.
8 properties
1 required
AdvancedStorageScheduleWeeklyModel
object
Weekly schedule settings.
2 properties
1 required
BackupStorageSettingModel
object
Storage settings.
6 properties
EBackupOracleLogsSettings
string
Type of archived logs processing.
EPeriodicallyKinds
string
Time unit for periodic job scheduling.
SessionResultModel
object
Session result.
3 properties
1 required
ESennightOfMonth
string
Sennight of the month.
BackupJobStorageModel
object
Backup storage settings.
5 properties
3 required
BackupWindowDayHoursModel
object
Hourly scheme for a day.
2 properties
2 required
ESessionType
string
Type of the session.
ECredentialsType
string
Credentials type.
EGuestFSIndexingMode
string
Indexing mode.
BackupJobGuestProcessingModel
object
Guest processing settings.
4 properties
2 required
JobStatesResult
object
2 properties
2 required
BackupSQLSettingsModel
object
Microsoft SQL Server transaction log settings.
5 properties
1 required
NotificationVmAttributeSettingsModel
object
VM attribute settings.
3 properties
1 required
ERetentionPolicyType
string
Type of the retention policy.
VmwareObjectModel
object
VMware vSphere object.
4 properties
3 required
SchedulePeriodicallyModel
object
Periodic scheduling options.
5 properties
1 required
BaseJobModel
object
5 properties
EmptySuccessResponse
object
Empty success response (200, 201, 204).
EBackupModeType
string
Type of the backup method used to create a restore point.
BackupJobVirtualMachinesSpec
object
Arrays of objects that you want to back up or exclude from the backup.
2 properties
1 required
BackupApplicationSettingsModel
object
8 properties
2 required
FullBackupMaintenanceRemoveDataModel
object
Backup data setting for deleted VMs.
2 properties
1 required
EDailyKinds
string
Kind of daily scheduling scheme.
BackupProxiesSettingsModel
object
Backup proxy settings.
2 properties
1 required
GuestFileSystemIndexingModel
object
VM guest OS file indexing.
2 properties
1 required
GuestOsCredentialsModel
object
VM custom credentials.
3 properties
2 required
JobStatesFilters
object
Filters jobs by the specified parameters.
15 properties
ERetainLogBackupsType
string
Retention policy for the logs stored in the backup repository.
ActiveFullSettingsModel
object
Active full backup settings.
3 properties
1 required
EApplicationSettingsVSS
string
Behavior scenario for application-aware processing.
AdvancedStorageScheduleMonthlyModel
object
Monthly schedule settings.
5 properties
1 required
BackupIndexingSettingsModel
object
3 properties
1 required
GFSPolicySettingsModel
object
GFS retention policy settings.
4 properties
1 required
BackupStorageSettingsEncryptionModel
object
Encryption of backup files.
3 properties
1 required
ESessionState
string
State of the session.
ScheduleMonthlyModel
object
Monthly scheduling options.
6 properties
1 required
FullBackupMaintenanceModel
object
Maintenance settings for full backup files.
2 properties
JobsFilters
object
Filters jobs by the specified parameters.
6 properties
FullBackupMaintenanceDefragmentAndCompactModel
object
Compact operation settings.
3 properties
1 required
ETransactionLogsSettings
string
Transaction logs settings that define whether copy-only backups must be created, or transaction logs for Microsoft Exchange, Microsoft SQL and Oracle VMs must…
EJobStatesFiltersOrderColumn
string
Orders job states by the specified column.
EDayOfWeek
string
Day of the week.
BackupOracleSettingsModel
object
Oracle archived log settings.
10 properties
2 required
JobsResult
object
2 properties
2 required
PrimaryStorageIntegrationSettingsModel
object
Primary storage integration settings for the backup job.
4 properties
1 required
EStorageOptimization
string
Storage optimization that depends on the target type.
ScheduleRetryModel
object
Retry options.
3 properties
JobStopSpec
object
1 property
1 required
JobStateModel
object
13 properties
8 required
EBackupExclusionPolicy
string
Exclusion policy.
EBackupScriptProcessingMode
string
Scenario for scripts execution.
PaginationResult
object
Pagination settings.
4 properties
2 required
EEmailNotificationType
string
Type of email notification settings (global notification settings specified for the backup server, or custom notification settings specified for this job).
BackupLogShippingServersModel
object
Log shipping server used to transport logs.
2 properties
1 required
ESQLLogsProcessing
string
Type of transaction logs processing.
EScriptPeriodicityType
string
Type of script periodicity.
SyntheticFullSettingsModel
object
Synthetic full backup settings.
3 properties
1 required
EmailNotificationSettingsModel
object
Email notification settings for the backup job.
4 properties
1 required
ScheduleAfterThisJobModel
object
Job chaining options.
2 properties
1 required
GuestOsCredentialsPerMachineModel
object
3 properties
1 required
BackupJobExclusionsTemplates
object
VM templates exclusion.
2 properties
BackupJobAdvancedSettingsVSphereModel
object
VMware vSphere settings for the backup job.
2 properties
BackupJobAdvancedSettingsModel
object
Advanced settings of the backup job.
10 properties
1 required
EJobType
string
Type of the job.
BackupApplicationAwareProcessingModel
object
Application-aware processing settings.
2 properties
1 required
ScheduleDailyModel
object
Daily scheduling options.
4 properties
1 required
BackupWindowSettingModel
object
Time scheme that defines permitted days and hours for the job to start.
1 property
1 required
EmailCustomNotificationType
object
Custom notification settings.
5 properties
EJobStatus
string
Current status of the job.
BackupJobExclusionsSpec
object
Objects that you want to exclude from the backup.
3 properties
BackupJobVirtualMachinesModel
object
Included and excluded objects.
2 properties
1 required
BackupHealthCheckSettingsModels
object
Health check settings for the for the latest restore point in the backup chain.
3 properties
1 required
ScriptCommand
object
Script settings.
2 properties
1 required
SessionModel
object
13 properties
7 required
BackupJobRetentionPolicySettingsModel
object
Retention policy settings.
2 properties
2 required
BackupScriptSettingsModel
object
Pre-freeze and post-thaw scripts.
3 properties
1 required
NotificationSettingsModel
object
Notification settings for the backup job.
3 properties
ESessionResult
string
Result status.
GuestInteractionProxiesSettingsModel
object
Guest interaction proxy used to deploy the runtime process on the VM guest OS.
2 properties
1 required
BackupWindowsScriptModel
object
Paths to pre-freeze and post-thaw scripts for Microsoft Windows VMs.
2 properties
GFSPolicySettingsMonthlyModel
object
Monthly GFS retention policy.
3 properties
1 required
ECompressionLevel
string
Compression level.
ScheduleBackupWindowModel
object
Backup window settings.
2 properties
1 required
EVmwareInventoryType
string
Type of the VMware vSphere object.
BackupObjectIndexingModel
object
Guest OS indexing options for the VM.
2 properties
1 required
VmwareObjectSizeModel
object
2 properties
1 required
VSphereChangedBlockTrackingSettingsModel
object
CBT settings for the backup job.
3 properties
1 required
BaseJobSpec
object
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Veeam publishes across the network.
