Veeam Automation API
The Automation section defines paths and operations for granular import and export of objects available in the REST API. It can be useful, for example, if you set up the backup infrastructure using JSON specification or migrate the infrastructure to another backup server. For details, see [Mass Deployment](https://helpcenter.veeam.com/docs/backup/vbr_rest/automation.html?ver=120).
Veeam Automation API is one of 55 APIs that Veeam publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Automation. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 18 operations across 18 paths, and defines 201 schemas. It is described by OpenAPI 3.2.0, at version 1.1-rev0.
Requests are made against a single base URL, /.
18 operations
18 paths
201 schemas
3 GET15 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Veeam Automation API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (Bearer).
By default, every request must be authenticated.
Bearer— Access token specified in the following format: Bearer .
Paths & Operations 18
Across 18 paths, the API surfaces 18 operations — 3 GET, 15 POST. Each is listed below with its method, path, parameters, and response codes.
Automation 18
The Automation section defines paths and operations for granular import and export of objects available in the REST API. It can be useful, for example, if you set up the backup in…
POST
/api/v1/automation/cloudcredentials/export
Export Cloud Credentials
POST
/api/v1/automation/cloudcredentials/import
Import Cloud Credentials
POST
/api/v1/automation/credentials/export
Export Credentials
POST
/api/v1/automation/credentials/import
Import Credentials
POST
/api/v1/automation/encryptionPasswords/export
Export Encryption Passwords
POST
/api/v1/automation/encryptionPasswords/import
Import Encryption Passwords
POST
/api/v1/automation/jobs/export
Export Jobs
POST
/api/v1/automation/jobs/import
Import Jobs
POST
/api/v1/automation/managedServers/export
Export Servers
POST
/api/v1/automation/managedServers/import
Import Servers
POST
/api/v1/automation/proxies/export
Export Proxies
POST
/api/v1/automation/proxies/import
Import Proxies
POST
/api/v1/automation/repositories/export
Export Repositories
POST
/api/v1/automation/repositories/import
Import Repositories
GET
/api/v1/automation/sessions
Get All Automation Sessions
GET
/api/v1/automation/sessions/{id}
Get Automation Session
GET
/api/v1/automation/sessions/{id}/logs
Get Automation Session Logs
POST
/api/v1/automation/sessions/{id}/stop
Stop Automation Session
Schemas 201
The contract defines 201 schemas that model the data the API accepts and returns. The most detailed are RepositoryImportSpecCollection (15 properties), SessionsFilters (13 properties), SessionModel (13 properties), WasabiCloudStorageImportSpec (10 properties). Each schema is shown below with its type and property counts.
ManageServerImportSpecCollection
object
3 properties
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
CredentialsLinuxSettingsImportModel
object
Additional Linux account settings.
7 properties
AmazonCloudCredentialsImportSpec
object
5 properties
4 required
EAzureComputeCredentialsDeploymentType
string
Deployment type (global Microsoft Azure or Microsoft Azure Stack Hub).
ActiveFullSettingsModel
object
Active full backup settings.
3 properties
1 required
SessionsFilters
object
13 properties
EBackupOracleLogsSettings
string
Type of archived logs processing.
ESessionsFiltersOrderColumn
string
EncryptionPasswordImportSpecCollection
object
1 property
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
WasabiCloudStorageAccountImportModel
object
Account used to access the Wasabi Cloud storage.
3 properties
3 required
GuestOsCredentialsPerMachineImportModel
object
3 properties
1 required
AzureArchiveStorageAccountImportModel
object
Account used to access the Azure Archive storage.
3 properties
3 required
S3CompatibleStorageBucketModel
object
Bucket where backup data is stored.
4 properties
2 required
LinuxLocalRepositorySettingsModel
object
Repository settings.
7 properties
WindowsHostImportSpec
object
5 properties
3 required
ObjectStorageConnectionImportSpec
object
Object storage connection settings.
2 properties
1 required
ECertificateFileFormatType
string
Certificate file format.
AzureDataBoxStorageAccountImportModel
object
Account used to access the Azure Data Box storage.
3 properties
3 required
GFSPolicySettingsModel
object
GFS retention policy settings.
4 properties
1 required
ERepositoryType
string
Repository type.
EBackupModeType
string
Type of the backup method used to create a restore point.
SessionsResult
object
2 properties
2 required
EViHostType
string
Type of the VMware vSphere server.
CredentialsImportSpecCollection
object
1 property
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
JobExportSpec
object
3 properties
BackupJobGuestProcessingImportModel
object
Guest processing settings.
4 properties
2 required
EStorageOptimization
string
Storage optimization that depends on the target type.
EScriptPeriodicityType
string
Type of script periodicity.
ECompressionLevel
string
Compression level.
SchedulePeriodicallyModel
object
Periodic scheduling options.
5 properties
1 required
ESennightOfMonth
string
Sennight of the month.
ESessionState
string
State of the session.
AzureComputeCloudCredentialsSubscriptionSpec
object
Microsoft Azure compute account. For password-based authentication, specify client secret. For certificate-based authentication, specify certificate and passwo…
4 properties
2 required
IBMCloudStorageAccountImportModel
object
Account used to access the IBM Cloud storage.
4 properties
4 required
ProxyImportSpecCollection
object
1 property
1 required
EGuestFSIndexingMode
string
Indexing mode.
S3CompatibleStorageImportSpec
object
10 properties
7 required
EMonth
string
Month.
EBackupProxyImportType
string
GFSPolicySettingsYearlyModel
object
Yearly GFS retention policy.
3 properties
1 required
AmazonS3IAStorageModel
object
Standard Infrequent Access.
2 properties
BackupApplicationAwareProcessingImportModel
object
Application-aware processing settings.
2 properties
1 required
CloudCredentialsImportSpecCollection
object
4 properties
1 required
AmazonS3GlacierStorageImportSpec
object
7 properties
7 required
RepositoryExportSpec
object
3 properties
EBackupScriptProcessingMode
string
Scenario for scripts execution.
WindowsLocalRepositorySettingsModel
object
Repository settings.
6 properties
BackupObjectIndexingModel
object
Guest OS indexing options for the VM.
2 properties
1 required
BackupJobAdvancedSettingsVSphereModel
object
VMware vSphere settings for the backup job.
2 properties
GuestOsCredentialsImportModel
object
VM custom credentials.
2 properties
AzureBlobStorageAccountImportModel
object
Account used to access the Azure Blob storage.
3 properties
3 required
ERotatedDriveCleanupMode
string
Cleanup mode: Disabled — continue the backup chain on an inserted drive. ClearBackupFolder — delete existing backups belonging to the job. ClearRepositoryFolde…
SessionModel
object
13 properties
7 required
BackupJobStorageImportModel
object
Backup storage settings.
5 properties
3 required
VSphereChangedBlockTrackingSettingsModel
object
CBT settings for the backup job.
3 properties
1 required
GoogleCloudStorageImportSpec
object
9 properties
7 required
IBMCloudStorageBucketModel
object
IBM Cloud bucket where backup data is stored.
4 properties
2 required
LinuxHardenedRepositorySettingsModel
object
Repository settings.
8 properties
BackupJobAdvancedSettingsModel
object
Advanced settings of the backup job.
10 properties
1 required
BackupJobImportProxiesModel
object
Backup proxies.
2 properties
1 required
AzureBlobStorageImportSpec
object
10 properties
7 required
BackupJobRetentionPolicySettingsModel
object
Retention policy settings.
2 properties
2 required
EAmazonRegionType
string
AWS region type.
WasabiCloudStorageBucketModel
object
Wasabi bucket where backup data is stored.
4 properties
2 required
ERepositoryConnectionType
string
Repository connection type (direct or through a gateway server).
FullBackupMaintenanceModel
object
Maintenance settings for full backup files.
2 properties
AzureBlobStorageContainerModel
object
Azure Blob storage container.
3 properties
2 required
AzureComputeCloudCredentialsDeploymentModel
object
Environment to restore workloads to.
2 properties
1 required
JobScriptsSettingsModel
object
Script settings.
5 properties
CredentialsImportSpec
object
6 properties
3 required
EManagedServerType
string
Type of the server.
ECloudCredentialsType
string
Cloud credentials type.
EDayOfWeek
string
Day of the week.
BackupScriptSettingsModel
object
Pre-freeze and post-thaw scripts.
3 properties
1 required
EncryptionPasswordExportSpec
object
4 properties
LinuxLocalStorageImportSpec
object
7 properties
8 required
ManageServerExportSpec
object
3 properties
AdvancedStorageScheduleWeeklyModel
object
Weekly schedule settings.
2 properties
1 required
BackupOracleSettingsImportModel
object
Oracle archived log settings.
10 properties
2 required
ERetentionPolicyType
string
Type of the retention policy.
CloudCredentialsExportSpec
object
3 properties
BackupScheduleModel
object
Job scheduling options.
8 properties
1 required
ProxyDatastoreSettingsModel
object
Datastores to which the backup proxy has a direct SAN or NFS connection.
2 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
GoogleCloudStorageAccountImportModel
object
Account used to access the Google Cloud storage.
3 properties
3 required
WasabiCloudStorageImportSpec
object
10 properties
7 required
BackupJobExclusionsSpec
object
Objects that you want to exclude from the backup.
3 properties
GFSPolicySettingsWeeklyModel
object
Weekly GFS retention policy.
3 properties
1 required
EncryptionPasswordImportSpec
object
3 properties
2 required
EVmwareDisksTypeToProcess
string
Type of disk selection.
AmazonS3StorageBucketModel
object
Amazon S3 bucket where backup data is stored.
6 properties
3 required
JobImportSpecCollection
object
1 property
1 required
ProxyExportSpec
object
3 properties
EApplicationSettingsVSS
string
Behavior scenario for application-aware processing.
EAzureRegionType
string
Region where your Microsoft Azure container is located.
EWindowsHostComponentType
string
Veeam Backup & Replication component.
NotificationSettingsModel
object
Notification settings for the backup job.
3 properties
AzureComputeCloudCredentialsImportSpec
object
5 properties
4 required
ESQLLogsProcessing
string
Type of transaction logs processing.
ProxyDatastoreModel
object
2 properties
ERetainLogBackupsType
string
Retention policy for the logs stored in the backup repository.
WindowsLocalStorageImportSpec
object
7 properties
8 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…
RepositoryImportSpecCollection
object
15 properties
AzureStorageProxyModel
object
Azure storage proxy appliance.
6 properties
1 required
FullBackupMaintenanceDefragmentAndCompactModel
object
Compact operation settings.
3 properties
1 required
NfsRepositoryShareSettingsSpec
object
2 properties
1 required
AzureArchiveStorageContainerModel
object
Azure Archive container where backup data is stored.
2 properties
2 required
CertificateUploadSpec
object
Certificate settings (for certificate-based authentication).
3 properties
2 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
EBackupProxyTransportMode
string
Transport mode of the backup proxy.
PaginationResult
object
Pagination settings.
4 properties
2 required
ECredentialsType
string
Credentials type.
EmptySuccessResponse
object
Empty success response (200, 201, 204).
WindowsHostComponentPortModel
object
Ports used by Veeam Backup & Replication components.
2 properties
2 required
AmazonS3StorageProxyApplianceModel
object
Amazon S3 proxy appliance.
5 properties
NfsStorageImportSpec
object
7 properties
8 required
ObjectStorageConsumptionLimitModel
object
Soft consumption limit for the storage. The limit can be exceeded temporarily.
3 properties
BackupSQLSettingsImportModel
object
Microsoft SQL Server transaction log settings.
5 properties
1 required
EDayNumberInMonth
string
Week day number in the month.
CredentialsExportSpec
object
4 properties
LinuxHardenedStorageImportSpec
object
7 properties
8 required
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.
AmazonSnowballEdgeStorageBucketModel
object
Amazon S3 bucket.
3 properties
EDailyKinds
string
Kind of daily scheduling scheme.
SyntheticFullSettingsModel
object
Synthetic full backup settings.
3 properties
1 required
IBMCloudStorageImportSpec
object
10 properties
7 required
S3CompatibleProxyModel
object
Proxy appliance for the S3 compatible storage.
1 property
1 required
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
ProxyImportSpec
object
3 properties
3 required
EVmwareInventoryType
string
Type of the VMware vSphere object.
GoogleCloudStorageBucketModel
object
Google Cloud object storage bucket where backup data is stored.
4 properties
2 required
LinuxHostImportSpec
object
6 properties
5 required
BackupStorageSettingModel
object
Storage settings.
6 properties
SmbStorageImportSpec
object
7 properties
8 required
ScriptCommand
object
Script settings.
2 properties
1 required
EmailCustomNotificationType
object
Custom notification settings.
5 properties
S3CompatibleStorageAccountImportModel
object
Account used to access the S3 compatible storage.
4 properties
4 required
EConsumptionLimitKind
string
Measurement unit.
BackupIndexingSettingsModel
object
3 properties
1 required
SmbRepositoryShareSettingsSpec
object
Share settings.
3 properties
2 required
AzureDataBoxStorageImportSpec
object
9 properties
7 required
EJobType
string
Type of the job.
ESessionResult
string
Result status.
ScheduleDailyModel
object
Daily scheduling options.
4 properties
1 required
BackupApplicationSettingsImportModel
object
8 properties
2 required
CloudCredentialsImportModel
object
Cloud credentials used for connection.
3 properties
3 required
RepositoryShareGatewayImportSpec
object
Settings for the gateway server.
2 properties
EProxyType
string
Type of the backup proxy.
BackupRepositoryImportModel
object
Backup repository.
2 properties
1 required
AmazonS3StorageAccountImportModel
object
Account used to access the Amazon S3 storage.
3 properties
3 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
MountServerSettingsImportSpec
object
Settings for the mount server that is used for file-level and application items restore.
4 properties
3 required
BackupStorageSettingsEncryptionModel
object
Encryption of backup files.
3 properties
1 required
AzureDataBoxStorageContainerModel
object
Azure Data Box container where backup data is stored.
2 properties
SessionResultModel
object
Session result.
3 properties
1 required
AmazonSnowballEdgeStorageImportSpec
object
9 properties
7 required
BackupProxyImportModel
object
3 properties
2 required
AmazonS3GlacierStorageBucketModel
object
Amazon S3 Glacier bucket where backup data is stored.
5 properties
3 required
ViHostImportSpec
object
7 properties
5 required
Error
object
3 properties
2 required
AmazonSnowballEdgeStorageAccountImportModel
object
AWS account used to access the AWS Snowball Edge storage.
4 properties
4 required
ScheduleMonthlyModel
object
Monthly scheduling options.
6 properties
1 required
BackupLogShippingServersImportModel
object
Log shipping server used to transport logs.
2 properties
1 required
ScheduleRetryModel
object
Retry options.
3 properties
SessionLogRecordModel
object
Record of the session log.
6 properties
ProxyServerSettingsImportSpec
object
Settings of the server that is used as a backup proxy.
7 properties
1 required
ETaskLogRecordStatus
string
RepositoryAdvancedSettingsModel
object
Advanced settings for the backup repository.
5 properties
NetworkRepositorySettingsModel
object
Repository settings.
5 properties
VPowerNFSPortSettingsModel
object
Network ports used by the vPower NFS Service.
2 properties
AzureArchiveStorageImportSpec
object
7 properties
7 required
WindowsHostPortsModel
object
Veeam Backup & Replication components installed on the server and ports used by the components.
4 properties
AmazonS3StorageImportSpec
object
10 properties
7 required
GoogleCloudCredentialsImportSpec
object
5 properties
4 required
GuestInteractionProxiesSettingsImportModel
object
Guest interaction proxy used to deploy the runtime process on the VM guest OS.
2 properties
1 required
VmwareObjectModel
object
VMware vSphere object.
4 properties
3 required
ObjectStorageImmutabilityModel
object
Object storage immutability.
2 properties
AzureComputeCredentialsExistingAccountSpec
object
Existing Azure Active Directory application.
2 properties
2 required
GFSPolicySettingsMonthlyModel
object
Monthly GFS retention policy.
3 properties
1 required
CredentialsImportModel
object
Credentials used for connection.
2 properties
1 required
LinuxHostSSHSettingsModel
object
SSH settings.
5 properties
JobImportSpec
object
8 properties
8 required
EmailNotificationSettingsModel
object
Email notification settings for the backup job.
4 properties
1 required
SessionLogResult
object
Log of the session.
2 properties
AzureStorageCloudCredentialsImportSpec
object
5 properties
4 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Veeam 12
Other APIs Veeam publishes across the network.
Veeam Backup & Replication REST API
Veeam Backup Enterprise Manager REST API
Veeam Backup for Microsoft 365 REST API
Veeam ONE REST API
Veeam Backup for AWS REST API
Veeam Backup for Microsoft Azure REST API
Veeam Backup for Google Cloud REST API
Veeam Recovery Orchestrator REST API
Veeam Agents API
Veeam AmazonConnections API
Veeam Backup Objects API
Veeam Backups API
#Automation
Where this information came from
This is an independent, third-party profile of Veeam Automation API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.