Automation

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.

Import Jobs

The HTTP POST request to the /api/v1/automation/jobs/import path allows you to import jobs to Veeam Backup & Replication.

NOTE
In this REST API version, you can import VMware vSphere backup jobs only.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
required

required

Array of objects (JobImportSpec) unique

Array of jobs.

Responses

201

An Automation session has been created to import the jobs. To check the progress, track the session state.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/jobs/import

Request samples

application/json

{"jobs": [{"name": "string",
"description": "string",
"isHighPriority": true,
"type": "Unknown",
"virtualMachines": {"includes": [{"platform": "VSphere",
"size": "string",
"hostName": "string",
"name": "string",
"type": "Unknown",
"objectId": "string",
"urn": "string",
"isEnabled": true,
"metadata": [{"field": null,
"data": null
}
]
}
],
"excludes": {"vms": [{"platform": "VSphere",
"size": "string",
"hostName": "string",
"name": "string",
"type": "Unknown",
"objectId": "string",
"urn": "string",
"isEnabled": true,
"metadata": [null
]
}
],
"disks": [{"vmObject": {"platform": null,
"size": null,
"hostName": null,
"name": null,
"type": null,
"objectId": null,
"urn": null,
"isEnabled": null,
"metadata": [ ]
},
"disksToProcess": "AllDisks",
"disks": [null
],
"removeFromVMConfiguration": true
}
],
"templates": {"isEnabled": true,
"excludeFromIncremental": true
}
}
},
"storage": {"backupRepository": {"name": "string",
"uniqueId": "string"
},
"backupProxies": {"automaticSelection": true,
"proxies": [{"name": "string",
"type": "vmware",
"uniqueId": "string"
}
]
},
"retentionPolicy": {"type": "RestorePoints",
"quantity": 0
},
"gfsPolicy": {"isEnabled": true,
"weekly": {"isEnabled": true,
"keepForNumberOfWeeks": 0,
"desiredTime": "monday"
},
"monthly": {"isEnabled": true,
"keepForNumberOfMonths": 0,
"desiredTime": "First"
},
"yearly": {"isEnabled": true,
"keepForNumberOfYears": 0,
"desiredTime": "January"
}
},
"advancedSettings": {"backupModeType": "Full",
"synthenticFulls": {"isEnabled": true,
"weekly": {"isEnabled": false,
"days": [null
],
"localTime": "14:15:22Z"
},
"monthly": {"isEnabled": true,
"dayOfWeek": "monday",
"dayNumberInMonth": "First",
"dayOfMonth": 0,
"months": [null
],
"localTime": "14:15:22Z",
"isLastDayOfMonth": true
}
},
"activeFulls": {"isEnabled": true,
"weekly": {"isEnabled": false,
"days": [null
],
"localTime": "14:15:22Z"
},
"monthly": {"isEnabled": true,
"dayOfWeek": "monday",
"dayNumberInMonth": "First",
"dayOfMonth": 0,
"months": [null
],
"localTime": "14:15:22Z",
"isLastDayOfMonth": true
}
},
"backupHealth": {"isEnabled": true,
"weekly": {"isEnabled": false,
"days": [null
],
"localTime": "14:15:22Z"
},
"monthly": {"isEnabled": true,
"dayOfWeek": "monday",
"dayNumberInMonth": "First",
"dayOfMonth": 0,
"months": [null
],
"localTime": "14:15:22Z",
"isLastDayOfMonth": true
}
},
"fullBackupMaintenance": {"RemoveData": {"isEnabled": true,
"afterDays": 0
},
"defragmentAndCompact": {"isEnabled": true,
"weekly": {"isEnabled": null,
"days": [ ],
"localTime": null
},
"monthly": {"isEnabled": null,
"dayOfWeek": null,
"dayNumberInMonth": null,
"dayOfMonth": null,
"months": [ ],
"localTime": null,
"isLastDayOfMonth": null
}
}
},
"storageData": {"inlineDataDedupEnabled": true,
"excludeSwapFileBlocks": true,
"excludeDeletedFileBlocks": true,
"compressionLevel": "Auto",
"storageOptimization": "256KB",
"encryption": {"isEnabled": true,
"encryptionType": "ByUserPassword",
"encryptionPasswordId": "c26b46c1-e3e5-424c-948f-0a3fa5a19ab7",
"encryptionPasswordUniqueId": "string",
"kmsServerId": "b99403b3-0207-49d5-b267-d9213abf6699"
}
},
"notifications": {"sendSNMPNotifications": true,
"emailNotifications": {"isEnabled": true,
"recipients": [null
],
"notificationType": "UseGlobalNotificationSettings",
"customNotificationSettings": {"subject": null,
"notifyOnSuccess": null,
"notifyOnWarning": null,
"notifyOnError": null,
"SuppressNotificationUntilLastRetry": null
}
},
"vmAttribute": {"isEnabled": true,
"notes": "string",
"appendToExistingValue": true
}
},
"vSphere": {"enableVMWareToolsQuiescence": true,
"changedBlockTracking": {"isEnabled": true,
"enableCBTautomatically": true,
"resetCBTonActiveFull": true
}
},
"storageIntegration": {"isEnabled": true,
"processedVmsLimitEnabled": true,
"processedVmsCount": 0,
"failoverToStandardBackup": true
},
"scripts": {"preCommand": {"isEnabled": true,
"command": "string"
},
"postCommand": {"isEnabled": true,
"command": "string"
},
"periodicityType": "Days",
"runScriptEvery": 0,
"dayOfWeek": ["monday"
]
}
}
},
"guestProcessing": {"applicationAwareProcessing": {"isEnabled": true,
"appSettings": [{"vmObject": {"platform": null,
"size": null,
"hostName": null,
"name": null,
"type": null,
"objectId": null,
"urn": null,
"isEnabled": null,
"metadata": [ ]
},
"vss": "requireSuccess",
"usePersistentGuestAgent": true,
"transactionLogs": "process",
"sql": {"logsProcessing": null,
"backupMinsCount": null,
"retainLogBackups": null,
"keepDaysCount": null,
"logShippingServers": null
},
"oracle": {"useGuestCredentials": null,
"credentials": null,
"archiveLogs": null,
"deleteHoursCount": null,
"deleteGBsCount": null,
"backupLogs": null,
"backupMinsCount": null,
"retainLogBackups": null,
"keepDaysCount": null,
"logShippingServers": null
},
"postgreSQL": {"useGuestCredentials": null,
"credentials": null,
"userConnectionType": null,
"backupLogs": null,
"backupMinsCount": null,
"retainLogBackups": null,
"keepDaysCount": null,
"tempArchiveLogsPath": null,
"logShippingServers": null
},
"exclusions": {"exclusionPolicy": null,
"itemsList": [ ]
},
"scripts": {"scriptProcessingMode": null,
"windowsScripts": null,
"linuxScripts": null
}
}
]
},
"guestFileSystemIndexing": {"isEnabled": true,
"indexingSettings": [{"vmObject": {"platform": null,
"size": null,
"hostName": null,
"name": null,
"type": null,
"objectId": null,
"urn": null,
"isEnabled": null,
"metadata": [ ]
},
"WindowsIndexing": {"guestFSIndexingMode": null,
"indexingList": [ ]
},
"LinuxIndexing": {"guestFSIndexingMode": null,
"indexingList": [ ]
}
}
]
},
"guestInteractionProxies": {"automaticSelection": true,
"proxies": ["string"
]
},
"guestCredentials": {"creds": {"credentialsName": "string",
"credentialsTag": "string"
},
"credentialsPerMachine": [{"windowsCreds": {"credentialsName": null,
"credentialsTag": null
},
"linuxCreds": {"credentialsName": null,
"credentialsTag": null
},
"vmObject": {"platform": null,
"size": null,
"hostName": null,
"name": null,
"type": null,
"objectId": null,
"urn": null,
"isEnabled": null,
"metadata": [ ]
},
"default": true
}
]
}
},
"schedule": {"runAutomatically": false,
"daily": {"isEnabled": true,
"localTime": "14:15:22Z",
"dailyKind": "Everyday",
"days": ["monday"
]
},
"monthly": {"isEnabled": false,
"localTime": "14:15:22Z",
"dayOfWeek": "monday",
"dayNumberInMonth": "First",
"dayOfMonth": 0,
"months": ["January"
],
"isLastDayOfMonth": true
},
"periodically": {"isEnabled": false,
"periodicallyKind": "Hours",
"frequency": 0,
"backupWindow": {"days": [{"day": null,
"hours": null
}
]
},
"startTimeWithinAnHour": 0
},
"continuously": {"isEnabled": false,
"backupWindow": {"days": [{"day": null,
"hours": null
}
]
}
},
"afterThisJob": {"isEnabled": true,
"jobName": "string"
},
"retry": {"isEnabled": false,
"retryCount": 3,
"awaitMinutes": 10
},
"backupWindow": {"isEnabled": false,
"backupWindow": {"days": [{"day": null,
"hours": null
}
]
}
}
}
}
]
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"sessionType": "Infrastructure",
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"state": "Stopped",
"progressPercent": 0,
"result": {"result": "None",
"message": "string",
"isCanceled": true
},
"resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
"resourceReference": "string",
"parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
"usn": 0,
"platformName": "VMware",
"platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
"initiatedBy": "string"
}

