- 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
Request Authorization Tokens
Issues access and refresh JWT tokens.
SecurityBearer
Request
Request Body schema:
grant_type required | string Default: "password" Enum: "refresh_token" "password" |
username | string |
password | string <password> |
refresh_token | string |
Responses
200
Success
400
Bad Request
post/api/token
Request samples
- Payload
- curl
username=string&password=pa%24%24word&grant_type=refresh_token&refresh_token=string
Response samples
- 200
- 400
application/json
{- "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9LjthD9KEdtgfXIsBQWRnWOKmM19kCwgBP40K6TzHNpzqBhMEc3eyh9B0yqhrLgIhz4Xq0TYB4HHohOG2QoOrvk8yHQcoBxtWfmvDF347bQ1OVgE5_Ieh29cglNiT1mXQ5Z9S1a4KTwDkRhfS5tNMlVHLg0vUXQwZvFykKXIuck1cQFfZAHpJq9UhEySG9kx7Q-t09ZfDFFVf8IUT0OrNd9jJ2DQP9snvjNNXeHuHd3HE1Mer_bVg",
- "refresh_token": "eyJhbGciOiJIUzI1Ni1BTcPnVzDIyOagiZNuEbPwbEBCe9u_m8l31biXWP1vOyh6_LdbKcDY6gzi6bUopTf02yV6ks4-hhEhhMsq4M6_hd3ZPZJmNLoHUEdDa8reXVBkHdsaLgr6NUGFArVeQ7cy1OdA",
- "token_type": "Bearer",
- "expires_in": 899,
- "user": "onesrv\\administrator",
- "user_role": "Admin"
}
Revoke Authorization Tokens
Revokes the specified access JWT token or performs logout operation for the specified user.
SecurityBearer
Request
Request Body schema:
token | string |
UserSid | string |
Responses
200
Success
400
Bad Request
post/api/revoke
Request samples
- Payload
- curl
token=string&UserSid=string
Response samples
- 400
application/json
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}