- About Veeam ONE REST API
- Overview
- Changelog
- About
- Alarms
- Authentication
- Business View
- Licensing
- Microsoft Hyper-V Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All Microsoft Hyper-V VMs
- getGet Microsoft Hyper-V VM
- getGet All Microsoft Hyper-V Host Clusters
- getGet Microsoft Hyper-V Host Cluster
- getGet All Microsoft Hyper-V CSVs
- getGet Microsoft Hyper-V CSV
- getGet All Microsoft Hyper-V Host Groups
- getGet Microsoft Hyper-V Host Group
- getGet All Microsoft Hyper-V Hosts
- getGet Microsoft Hyper-V Host
- getGet All Microsoft Hyper-V Physical Disks
- getGet Microsoft Hyper-V Physical Disk
- getGet All Microsoft Hyper-V SCVMM Servers
- getGet Microsoft Hyper-V SCVMM Server
- getGet All Microsoft Hyper-V File Servers
- getGet Microsoft Hyper-V File Server
- getGet All Microsoft Hyper-V File Shares
- getGet Microsoft Hyper-V File Share
- Public Cloud
- getGet All Cloud VM Policies.
- getGet Cloud VM Policy
- getGet All Cloud File Share Policies
- getGet Cloud File Share Policy
- getGet All Cloud Database Policies
- getGet Cloud Database Policy
- getGet All Public Cloud Network Policies
- getGet Public Cloud Network Policy
- getGet All Cloud VMs
- getGet All Cloud File Shares
- getGet All Cloud Databases
- Public Cloud Protected Data
- getGet All Protected Cloud VMs
- getGet Protected Cloud VM
- getGet Backups of All Protected Cloud VMs
- getGet All Backups of Protected Cloud VM
- getGet All Restore Points of Protected Cloud VM
- getGet All Protected Cloud File Shares
- getGet Protected Cloud File Share
- getGet Backups of All Protected Cloud File Shares
- getGet All Backups of Protected Cloud File Share
- getGet All Restore Points of Protected Cloud File Share
- getGet All Protected Cloud Databases
- getGet Protected Cloud Database
- getGet Backups of All Protected Cloud Databases
- getGet All Backups of Protected Cloud Database
- getGet All Restore Points of Protected Cloud Database
- getGet All Protected Cloud Networks
- getGet Protected Cloud Network
- getGet All Cloud Network Backups
- getGet Backups of Cloud Network
- getGet Restore Points of Cloud Network
- Task Sessions
- VMware Cloud Director Infrastructure
- getGet Infrastucture Object Relations
- getGet Relations of Infrastructure Object
- getGet All Organizations
- getGet Organization
- getGet All Organization VDCs
- getGet Organization VDC
- getGet All Provider VDCs
- getGet Provider VDC
- getGet All Provider VDC Datastores
- getGet Provider VDC Datastore
- getGet All vApps
- getGet vApp
- getGet All VMs in vApps
- getGet All VMs in vApp
- getGet All VMware Cloud Director Servers
- getGet VMware Cloud Director Server
- VMware vSphere Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All vCenter Servers
- getGet vCenter Server
- getGet All VMware vSphere VMs
- getGet VMware vSphere VM
- getGet All VMware vSphere Host Clusters
- getGet Host Cluster
- getGet All VMware vSphere Datastores
- getGet VMware vSphere Datastore
- getGet All VMware vSphere Hosts
- getGet VMware vSphere Host
- getGet All Host Hardware Sensors
- getGet Hardware Sensors of Host
- getGet All Resource Pools
- getGet Resource Pool
- getGet All Datastore Clusters
- getGet Datastore Cluster
- getGet All vApps
- getGet vApp
- getGet All VMware vSphere VM Folders
- getGet VMware vSphere VM Folder
- Veeam Backup & Replication Failover Plans
- Veeam Backup & Replication Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All Backup Agents
- getGet Backup Agent
- getGet All Veeam Backup & Replication Servers
- getGet Veeam Backup & Replication Server
- getGet All Best Practices
- getGet Best Practices for Veeam Backup & Replication Server
- getGet All Backup Proxies
- getGet Backup Proxy
- getGet All WAN Accelerators
- getGet WAN Accelerator
- getGet All Tape Servers
- getGet Tape Server
- getGet All Veeam Backup Enterprise Manager Servers
- getGet Veeam Backup Enterprise Manager Server
- getGet All Backup Repositories
- getGet Backup Repository
- getGet All External Backup Repositories
- getGet External Backup Repository
- getGet All Object Storage Repositories
- getGet Object Storage Repository
- getGet All Scale-Out Repositories
- getGet Scale-Out Repository
- getGet All Performance Tier Extents
- getGet Performance Tier Extent
- getGet All Archive Tier Extents
- getGet Archive Tier Extent
- getGet All Capacity Tier Extents
- getGet Capacity Tier Extent
- getGet All Connected Applications
- getGet Connected Application
- Veeam Backup & Replication Jobs
- getGet All VM Backup Jobs
- getGet VM Backup Job
- getGet All VMware Cloud Director Backup Jobs
- getGet VMware Cloud Director Backup Job
- getGet All VM Replication Jobs
- getGet VM Replication Job
- getGet All VMware Cloud Director Replication Jobs
- getGet VMware Cloud Director Replication Job
- getGet All Backup to Tape Jobs
- getGet Backup to Tape Job
- getGet All Backup Copy Jobs
- getGet Backup Copy Job
- getGet All Child Jobs of Backup Copy Job
- getGet All SureBackup Jobs
- getGet SureBackup Job
- getGet All VM Copy Jobs
- getGet VM Copy Job
- getGet All Snapshot-Only Jobs
- getGet Snapshot-Only Job
- getGet All CDP Policies
- getGet CDP Policy
- getGet All File to Tape Jobs
- getGet File to Tape Job
- getGet All Object to Tape Jobs
- getGet Object to Tape Job
- getGet All File Copy Jobs
- getGet File Copy Job
- getGet All File Backup Jobs
- getGet File Backup Job
- getGet All Agent Backup Jobs
- getGet Agent Backup Job
- getGet All Veeam Backup Agent Policies
- getGet Veeam Backup Agent Policy
- getGet All Veeam Backup Agent Policy Child Jobs
- getGet All Application Backup Jobs
- getGet Application Backup Job
- getGet All Enterprise Application Transaction Log Backup Jobs
- getGet Enterprise Application Transaction Log Backup Job
- getGet All Transaction Log Backup Jobs
- getGet Transaction Log Backup Job
- getGet All Object Storage Jobs
- getGet Object Storage Job
- Veeam Backup & Replication Protected Data
- getGet All Protected VMs
- getGet Protected VM
- getGet Backups of All Protected VMs
- getGet Backups of Protected VM
- getGet All Backup Restore Points of Protected VM
- getGet All Replication Restore Points of Protected VM
- getGet All Protected Computers
- getGet Protected Computer
- getGet Backups of All Protected Computers
- getGet All Backups of Protected Computer
- getGet All Backup Restore Points of Protected Computer
- getGet All Protected File Shares
- getGet Protected File Share
- getGet Backups of All Protected File Shares
- getGet Backups of Protected File Share
- getGet All Backup Restore Points of Protected File Share
- getGet All Protected Object Storages
- getGet Protected Object Storage
- getGet Backups of All Protected Object Storages
- getGet Backups of Protected Object Storage
- getGet All Backup Restore Points of Protected Object Storage
- getGet All Protected Applications
- getGet Protected Application
- getGet Backups of All Application Databases
- getGet All Database Backups of Application
- Veeam Backup for Microsoft 365 Infrastructure
- getGet Infrastructure Object Relations
- getGet Relations of Infrastructure Object
- getGet All Veeam Backup for Microsoft 365 Servers
- getGet Veeam Backup for Microsoft 365 Server
- getGet All Proxy Pools
- getGet Backup Proxy Pool
- getGet All Veeam Backup for Microsoft 365 Backup Proxy Servers
- getGet Veeam Backup for Microsoft 365 Backup Proxy Server
- getGet All Veeam Backup for Microsoft 365 Backup Repositories
- getGet Veeam Backup for Microsoft 365 Backup Repository
- getGet All Veeam Backup for Microsoft 365 Object Storage Repositories
- getGet Veeam Backup for Microsoft 365 Object Storage Repository
- getGet All Microsoft Organizations
- getGet Microsoft Organization
- getGet All Users of Microsoft Organization
- getGet Microsoft 365 User
- getGet All Microsoft 365 Users
- getGet All Groups of Microsoft Organization
- getGet Microsoft 365 Group
- getGet All Microsoft 365 Groups
- getGet SharePoint Sites of Microsoft Organization
- getGet Microsoft SharePoint Site
- getGet All Microsoft SharePoint Sites
- getGet All Teams of Microsoft Organization
- getGet Microsoft 365 Team
- getGet All Microsoft 365 Teams
- Veeam Backup for Microsoft 365 Jobs
- Veeam Backup for Microsoft 365 Protected Data
- getGet All Protected Microsoft 365 Users
- getGet Restore Points of All Protected Microsoft 365 Users
- getGet Protected Microsoft 365 User
- getGet All Microsoft 365 User Restore Points
- getGet All Protected Microsoft 365 Groups
- getGet Restore Points of All Protected Microsoft 365 Groups
- getGet Protected Microsoft 365 Group
- getGet All Microsoft 365 Group Restore Points
- getGet All Protected Microsoft 365 Sites
- getGet Restore Points of All Protected Microsoft 365 Sites
- getGet Protected Microsoft 365 Site
- getGet All Microsoft 365 Site Restore Points
- getGet All Protected Microsoft 365 Teams
- getGet Restore Points of All Protected Microsoft 365 Teams
- getGet Protected Microsoft 365 Team
- getGet All Microsoft 365 Team Restore Points
- Veeam Cloud Connect
Get All Task Sessions
Returns a collection resource representation of all task sessions.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Bad Request
Forbidden
- curl
- 200
- 400
- 403
{- "items": [
- {
- "jobSessionId": 1466,
- "name": "Object properties data collection",
- "type": "AggregateProperties",
- "status": "Processing",
- "statusPriority": 6,
- "start": "2025-07-10T09:55:38.64Z",
- "end": null
}, - {
- "jobSessionId": 1000,
- "name": "Object properties data collection",
- "type": "AggregateProperties",
- "status": "Success",
- "statusPriority": 0,
- "start": "2025-07-10T04:41:07.303Z",
- "end": "2025-07-10T04:41:07.303Z"
}, - {
- "jobSessionId": 1001,
- "name": "Business View categories refresh",
- "type": "BusinessviewData",
- "status": "Success",
- "statusPriority": 0,
- "start": "2025-07-10T04:41:08.14Z",
- "end": "2025-07-10T04:41:15.61Z"
}, - {
- "jobSessionId": 1002,
- "name": "Business View categories refresh",
- "type": "BusinessviewData",
- "status": "Success",
- "statusPriority": 0,
- "start": "2025-07-10T04:45:35.927Z",
- "end": "2025-07-10T04:45:40.847Z"
}
], - "totalCount": 4
}
Get Task Session
Returns a resource representation of a task session with the specified ID.
path Parameters
sessionId required | integer <int32> Job session ID |
Success
No Content
Bad Request
Forbidden
- curl
- 200
- 400
- 403
{- "jobSessionId": 1466,
- "name": "Object properties data collection",
- "type": "AggregateProperties",
- "status": "Processing",
- "statusPriority": 6,
- "start": "2025-07-10T09:55:38.64Z",
- "end": null
}
Get Task Session Details
Returns a collection resource representation of operations performed during a task session with the specified ID.
path Parameters
sessionId required | integer <int32> Job session ID. |
Success
Bad Request
Forbidden
- curl
- 200
- 400
- 403
[- {
- "sessionRecordId": 0,
- "details": "Veeam ONE is installed successfully. Root objects are collected.",
- "logDateTime": "'2021-01-27T11:54:31.84Z'"
}
]
Get Data Collection Status
Returns a resource representation of data collection status.
Success
Forbidden
- curl
- 200
- 403
{- "progress": 84,
- "status": "Processing",
- "manuallyStart": false,
- "nextRun": "2025-07-06T15:07:44.823Z",
- "tasksSuccess": 5,
- "tasksWarning": 0,
- "tasksFailed": 0,
- "tasksStopped": 0
}
Get All Data Collection Tasks
Returns a collection resource representation of data collection tasks.
query Parameters
Offset | integer <int32> Default: 0 |
Limit | integer <int32> Default: 100 |
Filter | string |
Sort | string |
Select | string |
Success
Bad Request
Forbidden
- curl
- 200
- 400
- 403
{- "items": [
- {
- "sessionId": 1376,
- "taskId": 4,
- "name": "vc1.tech.local",
- "status": "Processing",
- "statusPriority": 6,
- "modified": "2025-07-06T05:21:04.01Z",
- "lastRun": "2025-07-06T14:41:49.433Z",
- "collectingType": "VMwarevCenter"
}, - {
- "sessionId": 1378,
- "taskId": 5,
- "name": "repVBR.tech.local",
- "status": "Success",
- "statusPriority": 0,
- "modified": "2025-07-06T04:58:49.96Z",
- "lastRun": "2025-07-06T14:41:50.05Z",
- "collectingType": "VBR"
}, - {
- "sessionId": 1375,
- "taskId": 6,
- "name": "chv2.tech.local",
- "status": "Success",
- "statusPriority": 0,
- "modified": "2025-07-06T04:59:13.327Z",
- "lastRun": "2025-07-06T14:41:49.15Z",
- "collectingType": "VMwarevCenter"
}, - {
- "sessionId": 1377,
- "taskId": 7,
- "name": "hvClusterWin19.tech.local",
- "status": "Success",
- "statusPriority": 0,
- "modified": "2025-07-06T05:20:45.14Z",
- "lastRun": "2025-07-06T14:41:49.703Z",
- "collectingType": "HyperVFailoverCluster"
}
], - "totalCount": 4
}
Get Data Collection Schedule
Returns a resource representation of data collection schedule.
Success
Forbidden
- curl
- 200
- 403
{- "startTime": "2025-07-09T02:00:00Z",
- "timeZoneId": "",
- "scheduleType": "Daily",
- "disabled": false,
- "periodically": {
- "period": 1,
- "interval": "Hours"
}, - "daily": {
- "daysOfWeek": [
- "Monday",
- "Tuesday",
- "Wednesday",
- "Thursday",
- "Friday"
]
}, - "monthlyDays": {
- "months": [ ],
- "days": [ ]
}, - "monthlyWeekDays": {
- "months": [ ],
- "dayOfWeekAppearance": [ ],
- "daysOfWeek": [
- "Monday",
- "Tuesday",
- "Wednesday",
- "Thursday",
- "Friday"
]
}
}
Patch Data Collection Schedule
Modifies data collection schedule. Periodic scheduling type is configured in hourly intervals.
Request Body schema: application/json
scheduleType required | string Type of a data collection schedule. |
startTime required | string <date-time> Time and date of the data collection session start. |
timeZoneId | string or null ID assigned to a time zone. |
disabled | boolean Indicates whether a data collection schedule is enabled. |
object or null Settings for periodic scheduling. | |
object or null Settings for daily scheduling. | |
object or null Scheduling settings for monthly data collection on specific date. | |
object or null Scheduling settings for monthly data collection on specific week days. |
Success
Bad Request
Forbidden
- Payload
- curl
{- "startTime": "2025-07-09T02:00:00Z",
- "timeZoneId": "",
- "scheduleType": "Daily",
- "disabled": false,
- "periodically": {
- "period": 1,
- "interval": "Hours"
}, - "daily": {
- "daysOfWeek": [
- "Monday",
- "Tuesday",
- "Wednesday",
- "Thursday",
- "Friday"
]
}, - "monthlyDays": {
- "months": [ ],
- "days": [ ]
}, - "monthlyWeekDays": {
- "months": [ ],
- "dayOfWeekAppearance": [ ],
- "daysOfWeek": [
- "Monday",
- "Tuesday",
- "Wednesday",
- "Thursday",
- "Friday"
]
}
}
- 400
- 403
{- "startTime": "2025-07-09T02:00:00Z",
- "timeZoneId": "",
- "scheduleType": "Daily",
- "disabled": false,
- "periodically": {
- "period": 1,
- "interval": "Hours"
}, - "daily": {
- "daysOfWeek": [
- "Monday",
- "Tuesday",
- "Wednesday",
- "Thursday",
- "Friday"
]
}, - "monthlyDays": {
- "months": [ ],
- "days": [ ]
}, - "monthlyWeekDays": {
- "months": [ ],
- "dayOfWeekAppearance": [ ],
- "daysOfWeek": [
- "Monday",
- "Tuesday",
- "Wednesday",
- "Thursday",
- "Friday"
]
}
}
Start Data Collection
Starts a data collection session.
Success
Forbidden
- curl
- 403
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}
- curl
- 403
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}