Export Jobs

The HTTP POST request to the /api/v1/automation/jobs/export path allows you to export jobs from Veeam Backup & Replication.

NOTE
In this REST API version, you can export VMware vSphere backup jobs only.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
optional

ids	Array of strings <uuid> unique Array of job IDs.
types	Array of strings unique Array of job types.
names	Array of strings unique Array of job names. Wildcard characters are supported.

Responses

200

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/jobs/export

Request samples

application/json

{"ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"types": ["string"
],
"names": ["string"
]
}

Response samples

application/json

{"jobs": [{"name": "string",
"description": "string",
"isHighPriority": true,
"type": "Unknown",
"virtualMachines": {"includes": [{"platform": "VSphere",
"size": "string",
"hostName": "string",
"name": "string",
"type": "Unknown",
"objectId": "string",
"urn": "string",
"isEnabled": true,
"metadata": [{"field": null,
"data": null
}
]
}
],
"excludes": {"vms": [{"platform": "VSphere",
"size": "string",
"hostName": "string",
"name": "string",
"type": "Unknown",
"objectId": "string",
"urn": "string",
"isEnabled": true,
"metadata": [null
]
}
],
"disks": [{"vmObject": {"platform": null,
"size": null,
"hostName": null,
"name": null,
"type": null,
"objectId": null,
"urn": null,
"isEnabled": null,
"metadata": [ ]
},
"disksToProcess": "AllDisks",
"disks": [null
],
"removeFromVMConfiguration": true
}
],
"templates": {"isEnabled": true,
"excludeFromIncremental": true
}
}
},
"storage": {"backupRepository": {"name": "string",
"uniqueId": "string"
},
"backupProxies": {"automaticSelection": true,
"proxies": [{"name": "string",
"type": "vmware",
"uniqueId": "string"
}
]
},
"retentionPolicy": {"type": "RestorePoints",
"quantity": 0
},
"gfsPolicy": {"isEnabled": true,
"weekly": {"isEnabled": true,
"keepForNumberOfWeeks": 0,
"desiredTime": "monday"
},
"monthly": {"isEnabled": true,
"keepForNumberOfMonths": 0,
"desiredTime": "First"
},
"yearly": {"isEnabled": true,
"keepForNumberOfYears": 0,
"desiredTime": "January"
}
},
"advancedSettings": {"backupModeType": "Full",
"synthenticFulls": {"isEnabled": true,
"weekly": {"isEnabled": false,
"days": [null
],
"localTime": "14:15:22Z"
},
"monthly": {"isEnabled": true,
"dayOfWeek": "monday",
"dayNumberInMonth": "First",
"dayOfMonth": 0,
"months": [null
],
"localTime": "14:15:22Z",
"isLastDayOfMonth": true
}
},
"activeFulls": {"isEnabled": true,
"weekly": {"isEnabled": false,
"days": [null
],
"localTime": "14:15:22Z"
},
"monthly": {"isEnabled": true,
"dayOfWeek": "monday",
"dayNumberInMonth": "First",
"dayOfMonth": 0,
"months": [null
],
"localTime": "14:15:22Z",
"isLastDayOfMonth": true
}
},
"backupHealth": {"isEnabled": true,
"weekly": {"isEnabled": false,
"days": [null
],
"localTime": "14:15:22Z"
},
"monthly": {"isEnabled": true,
"dayOfWeek": "monday",
"dayNumberInMonth": "First",
"dayOfMonth": 0,
"months": [null
],
"localTime": "14:15:22Z",
"isLastDayOfMonth": true
}
},
"fullBackupMaintenance": {"RemoveData": {"isEnabled": true,
"afterDays": 0
},
"defragmentAndCompact": {"isEnabled": true,
"weekly": {"isEnabled": null,
"days": [ ],
"localTime": null
},
"monthly": {"isEnabled": null,
"dayOfWeek": null,
"dayNumberInMonth": null,
"dayOfMonth": null,
"months": [ ],
"localTime": null,
"isLastDayOfMonth": null
}
}
},
"storageData": {"inlineDataDedupEnabled": true,
"excludeSwapFileBlocks": true,
"excludeDeletedFileBlocks": true,
"compressionLevel": "Auto",
"storageOptimization": "256KB",
"encryption": {"isEnabled": true,
"encryptionType": "ByUserPassword",
"encryptionPasswordId": "c26b46c1-e3e5-424c-948f-0a3fa5a19ab7",
"encryptionPasswordUniqueId": "string",
"kmsServerId": "b99403b3-0207-49d5-b267-d9213abf6699"
}
},
"notifications": {"sendSNMPNotifications": true,
"emailNotifications": {"isEnabled": true,
"recipients": [null
],
"notificationType": "UseGlobalNotificationSettings",
"customNotificationSettings": {"subject": null,
"notifyOnSuccess": null,
"notifyOnWarning": null,
"notifyOnError": null,
"SuppressNotificationUntilLastRetry": null
}
},
"vmAttribute": {"isEnabled": true,
"notes": "string",
"appendToExistingValue": true
}
},
"vSphere": {"enableVMWareToolsQuiescence": true,
"changedBlockTracking": {"isEnabled": true,
"enableCBTautomatically": true,
"resetCBTonActiveFull": true
}
},
"storageIntegration": {"isEnabled": true,
"processedVmsLimitEnabled": true,
"processedVmsCount": 0,
"failoverToStandardBackup": true
},
"scripts": {"preCommand": {"isEnabled": true,
"command": "string"
},
"postCommand": {"isEnabled": true,
"command": "string"
},
"periodicityType": "Days",
"runScriptEvery": 0,
"dayOfWeek": ["monday"
]
}
}
},
"guestProcessing": {"applicationAwareProcessing": {"isEnabled": true,
"appSettings": [{"vmObject": {"platform": null,
"size": null,
"hostName": null,
"name": null,
"type": null,
"objectId": null,
"urn": null,
"isEnabled": null,
"metadata": [ ]
},
"vss": "requireSuccess",
"usePersistentGuestAgent": true,
"transactionLogs": "process",
"sql": {"logsProcessing": null,
"backupMinsCount": null,
"retainLogBackups": null,
"keepDaysCount": null,
"logShippingServers": null
},
"oracle": {"useGuestCredentials": null,
"credentials": null,
"archiveLogs": null,
"deleteHoursCount": null,
"deleteGBsCount": null,
"backupLogs": null,
"backupMinsCount": null,
"retainLogBackups": null,
"keepDaysCount": null,
"logShippingServers": null
},
"postgreSQL": {"useGuestCredentials": null,
"credentials": null,
"userConnectionType": null,
"backupLogs": null,
"backupMinsCount": null,
"retainLogBackups": null,
"keepDaysCount": null,
"tempArchiveLogsPath": null,
"logShippingServers": null
},
"exclusions": {"exclusionPolicy": null,
"itemsList": [ ]
},
"scripts": {"scriptProcessingMode": null,
"windowsScripts": null,
"linuxScripts": null
}
}
]
},
"guestFileSystemIndexing": {"isEnabled": true,
"indexingSettings": [{"vmObject": {"platform": null,
"size": null,
"hostName": null,
"name": null,
"type": null,
"objectId": null,
"urn": null,
"isEnabled": null,
"metadata": [ ]
},
"WindowsIndexing": {"guestFSIndexingMode": null,
"indexingList": [ ]
},
"LinuxIndexing": {"guestFSIndexingMode": null,
"indexingList": [ ]
}
}
]
},
"guestInteractionProxies": {"automaticSelection": true,
"proxies": ["string"
]
},
"guestCredentials": {"creds": {"credentialsName": "string",
"credentialsTag": "string"
},
"credentialsPerMachine": [{"windowsCreds": {"credentialsName": null,
"credentialsTag": null
},
"linuxCreds": {"credentialsName": null,
"credentialsTag": null
},
"vmObject": {"platform": null,
"size": null,
"hostName": null,
"name": null,
"type": null,
"objectId": null,
"urn": null,
"isEnabled": null,
"metadata": [ ]
},
"default": true
}
]
}
},
"schedule": {"runAutomatically": false,
"daily": {"isEnabled": true,
"localTime": "14:15:22Z",
"dailyKind": "Everyday",
"days": ["monday"
]
},
"monthly": {"isEnabled": false,
"localTime": "14:15:22Z",
"dayOfWeek": "monday",
"dayNumberInMonth": "First",
"dayOfMonth": 0,
"months": ["January"
],
"isLastDayOfMonth": true
},
"periodically": {"isEnabled": false,
"periodicallyKind": "Hours",
"frequency": 0,
"backupWindow": {"days": [{"day": null,
"hours": null
}
]
},
"startTimeWithinAnHour": 0
},
"continuously": {"isEnabled": false,
"backupWindow": {"days": [{"day": null,
"hours": null
}
]
}
},
"afterThisJob": {"isEnabled": true,
"jobName": "string"
},
"retry": {"isEnabled": false,
"retryCount": 3,
"awaitMinutes": 10
},
"backupWindow": {"isEnabled": false,
"backupWindow": {"days": [{"day": null,
"hours": null
}
]
}
}
}
}
]
}

