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