- About Veeam Backup & Replication REST API
- Overview
- How To
- Changelog
- Login
- Service
- Services
- Credentials
- getGet All Credentials
- postAdd Credentials Record
- getGet Credentials Record
- putEdit Credentials Record
- delRemove Credentials Record
- postChange Password
- postChange Linux Private Key
- postChange Linux Root Password
- getGet All Cloud Credentials
- postAdd Cloud Credentials Record
- postGet Microsoft Azure Verification Code
- postRegister Azure AD Application
- postGet Google Authentication Information
- getGet Cloud Credentials Record
- putEdit Cloud Credentials Record
- delRemove Cloud Credentials Record
- postChange Secret Key
- postChange Google Service Account
- postChange Certificate
- getGet All Helper Appliances
- postAdd or Edit Helper Appliance
- getGet Helper Appliance
- delRemove Helper Appliance
- Encryption
- Connection
- Cloud Browser
- Inventory Browser
- Traffic Rules
- General Options
- Malware Detection
- Configuration Backup
- Managed Servers
- Repositories
- getGet All Repositories
- postAdd Repository
- getGet All Repository States
- getGet Repository
- putEdit Repository
- delRemove Repository
- getGet All Scale-Out Backup Repositories
- postAdd Scale-Out Backup Repository
- getGet Scale-Out Backup Repository
- putEdit Scale-Out Backup Repository
- delRemove Scale-Out Backup Repository
- postEnable Sealed Mode
- postDisable Sealed Mode
- postEnable Maintenance Mode
- postDisable Maintenance Mode
- Proxies
- WAN Accelerators
- Jobs
- Backups
- Backup Objects
- Restore Points
- Restore
- getGet All VM Mounts
- postStart Instant Recovery
- getGet VM Mount
- postStop VM Publishing
- postStart VM Migration
- postRestore Entire VMware vSphere VM
- postRestore Entire VMware Cloud Director VM
- getGet All FCD Mounts
- postStart Instant FCD Recovery
- getGet FCD Mount
- postStop FCD Publishing
- postStart FCD Migration
- postStart File Restore
- postUnmount File System
- Backup Browsers
- getGet All File Restore Mounts
- getGet File Restore Mount
- postBrowse File System
- postCompare Attributes
- postCompare Files and Folders
- postSearch for Files and Folders
- postBrowse Search Results
- postRestore Files and Folders to Original Location
- postRestore Files and Folders to Another Location
- postPrepare Files and Folders for Download
- postDownload Files and Folders
- Tasks
- Replicas
- Replica Restore Points
- Failover
- Failback
- Sessions
- Agents
- Automation
- postImport Jobs
- postExport Jobs
- postImport Credentials
- postExport Credentials
- postImport Cloud Credentials
- postExport Cloud Credentials
- postImport Proxies
- postExport Proxies
- postImport Servers
- postExport Servers
- postImport Repositories
- postExport Repositories
- postImport Encryption Passwords
- postExport Encryption Passwords
- getGet All Automation Sessions
- getGet Automation Session
- getGet Automation Session Logs
- postStop Automation Session
The WAN Accelerators section defines paths and operations for managing WAN accelerators.
Get All WAN Accelerators
The HTTP GET request to the /api/v1/backupInfrastructure/wanAccelerators
path allows you to get an array of all WAN accelerators that are added to the backup infrastructure.
Available to: Veeam Backup Administrator.
query Parameters
skip | integer <int32> Number of WAN accelerators to skip. |
limit | integer <int32> Maximum number of WAN accelerators to return. |
orderColumn | string (EWANAcceleratorsFiltersOrderColumn) Sorts WAN accelerators by one of the WAN accelerator parameters. |
orderAsc | boolean Sorts WAN accelerators in the ascending order by the |
nameFilter | string Filters WAN accelerators by the |
header Parameters
x-api-version required | string Default: 1.1-rev2 Version and revision of the client REST API. Must be in the following format: |
OK
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 401
- 403
- 500
{- "data": [
- {
- "id": "d8ecb099-ca8e-4cd3-b12f-10f36508942b",
- "name": "enterprise03.tech.local",
- "server": {
- "hostId": "b29b8591-bf31-4174-b69b-25ac296a20b2",
- "description": "Created by TECH\\sheila.d.cory",
- "trafficPort": 6165,
- "streamsCount": 5,
- "highBandwidthModeEnabled": true
}, - "cache": {
- "cacheSizeUnit": "GB",
- "cacheFolder": "C:\\VeeamWAN",
- "cacheSize": 100
}
}, - {
- "id": "bbd849d3-226e-470c-804c-fdd2b09da683",
- "name": "enterprise05.tech.local",
- "server": {
- "hostId": "612af0b0-ce61-4315-a82c-b056669e48ae",
- "description": "Created by TECH\\sheila.d.cory",
- "trafficPort": 6165,
- "streamsCount": 5,
- "highBandwidthModeEnabled": false
}, - "cache": {
- "cacheSizeUnit": "GB",
- "cacheFolder": "C:\\VeeamWAN",
- "cacheSize": 50
}
}
], - "pagination": {
- "total": 2,
- "count": 2,
- "skip": 0,
- "limit": 200
}
}
Get WAN Accelerator
The HTTP GET request to the /api/v1/backupInfrastructure/wanAccelerators/{id}
path allows you to get a WAN accelerator that has the specified id
.
Available to: Veeam Backup Administrator.
path Parameters
id required | string <uuid> ID of the WAN accelerator. |
header Parameters
x-api-version required | string Default: 1.1-rev2 Version and revision of the client REST API. Must be in the following format: |
OK
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.
Not found. No object was found with the path parameter specified in the request.
Internal server error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 401
- 403
- 404
- 500
{- "id": "d8ecb099-ca8e-4cd3-b12f-10f36508942b",
- "name": "enterprise03.tech.local",
- "server": {
- "hostId": "b29b8591-bf31-4174-b69b-25ac296a20b2",
- "description": "Created by TECH\\sheila.d.cory",
- "trafficPort": 6165,
- "streamsCount": 5,
- "highBandwidthModeEnabled": true
}, - "cache": {
- "cacheSizeUnit": "GB",
- "cacheFolder": "C:\\VeeamWAN",
- "cacheSize": 100
}
}