Import Credentials

The HTTP POST request to the /api/v1/automation/credentials/import path allows you to import credentials to Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
required

required

Array of objects (CredentialsImportSpec) unique

Array of credentials.

Responses

201

An Automation session has been created to import the credentials. To check the progress, track the session state.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/credentials/import

Request samples

application/json

{"credentials": [{"username": "string",
"password": "string",
"description": "string",
"uniqueId": "string",
"type": "Standard",
"linuxAdditionalSettings": {"SSHPort": 0,
"elevateToRoot": true,
"addToSudoers": true,
"useSu": true,
"privateKey": "string",
"passphrase": "string",
"rootPassword": "string"
}
}
]
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"sessionType": "Infrastructure",
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"state": "Stopped",
"progressPercent": 0,
"result": {"result": "None",
"message": "string",
"isCanceled": true
},
"resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
"resourceReference": "string",
"parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
"usn": 0,
"platformName": "VMware",
"platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
"initiatedBy": "string"
}

Export Credentials

The HTTP POST request to the /api/v1/automation/credentials/export path allows you to export credentials from Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
optional

showHiddenCreds	boolean If `true`, service credentials are exported.
ids	Array of strings <uuid> unique Array of credentials IDs.
types	Array of strings (ECredentialsType) unique Array of credentials types. Items Enum: "Standard" "Linux" "ManagedService"
names	Array of strings unique Array of credentials user names. Wildcard characters are supported.

Responses

200

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/credentials/export

Request samples

application/json

{"showHiddenCreds": true,
"ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"types": ["Standard"
],
"names": ["string"
]
}

Response samples

application/json

{"credentials": [{"username": "string",
"password": "string",
"description": "string",
"uniqueId": "string",
"type": "Standard",
"linuxAdditionalSettings": {"SSHPort": 0,
"elevateToRoot": true,
"addToSudoers": true,
"useSu": true,
"privateKey": "string",
"passphrase": "string",
"rootPassword": "string"
}
}
]
}

