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.0.0, at version 1.0-rev0.
Requests are made against the base URL https://localhost:9419.
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— 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), S3CompatibleStorageImportSpec (10 properties). Each schema is shown below with its type and property counts.
VmwareObjectDiskModel
object
4 properties
3 required
LinuxLocalStorageImportSpec
object
7 properties
8 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
JobScriptsSettingsModel
object
Script settings.
5 properties
ERepositoryConnectionType
string
Repository connection type (direct or through a gateway server).
GuestOsCredentialsPerMachineImportModel
object
3 properties
1 required
Error
object
3 properties
2 required
EVmwareDisksTypeToProcess
string
Type of disk selection.
EDayNumberInMonth
string
Week day number in the month.
BackupApplicationSettingsImportModel
object
8 properties
2 required
NetworkRepositorySettingsModel
object
Repository settings.
5 properties
AmazonS3GlacierStorageImportSpec
object
7 properties
7 required
SessionsResult
object
2 properties
2 required
GFSPolicySettingsYearlyModel
object
Yearly GFS retention policy.
3 properties
1 required
AzureArchiveStorageAccountImportModel
object
Account used to access the Azure Archive storage.
3 properties
3 required
AzureDataBoxStorageImportSpec
object
9 properties
7 required
EConsumptionLimitKind
string
Measurement unit.
WasabiCloudStorageImportSpec
object
10 properties
7 required
BackupFSExclusionsModel
object
VM guest OS file exclusion.
2 properties
1 required
NfsStorageImportSpec
object
7 properties
8 required
BackupScheduleModel
object
Job scheduling options.
8 properties
1 required
AdvancedStorageScheduleWeeklyModel
object
Weekly schedule settings.
2 properties
1 required
BackupLogShippingServersImportModel
object
Log shipping server used to transport logs.
2 properties
1 required
ECertificateFileFormatType
string
Certificate file format.
BackupStorageSettingModel
object
Storage settings.
6 properties
RepositoryImportSpecCollection
object
15 properties
EBackupOracleLogsSettings
string
Type of archived logs processing.
AzureArchiveStorageContainerModel
object
Azure Archive container where backup data is stored.
2 properties
2 required
EAzureRegionType
string
Region where your Microsoft Azure container is located.
EPeriodicallyKinds
string
Time unit for periodic job scheduling.
CloudCredentialsExportSpec
object
3 properties
ManageServerImportSpecCollection
object
3 properties
LinuxLocalRepositorySettingsModel
object
Repository settings.
7 properties
SessionResultModel
object
Session result.
3 properties
1 required
WindowsHostPortsModel
object
Veeam Backup & Replication components installed on the server and ports used by the components.
4 properties
ProxyImportSpecCollection
object
1 property
1 required
AzureBlobStorageAccountImportModel
object
Account used to access the Azure Blob storage.
3 properties
3 required
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
ESennightOfMonth
string
Sennight of the month.
ERotatedDriveCleanupMode
string
Cleanup mode: Disabled — continue the backup chain on an inserted drive. ClearBackupFolder — delete existing backups belonging to the job. ClearRepositoryFolde…
WindowsLocalStorageImportSpec
object
7 properties
8 required
BackupRepositoryImportModel
object
Backup repository.
2 properties
1 required
AmazonSnowballEdgeStorageAccountImportModel
object
AWS account used to access the AWS Snowball Edge storage.
4 properties
4 required
BackupWindowDayHoursModel
object
Hourly scheme for a day.
2 properties
2 required
ESessionType
string
Type of the session.
MountServerSettingsImportSpec
object
Settings for the mount server that is used for file-level and application items restore.
4 properties
3 required
ECredentialsType
string
Credentials type.
EGuestFSIndexingMode
string
Indexing mode.
VPowerNFSPortSettingsModel
object
Network ports used by the vPower NFS Service.
2 properties
BackupApplicationAwareProcessingImportModel
object
Application-aware processing settings.
2 properties
1 required
AzureBlobStorageContainerModel
object
Azure Blob storage container.
3 properties
2 required
SmbRepositoryShareSettingsSpec
object
Share settings.
3 properties
2 required
AmazonS3StorageBucketModel
object
Amazon S3 bucket where backup data is stored.
6 properties
3 required
JobImportSpec
object
8 properties
8 required
NotificationVmAttributeSettingsModel
object
VM attribute settings.
3 properties
1 required
AmazonCloudCredentialsImportSpec
object
5 properties
4 required
ERetentionPolicyType
string
Type of the retention policy.
EAzureComputeCredentialsDeploymentType
string
Deployment type (global Microsoft Azure or Microsoft Azure Stack Hub).
AzureStorageProxyModel
object
Azure storage proxy appliance.
6 properties
1 required
BackupProxyImportModel
object
3 properties
2 required
ObjectStorageConsumptionLimitModel
object
Soft consumption limit for the storage. The limit can be exceeded temporarily.
3 properties
ManageServerExportSpec
object
3 properties
BackupOracleSettingsImportModel
object
Oracle archived log settings.
10 properties
2 required
VmwareObjectModel
object
VMware vSphere object.
4 properties
3 required
SchedulePeriodicallyModel
object
Periodic scheduling options.
5 properties
1 required
WindowsHostComponentPortModel
object
Ports used by Veeam Backup & Replication components.
2 properties
2 required
EBackupProxyImportType
string
EmptySuccessResponse
object
Empty success response (200, 201, 204).
ERepositoryType
string
Repository type.
CredentialsImportModel
object
Credentials used for connection.
2 properties
1 required
RepositoryShareGatewayImportSpec
object
Settings for the gateway server.
2 properties
IBMCloudStorageAccountImportModel
object
Account used to access the IBM Cloud storage.
4 properties
4 required
EBackupModeType
string
Type of the backup method used to create a restore point.
CloudCredentialsImportSpecCollection
object
4 properties
1 required
BackupJobVirtualMachinesSpec
object
Arrays of objects that you want to back up or exclude from the backup.
2 properties
1 required
FullBackupMaintenanceRemoveDataModel
object
Backup data setting for deleted VMs.
2 properties
1 required
BackupSQLSettingsImportModel
object
Microsoft SQL Server transaction log settings.
5 properties
1 required
EDailyKinds
string
Kind of daily scheduling scheme.
GuestInteractionProxiesSettingsImportModel
object
Guest interaction proxy used to deploy the runtime process on the VM guest OS.
2 properties
1 required
GuestFileSystemIndexingModel
object
VM guest OS file indexing.
2 properties
1 required
BackupJobGuestProcessingImportModel
object
Guest processing settings.
4 properties
2 required
AzureDataBoxStorageAccountImportModel
object
Account used to access the Azure Data Box storage.
3 properties
3 required
LinuxHardenedStorageImportSpec
object
7 properties
8 required
ERetainLogBackupsType
string
Retention policy for the logs stored in the backup repository.
ActiveFullSettingsModel
object
Active full backup settings.
3 properties
1 required
ProxyDatastoreModel
object
2 properties
ProxyImportSpec
object
3 properties
3 required
AmazonS3StorageImportSpec
object
10 properties
7 required
CloudCredentialsImportModel
object
Cloud credentials used for connection.
3 properties
3 required
AzureBlobStorageImportSpec
object
10 properties
7 required
ProxyExportSpec
object
3 properties
EApplicationSettingsVSS
string
Behavior scenario for application-aware processing.
EWindowsHostComponentType
string
Veeam Backup & Replication component.
AdvancedStorageScheduleMonthlyModel
object
Monthly schedule settings.
5 properties
1 required
AmazonS3StorageProxyApplianceModel
object
Amazon S3 proxy appliance.
5 properties
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.
EProxyType
string
Type of the backup proxy.
S3CompatibleStorageAccountImportModel
object
Account used to access the S3 compatible storage.
4 properties
4 required
AmazonSnowballEdgeStorageBucketModel
object
Amazon S3 bucket.
3 properties
AmazonS3StorageAccountImportModel
object
Account used to access the Amazon S3 storage.
3 properties
3 required
FullBackupMaintenanceDefragmentAndCompactModel
object
Compact operation settings.
3 properties
1 required
JobExportSpec
object
3 properties
ScheduleMonthlyModel
object
Monthly scheduling options.
6 properties
1 required
FullBackupMaintenanceModel
object
Maintenance settings for full backup files.
2 properties
S3CompatibleStorageImportSpec
object
10 properties
7 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…
WindowsHostImportSpec
object
5 properties
3 required
EDayOfWeek
string
Day of the week.
GoogleCloudCredentialsImportSpec
object
5 properties
4 required
PrimaryStorageIntegrationSettingsModel
object
Primary storage integration settings for the backup job.
4 properties
1 required
GoogleCloudStorageImportSpec
object
9 properties
7 required
EStorageOptimization
string
Storage optimization that depends on the target type.
EBackupProxyTransportMode
string
Transport mode of the backup proxy.
S3CompatibleStorageBucketModel
object
Bucket where backup data is stored.
4 properties
2 required
SessionLogResult
object
Log of the session.
2 properties
ScheduleRetryModel
object
Retry options.
3 properties
BackupJobImportProxiesModel
object
Backup proxies.
2 properties
1 required
SmbStorageImportSpec
object
7 properties
8 required
AmazonS3IAStorageModel
object
Standard Infrequent Access.
2 properties
LinuxHardenedRepositorySettingsModel
object
Repository settings.
8 properties
ObjectStorageConnectionImportSpec
object
Object storage connection settings.
2 properties
1 required
AmazonSnowballEdgeStorageImportSpec
object
9 properties
7 required
EBackupExclusionPolicy
string
Exclusion policy.
ESessionsFiltersOrderColumn
string
WasabiCloudStorageAccountImportModel
object
Account used to access the Wasabi Cloud storage.
3 properties
3 required
AzureArchiveStorageImportSpec
object
7 properties
7 required
CredentialsExportSpec
object
4 properties
AzureComputeCloudCredentialsDeploymentModel
object
Environment to restore workloads to.
2 properties
1 required
EBackupScriptProcessingMode
string
Scenario for scripts execution.
EncryptionPasswordImportSpecCollection
object
1 property
PaginationResult
object
Pagination settings.
4 properties
2 required
EManagedServerType
string
Type of the server.
RepositoryAdvancedSettingsModel
object
Advanced settings for the backup repository.
5 properties
EEmailNotificationType
string
Type of email notification settings (global notification settings specified for the backup server, or custom notification settings specified for this job).
SessionsFilters
object
13 properties
WindowsLocalRepositorySettingsModel
object
Repository settings.
6 properties
NfsRepositoryShareSettingsSpec
object
2 properties
1 required
ProxyServerSettingsImportSpec
object
Settings of the server that is used as a backup proxy.
7 properties
1 required
ESQLLogsProcessing
string
Type of transaction logs processing.
EScriptPeriodicityType
string
Type of script periodicity.
SessionLogRecordModel
object
Record of the session log.
6 properties
SyntheticFullSettingsModel
object
Synthetic full backup settings.
3 properties
1 required
EmailNotificationSettingsModel
object
Email notification settings for the backup job.
4 properties
1 required
EViHostType
string
Type of the VMware vSphere server.
CredentialsLinuxSettingsImportModel
object
Additional Linux account settings.
7 properties
JobImportSpecCollection
object
1 property
1 required
ProxyDatastoreSettingsModel
object
Datastores to which the backup proxy has a direct SAN or NFS connection.
2 properties
1 required
ScheduleAfterThisJobModel
object
Job chaining options.
2 properties
1 required
ViHostImportSpec
object
7 properties
5 required
CredentialsImportSpecCollection
object
1 property
1 required
ObjectStorageImmutabilityModel
object
Object storage immutability.
2 properties
EncryptionPasswordImportSpec
object
3 properties
2 required
BackupJobExclusionsTemplates
object
VM templates exclusion.
2 properties
BackupJobAdvancedSettingsVSphereModel
object
VMware vSphere settings for the backup job.
2 properties
AzureDataBoxStorageContainerModel
object
Azure Data Box container where backup data is stored.
2 properties
EAmazonRegionType
string
AWS region type.
S3CompatibleProxyModel
object
Proxy appliance for the S3 compatible storage.
1 property
1 required
BackupJobAdvancedSettingsModel
object
Advanced settings of the backup job.
10 properties
1 required
EJobType
string
Type of the job.
IBMCloudStorageBucketModel
object
IBM Cloud bucket where backup data is stored.
4 properties
2 required
ETaskLogRecordStatus
string
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
BackupJobStorageImportModel
object
Backup storage settings.
5 properties
3 required
BackupJobExclusionsSpec
object
Objects that you want to exclude from the backup.
3 properties
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
GuestOsCredentialsImportModel
object
VM custom credentials.
2 properties
GoogleCloudStorageAccountImportModel
object
Account used to access the Google Cloud storage.
3 properties
3 required
BackupScriptSettingsModel
object
Pre-freeze and post-thaw scripts.
3 properties
1 required
EncryptionPasswordExportSpec
object
4 properties
AzureComputeCredentialsExistingAccountSpec
object
Existing Azure Active Directory application.
2 properties
2 required
LinuxHostSSHSettingsModel
object
SSH settings.
5 properties
NotificationSettingsModel
object
Notification settings for the backup job.
3 properties
ESessionResult
string
Result status.
LinuxHostImportSpec
object
6 properties
5 required
ECloudCredentialsType
string
Cloud credentials type.
BackupWindowsScriptModel
object
Paths to pre-freeze and post-thaw scripts for Microsoft Windows VMs.
2 properties
WasabiCloudStorageBucketModel
object
Wasabi bucket where backup data is stored.
4 properties
2 required
GFSPolicySettingsMonthlyModel
object
Monthly GFS retention policy.
3 properties
1 required
CredentialsImportSpec
object
6 properties
3 required
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
ECompressionLevel
string
Compression level.
AmazonS3GlacierStorageBucketModel
object
Amazon S3 Glacier bucket where backup data is stored.
5 properties
3 required
AzureStorageCloudCredentialsImportSpec
object
5 properties
4 required
AzureComputeCloudCredentialsImportSpec
object
5 properties
4 required
GoogleCloudStorageBucketModel
object
Google Cloud object storage bucket where backup data is stored.
4 properties
2 required
RepositoryExportSpec
object
3 properties
VSphereChangedBlockTrackingSettingsModel
object
CBT settings for the backup job.
3 properties
1 required
EMonth
string
Month.
IBMCloudStorageImportSpec
object
10 properties
7 required
CertificateUploadSpec
object
Certificate settings (for certificate-based authentication).
3 properties
2 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.