Response Codes
A successfully completed operation returns response code 200 Success.
Send feedback | Updated on 2/20/2019
Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
RESTful API Reference
RESTful API Reference
- Overview
- Concepts And Principles
- Client-Server Model
- Resources
- Resource Types
- Resource URLs
- Resource Representations
- Resource Representations for Non-Key Resources
- Resource Representation for Key Resources
- Resource Representations for Resource Collections
- Links
- HTTP Requests and Responses
- Query Service
- Lookup Service
- Cloud Connect Service
- Getting Started
- Veeam Backup Enterprise Manager Web Client
- Authentication and Security
- Veeam Backup Enterprise Manager RESTful API Workflow
- Veeam Backup Enterprise Manager RESTful API Specifications
- Veeam Backup Enterprise Manager RESTful API Versions
- Beginner Example
- Veeam Backup Enterprise Manager RESTful API Reference
- /backupServers
- /backupServers/{ID}
- (GET) /backupServers/{ID}
- (PUT) /backupServers/{ID}
- (DELETE) /backupServers/{ID}
- (POST) /backupServers/{ID}?action=veeamzip
- (POST) /backupServers/{ID}?action=quickbackup
- (POST) /backupServers/{ID}?action=collect
- /backupServers/{ID}/credentials
- /backupServers/{ID}/credentials/{ID}
- (GET) /backupServers/{ID}/credentials/{ID}
- (PUT) /backupServers/{ID}/credentials/{ID}
- (DELETE) /backupServers/{ID}/credentials/{ID}
- /backupServers/{ID}/passwords
- /backupServers/{ID}/passwords/{ID}
- (GET) /backupServers/{ID}/passwords/{ID}
- (PUT) /backupServers/{ID}/passwords/{ID}
- (DELETE) /backupServers/{ID}/passwords/{ID}
- /backupServers/{ID}/externalRepositories
- /managedServers
- /managedServers/{ID}
- /jobs
- /jobs/{ID}
- (GET) /jobs/{ID}
- (PUT)/jobs/{ID}?action=edit
- (POST) /jobs/{ID}?action=start
- (POST) /jobs/{ID}?action=stop
- (POST) /jobs/{ID}?action=retry
- (POST) /jobs/{ID}?action=clone
- (POST) /jobs/{ID}?action=toggleScheduleEnabled
- /jobs/{ID}/includes
- /jobs/{ID}/includes/{ID}
- /failoverPlans
- /failoverPlans/{ID}
- (GET) /failoverPlans/{ID}
- (PUT) /failoverPlans/{ID}
- (POST) /failoverPlans/{ID}?action=start
- (POST) /failoverPlans/{ID}?action=undo
- /hierarchyRoots
- /hierarchyRoots/{ID}
- /repositories
- /repositories/{ID}
- /backups
- /backups/{ID}
- /backups/{ID}/childbackups
- /backups/{ID}/restorePoints
- /restorePoints
- /restorePoints/{ID}
- /restorePoints/{ID}/backupFiles
- /restorePoints/{ID}/vmRestorePoints
- /restorePoints/{ID}/vAppRestorePoints
- /restorePoints/{ID}/agentRestorePoints
- /vmRestorePoints
- /vmRestorePoints/{ID}
- (GET) /vmRestorePoints/{ID}
- (POST) /vmRestorePoints/{ID}?action=restore
- (POST) /vmRestorePoints/{ID}/mounts
- /vmRestorePoints/{ID}/mounts
- /vmRestorePoints/{ID}/mounts/{ID}
- /vmRestorePoints/{ID}/mounts/{ID}/{filepath}
- (GET) /vmRestorePoints/{ID}/mounts/{ID}/{filepath}
- (POST) /vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=restore
- /vAppRestorePoints
- /vAppRestorePoints/{ID}
- /replicas
- /replicas/{ID}
- /vmReplicaPoints
- /vmReplicaPoints/{ID}
- (GET) /vmReplicaPoints/{ID}
- (POST) /vmReplicaPoints/{ID}?action=failover
- (POST) /vmReplicaPoints/{ID}/mounts
- /vmReplicaPoints/{ID}/mounts
- /vmReplicaPoints/{ID}/mounts/{ID}
- /vmReplicaPoints/{ID}/mounts/{ID}/{filepath}
- /catalog/vms
- /catalog/vms/{vmname}
- /catalog/vms/{vmname}/vmRestorePoints
- /catalog/vms/{vmname}/vmRestorePoints/{ID}
- (GET) /catalog/vms/{vmname}/vmRestorePoints/{ID}
- (POST) /catalog/vms/{vmname}/vmRestorePoints/{ID}?action=browse
- /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/
- /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/{filepath}
- (GET) /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/{filepath}
- (POST) /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/{filepath}?action=restore
- /backupSessions
- /backupSessions/{ID}
- /backupSessions/{ID}/agentManagementSessions
- /backupSessions/{ID}/taskSessions
- /restoreSessions
- /restoreSessions/{ID}
- /replicaSessions
- /replicaSessions/{ID}
- /backupTaskSessions
- /backupTaskSessions/{ID}
- /replicaTaskSessions
- /replicaTaskSessions/{ID}
- /security
- /security/roles
- /security/roles/{ID}
- /security/accounts
- /security/accounts/{ID}
- /security/accounts/{ID}/roles
- /security/accounts/{ID}/roles/{ID}
- /security/accounts/{ID}/scopes
- /security/accounts/{ID}/scopes/{ID}
- /wanAccelerators
- /wanAccelerators/{ID}
- /vCloud
- /vCloud/orgConfigs
- /vCloud/orgConfigs/{ID}
- (GET) /vCloud/orgConfigs/{ID}
- (POST) /vCloud/orgConfigs/{ID}?action=disable
- (DELETE) /vCloud/orgConfigs/{ID}
- /vCloud/orgConfigs/{ID}//backupJobSettings
- /backupFiles
- /backupFiles/{ID}
- /backupFiles/{ID}/restorePoints
- /externalRepositories
- /externalRepositories/{ID}
- /externalRepositories/{ID}/backups
- /agents
- /agents/jobs
- /agents/jobs/{ID}
- (GET) /agents/jobs/{ID}
- (POST) /agents/jobs/{ID}?action=start
- (POST) /agents/jobs/{ID}?action=stop
- (POST) /agents/jobs/{ID}?action=retry
- (POST) /agents/jobs/{ID}?action=toggleScheduleEnabled
- /agents/agentRestorePoints
- /agents/agentRestorePoints/{ID}
- /agents/agentRestorePoints/{ID}/mounts
- /agents/agentRestorePoints/{ID}/mounts/{ID}
- (GET) /agents/agentRestorePoints/{ID}/mounts/{ID}
- (DELETE) /agents/agentRestorePoints/{ID}/mounts/{ID}
- /agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}
- (GET) /agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}
- (POST) /agents/agentRestorePoints/{ID}/mounts/{ID}/{filepath}?action=restore
- /agents/backups
- /agents/restorePoints
- /agents/backupFiles
- /agents/backupSessions
- /agents/protectionGroups
- /agents/protectionGroups/{ID}
- /agents/protectionGroups/{ID}/discoveredComputers
- /agents/discoveredComputers
- /agents/discoveredComputers/{ID}
- /selfService/vSphere
- /selfService/vSphere/Configs
- /selfService/vSphere/Configs/{ID}
- (GET) /selfService/vSphere/Configs/{ID}
- (PUT) /selfService/vSphere/Configs/{ID}
- (DELETE) /selfService/vSphere/Configs/{ID}
- /selfService/vSphere/Configs/{ID}/backupJobSettings
- /cloud
- /cloud/gateways
- /cloud/gateways/{ID}
- /cloud/tenants
- /cloud/tenants/{ID}
- /cloud/tenants/{ID}/resources
- /cloud/tenants/{ID}/resources/{ID}
- /cloud/tenants/{ID}/computeResources
- /cloud/tenants/{ID}/computeResources/{ID}
- /cloud/tenants/{ID}/vCloudComputeResources
- /cloud/tenants/{ID}/vCloudComputeResources/{ID}
- (GET) /cloud/tenants/{ID}/vCloudComputeResources/{ID}
- (DELETE) /cloud/tenants/{ID}/vCloudComputeResources/{ID}
- /cloud/tenants/{ID}/subtenants
- /cloud/tenants/{ID}/subtenants/{ID}
- /cloud/hardwarePlans
- /cloud/hardwarePlans/{ID}
- /cloud/hardwarePlans/{ID}/tenants
- /cloud/publicIpAddresses
- /cloud/publicIpAddresses/{ID}
- (GET) /cloud/publicIpAddresses/{ID}
- (PUT) /cloud/publicIpAddresses/{ID}
- (DELETE) /cloud/publicIpAddresses/{ID}
- /cloud/cloudFailoverPlans
- /cloud/cloudFailoverPlans/{ID}
- (GET) /cloud/cloudFailoverPlans/{ID}
- (PUT) /cloud/cloudFailoverPlans/{ID}
- (POST) /cloud/cloudFailoverPlans/{ID}?action=start
- (POST) /cloud/cloudFailoverPlans/{ID}?action=undo
- (DELETE) /cloud/cloudFailoverPlans/{ID}
- /cloud/cloudFailoverPlans/{ID}/includes
- /cloud/cloudFailoverPlans/{ID}/includes/{ID}
- /cloud/vmReplicaPoints
- /cloud/vmReplicaPoints/{ID}
- /cloud/replicas
- /cloud/replicas/{ID}
- /cloud/replicas/{ID}/vmReplicaPoints
- /cloud/vlans
- /cloud/vlans/{ID}
- /cloud/failoverSessions
- /cloud/failoverSessions/{ID}
- /cloud/gatewayPools
- /cloud/gatewayPools/{ID}
- /tasks
- /tasks/{ID}
- /querySvc
- /lookupSvc
- /reports/summary
- /reports/summary/overview
- /reports/summary/vms_overview
- /reports/summary/job_statistics
- /reports/summary/processed_vms
- /reports/summary/repository
- /logonSessions
- /logonSessions/{ID}
- Sample Scenarios
- Appendix A. Constructing HierarchyObjRefType
- Appendix B. Mapping Link Types to XML Schema Elements
- Revision History