Import Cloud Credentials

The HTTP POST request to the /api/v1/automation/cloudcredentials/import path allows you to import cloud credentials to Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
required

	Array of objects (AzureStorageCloudCredentialsImportSpec) unique Array of Azure storage accounts.
	Array of objects (AzureComputeCloudCredentialsImportSpec) unique Array of Azure compute accounts.
	Array of objects (AmazonCloudCredentialsImportSpec) unique Array of AWS accounts.
	Array of objects (GoogleCloudCredentialsImportSpec) unique Array of Google accounts.

Responses

201

An Automation session has been created to import the cloud credentials. To check the progress, track the session state.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/cloudcredentials/import

Request samples

application/json

{"azureStorage": [{"type": "AzureStorage",
"description": "string",
"uniqueId": "string",
"account": "string",
"sharedKey": "string"
}
],
"azureCompute": [{"type": "AzureStorage",
"description": "string",
"uniqueId": "string",
"connectionName": "string",
"existingAccount": {"deployment": {"deploymentType": "MicrosoftAzure",
"region": "China"
},
"subscription": {"tenantId": "string",
"applicationId": "string",
"secret": "string",
"certificate": {"certificate": "string",
"formatType": "pfx",
"password": "string"
}
}
}
}
],
"amazon": [{"type": "AzureStorage",
"description": "string",
"uniqueId": "string",
"accessKey": "string",
"secretKey": "string"
}
],
"google": [{"type": "AzureStorage",
"description": "string",
"uniqueId": "string",
"accessKey": "string",
"secretKey": "string"
}
]
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"sessionType": "Infrastructure",
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"state": "Stopped",
"progressPercent": 0,
"result": {"result": "None",
"message": "string",
"isCanceled": true
},
"resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
"resourceReference": "string",
"parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
"usn": 0,
"platformName": "VMware",
"platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
"initiatedBy": "string"
}

Export Cloud Credentials

The HTTP POST request to the /api/v1/automation/cloudcredentials/export path allows you to export cloud credentials from Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
optional

ids	Array of strings <uuid> unique Array of cloud credentials IDs that you want to export.
types	Array of strings (ECloudCredentialsType) unique Array of cloud credentials types that you want to export. Items Enum: "AzureStorage" "AzureCompute" "Amazon" "Google" "GoogleService"
names	Array of strings unique Array of cloud credentials user names. Wildcard characters are supported.

Responses

200

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/cloudcredentials/export

Request samples

application/json

{"ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"types": ["AzureStorage"
],
"names": ["string"
]
}

Response samples

application/json

{"azureStorage": [{"type": "AzureStorage",
"description": "string",
"uniqueId": "string",
"account": "string",
"sharedKey": "string"
}
],
"azureCompute": [{"type": "AzureStorage",
"description": "string",
"uniqueId": "string",
"connectionName": "string",
"existingAccount": {"deployment": {"deploymentType": "MicrosoftAzure",
"region": "China"
},
"subscription": {"tenantId": "string",
"applicationId": "string",
"secret": "string",
"certificate": {"certificate": "string",
"formatType": "pfx",
"password": "string"
}
}
}
}
],
"amazon": [{"type": "AzureStorage",
"description": "string",
"uniqueId": "string",
"accessKey": "string",
"secretKey": "string"
}
],
"google": [{"type": "AzureStorage",
"description": "string",
"uniqueId": "string",
"accessKey": "string",
"secretKey": "string"
}
]
}

Import Proxies

The HTTP POST request to the /api/v1/automation/proxies/import path allows you to import backup proxies to Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
required

required

Array of objects (ProxyImportSpec) unique

Array of backup proxies.

Responses

201

An Automation session has been created to import the proxies. To check the progress, track the session state.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/proxies/import

Request samples

application/json

{"proxies": [{"description": "string",
"type": "ViProxy",
"server": {"hostName": "string",
"hostUniqueId": "string",
"transportMode": "auto",
"failoverToNetwork": true,
"hostToProxyEncryption": true,
"connectedDatastores": {"autoSelectEnabled": true,
"datastores": [{"datastore": {"platform": null,
"size": null,
"hostName": null,
"name": null,
"type": null,
"objectId": null,
"urn": null,
"isEnabled": null,
"metadata": [ ]
},
"vmCount": 0
}
]
},
"maxTaskCount": 0
}
}
]
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"sessionType": "Infrastructure",
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"state": "Stopped",
"progressPercent": 0,
"result": {"result": "None",
"message": "string",
"isCanceled": true
},
"resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
"resourceReference": "string",
"parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
"usn": 0,
"platformName": "VMware",
"platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
"initiatedBy": "string"
}

Export Proxies

The HTTP POST request to the /api/v1/automation/proxies/export path allows you to export backup proxies from Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
optional

ids	Array of strings <uuid> unique Array of backup proxy IDs.
types	Array of strings (EProxyType) unique Array of backup proxy types. Items Enum: "ViProxy" "HvProxy" "GeneralPurposeProxy"
names	Array of strings unique Array of backup proxy names. Wildcard characters are supported.

Responses

200

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/proxies/export

Request samples

application/json

{"ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"types": ["ViProxy"
],
"names": ["string"
]
}

Response samples

application/json

{"proxies": [{"description": "string",
"type": "ViProxy",
"server": {"hostName": "string",
"hostUniqueId": "string",
"transportMode": "auto",
"failoverToNetwork": true,
"hostToProxyEncryption": true,
"connectedDatastores": {"autoSelectEnabled": true,
"datastores": [{"datastore": {"platform": null,
"size": null,
"hostName": null,
"name": null,
"type": null,
"objectId": null,
"urn": null,
"isEnabled": null,
"metadata": [ ]
},
"vmCount": 0
}
]
},
"maxTaskCount": 0
}
}
]
}

Import Servers

The HTTP POST request to the /api/v1/automation/managedServers/import path allows you to import managed servers to Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
required

	Array of objects (WindowsHostImportSpec) unique Array of managed Microsoft Windows servers.
	Array of objects (LinuxHostImportSpec) unique Array of managed Linux servers.
	Array of objects (ViHostImportSpec) unique Array of VMware vSphere servers.
	Array of objects (CloudDirectorHostImportSpec) unique Array of VMware Cloud Director servers.

Responses

201

An Automation session has been created to import the servers. To check the progress, track the session state.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/managedServers/import

Request samples

application/json

{"windowsHosts": [{"name": "string",
"description": "string",
"type": "WindowsHost",
"credentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"networkSettings": {"components": [{"componentName": "TransportSvc",
"port": 0
}
],
"portRangeStart": 0,
"portRangeEnd": 0,
"serverSide": true
}
}
],
"linuxHosts": [{"name": "string",
"description": "string",
"type": "WindowsHost",
"credentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"sshSettings": {"components": [{"componentName": "TransportSvc",
"port": 0
}
],
"sshTimeOutMs": 200,
"portRangeStart": 65535,
"portRangeEnd": 65535,
"serverSide": true
},
"sshFingerprint": "string"
}
],
"viHosts": [{"name": "string",
"description": "string",
"type": "WindowsHost",
"viHostType": "ESX",
"credentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"port": 0,
"certificateThumbprint": "string"
}
],
"cloudDirectorHosts": [{"name": "string",
"description": "string",
"type": "WindowsHost",
"credentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"certificateThumbprint": "string",
"url": "string",
"viServers": [{"viServerName": "string",
"viCredentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"certificateThumbprint": "string"
}
]
}
]
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"sessionType": "Infrastructure",
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"state": "Stopped",
"progressPercent": 0,
"result": {"result": "None",
"message": "string",
"isCanceled": true
},
"resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
"resourceReference": "string",
"parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
"usn": 0,
"platformName": "VMware",
"platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
"initiatedBy": "string"
}

Export Servers

The HTTP POST request to the /api/v1/automation/managedServers/export path allows you to export managed servers from Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
optional

ids	Array of strings <uuid> unique Array of server IDs.
types	Array of strings (EManagedServerType) unique Array of server types. Items Enum: "WindowsHost" "LinuxHost" "ViHost" "CloudDirectorHost" "HvServer" "HvCluster" "SCVMM" "SmbV3Cluster" "SmbV3StandaloneHost"
names	Array of strings unique Array of server names. Wildcard characters are supported.

Responses

200

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/managedServers/export

Request samples

application/json

{"ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"types": ["WindowsHost"
],
"names": ["string"
]
}

Response samples

application/json

{"windowsHosts": [{"name": "string",
"description": "string",
"type": "WindowsHost",
"credentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"networkSettings": {"components": [{"componentName": "TransportSvc",
"port": 0
}
],
"portRangeStart": 0,
"portRangeEnd": 0,
"serverSide": true
}
}
],
"linuxHosts": [{"name": "string",
"description": "string",
"type": "WindowsHost",
"credentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"sshSettings": {"components": [{"componentName": "TransportSvc",
"port": 0
}
],
"sshTimeOutMs": 200,
"portRangeStart": 65535,
"portRangeEnd": 65535,
"serverSide": true
},
"sshFingerprint": "string"
}
],
"viHosts": [{"name": "string",
"description": "string",
"type": "WindowsHost",
"viHostType": "ESX",
"credentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"port": 0,
"certificateThumbprint": "string"
}
],
"cloudDirectorHosts": [{"name": "string",
"description": "string",
"type": "WindowsHost",
"credentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"certificateThumbprint": "string",
"url": "string",
"viServers": [{"viServerName": "string",
"viCredentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"certificateThumbprint": "string"
}
]
}
]
}

Import Repositories

The HTTP POST request to the /api/v1/automation/repositories/import path allows you to import backup repositories to Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
required

	Array of objects (WindowsLocalStorageImportSpec) unique Array of Microsoft Windows-based repositories.
	Array of objects (LinuxLocalStorageImportSpec) unique Array of Linux-based repositories.
	Array of objects (SmbStorageImportSpec) unique Array of SMB backup repositories.
	Array of objects (NfsStorageImportSpec) unique Array of NFS backup repositories.
	Array of objects (AzureBlobStorageImportSpec) unique Array of Microsoft Azure Blob storages.
	Array of objects (AzureDataBoxStorageImportSpec) unique Array of Microsoft Azure Data Box storages.
	Array of objects (AmazonS3StorageImportSpec) unique Array of Amazon S3 storages.
	Array of objects (AmazonSnowballEdgeStorageImportSpec) unique Array of AWS Snowball Edge storages.
	Array of objects (S3CompatibleStorageImportSpec) unique Array of S3 compatible storages.
	Array of objects (GoogleCloudStorageImportSpec) unique Array of Google Cloud storages.
	Array of objects (IBMCloudStorageImportSpec) unique Array of IBM Cloud storages.
	Array of objects (AmazonS3GlacierStorageImportSpec) unique Array of Amazon S3 Glacier storages.
	Array of objects (AzureArchiveStorageImportSpec) unique Array of Microsoft Azure Archive storages.
	Array of objects (WasabiCloudStorageImportSpec) unique Array of Wasabi Cloud storages.
	Array of objects (LinuxHardenedStorageImportSpec) unique Array of Linux hardened repositories.

Responses

201

An Automation session has been created to import the repositories. To check the progress, track the session state.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/repositories/import

Request samples

application/json

{"WindowsLocalRepositories": [{"name": "string",
"description": "string",
"uniqueId": "string",
"hostName": "string",
"type": "WinLocal",
"repository": {"path": "string",
"taskLimitEnabled": true,
"maxTaskCount": 0,
"readWriteLimitEnabled": true,
"readWriteRate": 0,
"advancedSettings": {"alignDataBlocks": true,
"decompressBeforeStoring": true,
"rotatedDrives": true,
"perVmBackup": true,
"RotatedDriveCleanupMode": "Disabled"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"LinuxLocalRepositories": [{"name": "string",
"description": "string",
"uniqueId": "string",
"hostName": "string",
"type": "WinLocal",
"repository": {"path": "string",
"taskLimitEnabled": true,
"maxTaskCount": 0,
"readWriteLimitEnabled": true,
"readWriteRate": 0,
"useFastCloningOnXFSVolumes": true,
"advancedSettings": {"alignDataBlocks": true,
"decompressBeforeStoring": true,
"rotatedDrives": true,
"perVmBackup": true,
"RotatedDriveCleanupMode": "Disabled"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"SmbRepositories": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"share": {"sharePath": "string",
"credentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"gatewayServer": {"autoSelectEnabled": true,
"gatewayServerName": "string"
}
},
"repository": {"taskLimitEnabled": true,
"maxTaskCount": 0,
"readWriteLimitEnabled": true,
"readWriteRate": 0,
"advancedSettings": {"alignDataBlocks": true,
"decompressBeforeStoring": true,
"rotatedDrives": true,
"perVmBackup": true,
"RotatedDriveCleanupMode": "Disabled"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"NfsRepositories": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"share": {"sharePath": "string",
"gatewayServer": {"autoSelectEnabled": true,
"gatewayServerName": "string"
}
},
"repository": {"taskLimitEnabled": true,
"maxTaskCount": 0,
"readWriteLimitEnabled": true,
"readWriteRate": 0,
"advancedSettings": {"alignDataBlocks": true,
"decompressBeforeStoring": true,
"rotatedDrives": true,
"perVmBackup": true,
"RotatedDriveCleanupMode": "Disabled"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"AzureBlobStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"regionType": "China",
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"container": {"containerName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
}
},
"proxyAppliance": {"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"instanceSize": "string",
"resourceGroup": "string",
"virtualNetwork": "string",
"subnet": "string",
"redirectorPort": 0
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"AzureDataBoxStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"serviceEndpoint": "string",
"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"container": {"containerName": "string",
"folderName": "string"
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"AmazonS3Storages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"regionType": "China",
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"regionId": "string",
"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
},
"infrequentAccessStorage": {"isEnabled": true,
"singleZoneEnabled": true
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
},
"proxyAppliance": {"ec2InstanceType": "string",
"vpcName": "string",
"vpcId": "string",
"subnetName": "string",
"subnetId": "string",
"securityGroup": "string",
"redirectorPort": 0
}
}
],
"AmazonSnowballEdgeStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"servicePoint": "string",
"regionId": "string",
"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"S3CompatibleStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"servicePoint": "string",
"regionId": "string",
"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
},
"proxyAppliance": {"managedServerId": "5f0be415-00a3-4fc5-b6ca-5b802e95ca87"
}
}
],
"GoogleCloudStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"regionId": "string",
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"nearlineStorageEnabled": true,
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"IBMCloudStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"servicePoint": "string",
"regionId": "string",
"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
},
"proxyAppliance": {"managedServerId": "5f0be415-00a3-4fc5-b6ca-5b802e95ca87"
}
}
],
"AmazonS3GlacierStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"account": {"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"regionType": "China",
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"regionId": "string",
"bucketName": "string",
"folderName": "string",
"immutabilityEnabled": true,
"useDeepArchive": true
},
"proxyAppliance": {"ec2InstanceType": "string",
"vpcName": "string",
"vpcId": "string",
"subnetName": "string",
"subnetId": "string",
"securityGroup": "string",
"redirectorPort": 0
}
}
],
"AzureArchiveStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"account": {"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"regionType": "China",
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"container": {"containerName": "string",
"folderName": "string",
"immutabilityEnabled": true
},
"proxyAppliance": {"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"instanceSize": "string",
"resourceGroup": "string",
"virtualNetwork": "string",
"subnet": "string",
"redirectorPort": 0
}
}
],
"WasabiCloudStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"regionId": "string",
"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
},
"proxyAppliance": {"managedServerId": "5f0be415-00a3-4fc5-b6ca-5b802e95ca87"
}
}
],
"LinuxHardenedRepositories": [{"name": "string",
"description": "string",
"uniqueId": "string",
"hostName": "string",
"type": "WinLocal",
"repository": {"path": "string",
"taskLimitEnabled": true,
"maxTaskCount": 0,
"readWriteLimitEnabled": true,
"readWriteRate": 0,
"useFastCloningOnXFSVolumes": true,
"makeRecentBackupsImmutableDays": 0,
"advancedSettings": {"alignDataBlocks": true,
"decompressBeforeStoring": true,
"rotatedDrives": true,
"perVmBackup": true,
"RotatedDriveCleanupMode": "Disabled"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
]
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"sessionType": "Infrastructure",
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"state": "Stopped",
"progressPercent": 0,
"result": {"result": "None",
"message": "string",
"isCanceled": true
},
"resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
"resourceReference": "string",
"parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
"usn": 0,
"platformName": "VMware",
"platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
"initiatedBy": "string"
}

Export Repositories

The HTTP POST request to the /api/v1/automation/repositories/export path allows you to export backup repositories from Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
optional

ids	Array of strings <uuid> unique Array of repository IDs.
types	Array of strings (ERepositoryType) unique Array of repository types. Items Enum: "WinLocal" "LinuxLocal" "Smb" "Nfs" "AzureBlob" "AzureDataBox" "AzureArchive" "AmazonS3" "AmazonSnowballEdge" "AmazonS3Glacier" "S3Compatible" "GoogleCloud" "IBMCloud" "ExtendableRepository" "DDBoost" "ExaGrid" "HPStoreOnceIntegration" "Quantum" "WasabiCloud" "LinuxHardened" "Infinidat" "Fujitsu" "VeeamDataCloudVault" "S3GlacierCompatible" "SmartObjectS3" "Cloud" "HPStoreOnce" "Foreign" "SanSnapshotOnly" "Tape" "AmazonS3External" "AzureStorageExternal" "PlatformServiceExternal" "GoogleCloudStorageExternal" "PlatformServiceVmbApi" "AmazonS3GlacierExternal" "GoogleArchiveStorageExternal" "AzureArchiveStorageExternal" "HPStoreOnceCloudBank" "VeeamVault" "ElevenElevenS3" "AbrVirtual"
names	Array of strings unique Array of repository names. Wildcard characters are supported.

Responses

200

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/repositories/export

Request samples

application/json

{"ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"types": ["WinLocal"
],
"names": ["string"
]
}

Response samples

application/json

{"WindowsLocalRepositories": [{"name": "string",
"description": "string",
"uniqueId": "string",
"hostName": "string",
"type": "WinLocal",
"repository": {"path": "string",
"taskLimitEnabled": true,
"maxTaskCount": 0,
"readWriteLimitEnabled": true,
"readWriteRate": 0,
"advancedSettings": {"alignDataBlocks": true,
"decompressBeforeStoring": true,
"rotatedDrives": true,
"perVmBackup": true,
"RotatedDriveCleanupMode": "Disabled"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"LinuxLocalRepositories": [{"name": "string",
"description": "string",
"uniqueId": "string",
"hostName": "string",
"type": "WinLocal",
"repository": {"path": "string",
"taskLimitEnabled": true,
"maxTaskCount": 0,
"readWriteLimitEnabled": true,
"readWriteRate": 0,
"useFastCloningOnXFSVolumes": true,
"advancedSettings": {"alignDataBlocks": true,
"decompressBeforeStoring": true,
"rotatedDrives": true,
"perVmBackup": true,
"RotatedDriveCleanupMode": "Disabled"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"SmbRepositories": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"share": {"sharePath": "string",
"credentials": {"credentialsName": "string",
"credentialsTag": "string"
},
"gatewayServer": {"autoSelectEnabled": true,
"gatewayServerName": "string"
}
},
"repository": {"taskLimitEnabled": true,
"maxTaskCount": 0,
"readWriteLimitEnabled": true,
"readWriteRate": 0,
"advancedSettings": {"alignDataBlocks": true,
"decompressBeforeStoring": true,
"rotatedDrives": true,
"perVmBackup": true,
"RotatedDriveCleanupMode": "Disabled"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"NfsRepositories": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"share": {"sharePath": "string",
"gatewayServer": {"autoSelectEnabled": true,
"gatewayServerName": "string"
}
},
"repository": {"taskLimitEnabled": true,
"maxTaskCount": 0,
"readWriteLimitEnabled": true,
"readWriteRate": 0,
"advancedSettings": {"alignDataBlocks": true,
"decompressBeforeStoring": true,
"rotatedDrives": true,
"perVmBackup": true,
"RotatedDriveCleanupMode": "Disabled"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"AzureBlobStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"regionType": "China",
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"container": {"containerName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
}
},
"proxyAppliance": {"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"instanceSize": "string",
"resourceGroup": "string",
"virtualNetwork": "string",
"subnet": "string",
"redirectorPort": 0
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"AzureDataBoxStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"serviceEndpoint": "string",
"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"container": {"containerName": "string",
"folderName": "string"
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"AmazonS3Storages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"regionType": "China",
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"regionId": "string",
"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
},
"infrequentAccessStorage": {"isEnabled": true,
"singleZoneEnabled": true
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
},
"proxyAppliance": {"ec2InstanceType": "string",
"vpcName": "string",
"vpcId": "string",
"subnetName": "string",
"subnetId": "string",
"securityGroup": "string",
"redirectorPort": 0
}
}
],
"AmazonSnowballEdgeStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"servicePoint": "string",
"regionId": "string",
"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"S3CompatibleStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"servicePoint": "string",
"regionId": "string",
"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
},
"proxyAppliance": {"managedServerId": "5f0be415-00a3-4fc5-b6ca-5b802e95ca87"
}
}
],
"GoogleCloudStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"regionId": "string",
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"nearlineStorageEnabled": true,
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
],
"IBMCloudStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"servicePoint": "string",
"regionId": "string",
"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
},
"proxyAppliance": {"managedServerId": "5f0be415-00a3-4fc5-b6ca-5b802e95ca87"
}
}
],
"AmazonS3GlacierStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"account": {"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"regionType": "China",
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"regionId": "string",
"bucketName": "string",
"folderName": "string",
"immutabilityEnabled": true,
"useDeepArchive": true
},
"proxyAppliance": {"ec2InstanceType": "string",
"vpcName": "string",
"vpcId": "string",
"subnetName": "string",
"subnetId": "string",
"securityGroup": "string",
"redirectorPort": 0
}
}
],
"AzureArchiveStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"account": {"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"regionType": "China",
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"container": {"containerName": "string",
"folderName": "string",
"immutabilityEnabled": true
},
"proxyAppliance": {"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"instanceSize": "string",
"resourceGroup": "string",
"virtualNetwork": "string",
"subnet": "string",
"redirectorPort": 0
}
}
],
"WasabiCloudStorages": [{"name": "string",
"description": "string",
"uniqueId": "string",
"type": "WinLocal",
"enableTaskLimit": true,
"maxTaskCount": 0,
"account": {"regionId": "string",
"credentials": {"name": "string",
"tag": "string",
"type": "AzureStorage"
},
"connectionSettings": {"connectionType": "Direct",
"gatewayServers": ["string"
]
}
},
"bucket": {"bucketName": "string",
"folderName": "string",
"storageConsumptionLimit": {"isEnabled": true,
"consumptionLimitCount": 0,
"consumptionLimitKind": "TB"
},
"immutability": {"isEnabled": true,
"daysCount": 0,
"immutabilityMode": "RepositorySettings"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
},
"proxyAppliance": {"managedServerId": "5f0be415-00a3-4fc5-b6ca-5b802e95ca87"
}
}
],
"LinuxHardenedRepositories": [{"name": "string",
"description": "string",
"uniqueId": "string",
"hostName": "string",
"type": "WinLocal",
"repository": {"path": "string",
"taskLimitEnabled": true,
"maxTaskCount": 0,
"readWriteLimitEnabled": true,
"readWriteRate": 0,
"useFastCloningOnXFSVolumes": true,
"makeRecentBackupsImmutableDays": 0,
"advancedSettings": {"alignDataBlocks": true,
"decompressBeforeStoring": true,
"rotatedDrives": true,
"perVmBackup": true,
"RotatedDriveCleanupMode": "Disabled"
}
},
"mountServer": {"mountServerSettingsType": "windows",
"windows": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
},
"linux": {"mountServerName": "string",
"writeCacheFolder": "string",
"vPowerNFSEnabled": true,
"vPowerNFSPortSettings": {"mountPort": 0,
"vPowerNFSPort": 0
}
}
}
}
]
}

Import Encryption Passwords

The HTTP POST request to the /api/v1/automation/encryptionPasswords/import path allows you to import encryption passwords to Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
required

Array of objects (EncryptionPasswordImportSpec) unique

Array of encryption passwords.

Responses

201

An Automation session has been created to import the passwords. To check the progress, track the session state.

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/encryptionPasswords/import

Request samples

application/json

{"encryptionPasswords": [{"password": "string",
"hint": "string",
"uniqueId": "string"
}
]
}

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"sessionType": "Infrastructure",
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"state": "Stopped",
"progressPercent": 0,
"result": {"result": "None",
"message": "string",
"isCanceled": true
},
"resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
"resourceReference": "string",
"parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
"usn": 0,
"platformName": "VMware",
"platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
"initiatedBy": "string"
}

Export Encryption Passwords

The HTTP POST request to the /api/v1/automation/encryptionPasswords/export path allows you to export encryption passwords from Veeam Backup & Replication.

Available to: Veeam Backup Administrator.

SecurityBearer

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: <version>-<revision>.

Request Body schema: application/json
optional

modificationTimeFrom	string <date-time> Date and time when the password was last modified.
ids	Array of strings <uuid> unique Array of password IDs.
hints	Array of strings unique Array of password hints.
tags	Array of strings unique Array of password tags.

Responses

200

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/encryptionPasswords/export

Request samples

application/json

{"modificationTimeFrom": "2019-08-24T14:15:22Z",
"ids": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"hints": ["string"
],
"tags": ["string"
]
}

Response samples

application/json

{"encryptionPasswords": [{"password": "string",
"hint": "string",
"uniqueId": "string"
}
]
}

Get All Automation Sessions

The HTTP GET request to the /api/v1/automation/sessions path allows you to get an array of all automation sessions performed on the backup server.

Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator, Veeam Security Administrator.

SecurityBearer

Request

query Parameters

skip	integer <int32> Number of sessions to skip.
limit	integer <int32> Default: 200 Maximum number of sessions to return.
orderColumn	string (ESessionsFiltersOrderColumn) Sorts sessions by one of the session parameters. Enum: "Name" "SessionType" "CreationTime" "EndTime" "State" "Result" "InitiatedBy"
orderAsc	boolean If `true`, sorts sessions in the ascending order by the `orderColumn` parameter.
nameFilter	string Filters sessions by the `nameFilter` pattern. The pattern can match any session parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.
createdAfterFilter	string <date-time> Returns sessions that are created after the specified date and time.
createdBeforeFilter	string <date-time> Returns sessions that are created before the specified date and time.
endedAfterFilter	string <date-time> Returns sessions that are finished after the specified date and time.
endedBeforeFilter	string <date-time> Returns sessions that are finished before the specified date and time.
typeFilter	string (ESessionType) Filters sessions by session type. Enum: "Infrastructure" "BackupJob" "Automation" "ConfigurationBackup" "PublishBackupContentViaMount" "RepositoryMaintenance" "RepositoryEvacuate" "InfrastructureItemDeletion" "RestoreVm" "InstantRecovery" "FirstClassDiskInstantRestore" "AzureApplianceDeploy" "QuickMigration" "FileLevelRestore" "LinuxFileLevelRestore" "ReplicaJob" "ConfigurationResynchronize" "Failover" "PlannedFailover" "PermanentFailover" "UndoFailover" "Failback" "CommitFailback" "UndoFailback" "SwitchReplicaToProduction" "CloudDirectorVmRestore" "CloudDirectorVAppRestore" "MalwareDetection" "FirstClassDiskQuickMigration" "EntraIdRestore" "EntraIdRestoreFromCopy" "UnstructuredDataBackupCopy" "SecurityComplianceAnalyzer" "FileServerSave" "SureBackup" "NasRestore" "LogsExport" "TestCredentials" "SqlLogBackup" "OracleLogBackup" "PostgreSqlLogBackup" "AzureInstantRecovery" "AzureInstantRecoveryMigration" "AzureInstantRecoverySwitchover" "AzureInstantRecoveryStart" "AzureInstantRecoveryStop" "AzureInstantRecoveryMigrationUndo" "AzureInstantRecoveryMount" "PublishBackupContentViaNfs" "VolumesDiscover" "DeleteBackup" "BackgroundOperation" "AgentDiscovery" "AgentPolicy" "AgentBackup" "ApplianceUpdatesInstall" "FailoverPlan" "FailoverPlanTask" "UnstructuredDataBrowse" "UnstructuredDownloadMeta" "EntraIdRescanRepository" "HostComponentsUpdate" "CopyBackup" "FileBackupHealthCheck" "ArchiveBackup" "ArchiveRehydration" "ArchiveSync" "ArchiveCopy" "ArchiveFreezing" "RetrieveBackup" "ArchiveTierDownload" "DirectBackupSync" "CheckpointRemoval" "Retention"
stateFilter	string (ESessionState) Filters sessions by session state. Enum: "Stopped" "Starting" "Stopping" "Working" "Pausing" "Resuming" "WaitingTape" "Idle" "Postprocessing" "WaitingRepository" "WaitingSlot"
resultFilter	Array of strings (ESessionResult) Filters sessions by session result. Items Enum: "None" "Success" "Warning" "Failed"
jobIdFilter	string <uuid> Filters sessions by job ID.

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: <version>-<revision>.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/automation/sessions

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"data": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"sessionType": "Infrastructure",
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"state": "Stopped",
"progressPercent": 0,
"result": {"result": "None",
"message": "string",
"isCanceled": true
},
"resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
"resourceReference": "string",
"parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
"usn": 0,
"platformName": "VMware",
"platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
"initiatedBy": "string"
}
],
"pagination": {"total": 0,
"count": 0,
"skip": 0,
"limit": 0
}
}

Get Automation Session

The HTTP GET request to the /api/v1/automation/sessions/{id} path allows you to get an automation session that has the specified id.

Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator, Veeam Security Administrator.

SecurityBearer

Request

path Parameters

required

string <uuid>

Automation session ID. To get the ID, run the Get All Automation Sessions 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: <version>-<revision>.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/automation/sessions/{id}

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
"sessionType": "Infrastructure",
"creationTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"state": "Stopped",
"progressPercent": 0,
"result": {"result": "None",
"message": "string",
"isCanceled": true
},
"resourceId": "026d60bb-63a8-407e-bf67-01dcfc6022e6",
"resourceReference": "string",
"parentSessionId": "b1d7834e-fe2f-4cad-b0e5-ff5c5615f344",
"usn": 0,
"platformName": "VMware",
"platformId": "32a6e381-64f4-4911-86b6-3bf681b64d23",
"initiatedBy": "string"
}

Get Automation Session Logs

The HTTP GET request to the /api/v1/automation/sessions/{id}/logs path allows you to get an array of log records of an automation session that has the specified id.

Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator, Veeam Backup Viewer, Veeam Tape Operator, Veeam Security Administrator.

SecurityBearer

Request

path Parameters

required

string <uuid>

Automation session ID. To get the ID, run the Get All Automation Sessions 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: <version>-<revision>.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/automation/sessions/{id}/logs

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{"totalRecords": 0,
"records": [{"id": 0,
"status": "None",
"startTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"title": "string",
"description": "string",
"additionalInfo": "string"
}
]
}

Stop Automation Session

The HTTP POST request to the /api/v1/automation/sessions/{id}/stop path allows you to stop an automation session that has the specified id.

Available to: Veeam Backup Administrator, Veeam Backup Operator, Veeam Restore Operator.

SecurityBearer

Request

path Parameters

required

string <uuid>

Automation session ID. To get the ID, run the Get All Automation Sessions 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: <version>-<revision>.

Responses

200

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

404

Not found. No object was found with the path parameter specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/automation/sessions/{id}/stop

Request samples

curl
Python
JavaScript
C#
Go

Response samples

application/json

{ }

Automation

Import Jobs

header Parameters

Request Body schema: application/jsonrequired

Export Jobs

header Parameters

Request Body schema: application/jsonoptional

Import Credentials

header Parameters

Request Body schema: application/jsonrequired

Export Credentials

header Parameters

Request Body schema: application/jsonoptional

Import Cloud Credentials

header Parameters

Request Body schema: application/jsonrequired

Export Cloud Credentials

header Parameters

Request Body schema: application/jsonoptional

Import Proxies

header Parameters

Request Body schema: application/jsonrequired

Export Proxies

header Parameters

Request Body schema: application/jsonoptional

Import Servers

header Parameters

Request Body schema: application/jsonrequired

Export Servers

header Parameters

Request Body schema: application/jsonoptional

Import Repositories

header Parameters

Request Body schema: application/jsonrequired

Export Repositories

header Parameters

Request Body schema: application/jsonoptional

Import Encryption Passwords

header Parameters

Request Body schema: application/jsonrequired

Export Encryption Passwords

header Parameters

Request Body schema: application/jsonoptional

Get All Automation Sessions

query Parameters

header Parameters

Get Automation Session

path Parameters

header Parameters

Get Automation Session Logs

path Parameters

header Parameters

Stop Automation Session

path Parameters

header Parameters

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
optional