Veeam Availability for the Always-On Enterprise

Help Center

Choose product document...

Veeam Backup & Replication 9.5 [Archived]
RESTful API Reference

Concepts And Principles

In this section, you will find a description of basic REST API concepts and principles that will help you quickly dive into Veeam Backup Enterprise Manager RESTful API. The information is given by the example of Veeam Backup Enterprise Manager objects. This section is primarily intended for novices in REST API; however, some information may be useful for experienced developers.

In This Section

Send feedback | Updated on 3/12/2018

Links

HTTP Requests and Responses

Requests

Responses

Query Service

Lookup Service

Lookup Query

Cloud Connect Service

Tenant Logon Session

Getting Started

New in Version 1.3

Beginner Example

Veeam Backup Enterprise Manager RESTful API Reference

/backupServers

/backupServers/{ID}

/backupServers/{ID}/credentials

/backupServers/{ID}/credentials/{ID}

/backupServers/{ID}/passwords

/backupServers/{ID}/passwords/{ID}

/managedServers

(GET) /managedServers

/managedServers/{ID}

(GET) /managedServers/{ID}

/jobs

(GET) /jobs

/jobs/{ID}

/jobs/{ID}/includes

/jobs/{ID}/includes/{ID}

/failoverPlans

(GET) failoverPlans

/failoverPlans/{ID}

/hierarchyRoots

(GET) /hierarchyRoots

/hierarchyRoots/{ID}

(GET) /hierarchyRoots/{ID}

/repositories

(GET) /repositories

/repositories/{ID}

(GET) /repositories/{ID}

/backups

(GET) /backups

/backups/{ID}

(GET) /backups/{ID}

/restorePoints

(GET) /restorePoints

/restorePoints/{ID}

(GET) /restorePoints/{ID}

/restorePoints/{ID}/backupFiles

(GET) /restorePoints/{ID}/backupFiles

/restorePoints/{ID}/vmRestorePoints

(GET) /restorePoints/{ID}/vmRestorePoints

/restorePoints/{ID}/vAppRestorePoints

(GET) /restorePoints/{ID}/vAppRestorePoints

/vmRestorePoints

(GET) /vmRestorePoints

/vmRestorePoints/{ID}

/vmRestorePoints/{ID}/mounts

(GET) /vmRestorePoints/{ID}/mounts

/vmRestorePoints/{ID}/mounts/{ID}

/vmRestorePoints/{ID}/mounts/{ID}/{filepath}

/vAppRestorePoints

(GET) /vAppRestorePoints

/vAppRestorePoints/{ID}

/replicas

(GET) /replicas

/replicas/{ID}

(GET) /replicas/{ID}

/vmReplicaPoints

(GET) /vmReplicaPoints

/vmReplicaPoints/{ID}

/vmReplicaPoints/{ID}/mounts

(GET) /vmReplicaPoints/{ID}/mounts

/vmReplicaPoints/{ID}/mounts/{ID}

/vmReplicaPoints/{ID}/mounts/{ID}/{filepath}

/catalog/vms

(GET) /catalog/vms

/catalog/vms/{vmname}

(GET) /catalog/vms/{vmname}

/catalog/vms/{vmname}/vmRestorePoints

(GET) /catalog/vms/{vmname}/vmRestorePoints

/catalog/vms/{vmname}/vmRestorePoints/{ID}

/catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/

(GET) /catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/

/catalog/vms/{vmname}/vmRestorePoints/{ID}/guestfs/{filepath}

/backupSessions

(GET) /backupSessions

/backupSessions/{ID}

/restoreSessions

(GET) /restoreSessions

/restoreSessions/{ID}

(GET) /restoreSessions/{ID}

/replicaSessions

(GET) /replicaSessions

/replicaSessions/{ID}

(GET) /replicaSessions/{ID}

/backupTaskSessions

(GET) /backupTaskSessions

/backupTaskSessions/{ID}

(GET) /backupTaskSessions/{ID}

/replicaTaskSessions

(GET) /replicaTaskSessions

/replicaTaskSessions/{ID}

(GET) /replicaTaskSessions/{ID}

/security

(GET) /security

/security/roles

(GET) /security/roles

/security/roles/{ID}

(GET) /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

(GET) /wanAccelerators

/wanAccelerators/{ID}

(GET) /wanAccelerators/{ID}

/vCloud

(GET) /vCloud

/vCloud/orgConfigs

/vCloud/orgConfigs/{ID}

/vCloud/orgConfigs/{ID}//backupJobSettings

(GET) /vCloud/orgConfigs/backupJobSettings

/backupFiles

(GET) /backupFiles

/backupFiles/{ID}

(GET) /backupFiles/{ID}

/backupFiles/{ID}/restorePoints

(GET) /backupFiles/{ID}/restorePoints

/backupFiles/{ID}/vmRestorePoints

(GET) /backupFiles/{ID}/vmRestorePoints

/cloud

(GET) /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}/subtenants

/cloud/tenants/{ID}/subtenants/{ID}

/cloud/hardwarePlans

/cloud/hardwarePlans/{ID}

/cloud/hardwarePlans/{ID}/tenants

(GET) /cloud/hardwarePlans/{ID}/tenants

/cloud/publicIpAddresses

/cloud/publicIpAddresses/{ID}

/cloud/cloudFailoverPlans

(GET) /cloud/cloudFailoverPlans

/cloud/cloudFailoverPlans/{ID}

/cloud/cloudFailoverPlans/{ID}/includes

(GET) /cloud/cloudFailoverPlans/{ID}/includes

/cloud/cloudFailoverPlans/{ID}/includes/{ID}

(GET) /cloud/cloudFailoverPlans/{ID}/includes/{ID}

/cloud/vmReplicaPoints

(GET) /cloud/vmReplicaPoints

/cloud/vmReplicaPoints/{ID}

(GET) /cloud/vmReplicaPoints/{ID}

/cloud/replicas

(GET) /cloud/replicas

/cloud/replicas/{ID}

(GET) /cloud/replicas/{ID}

/cloud/replicas/{ID}/vmReplicaPoints

(GET) /cloud/replicas/{ID}/vmReplicaPoints

/cloud/vlans

(GET) /cloud/vlans

/cloud/vlans/{ID}

/cloud/failoverSessions

(GET) /cloud/failoverSessions

/cloud/failoverSessions/{ID}

(GET) /cloud/failoverSessions/{ID}

/tasks

(GET) /tasks

/tasks/{ID}

/querySvc

(GET) /querySvc

/lookupSvc

(GET) /lookup?host={hostUID}&hierachyRef={hierachyRef}&name={objName}&type={objType}

/reports/summary

(GET) /reports/summary

/reports/summary/overview

(GET) /reports/summary/overview

/reports/summary/vms_overview

(GET) /reports/summary/vms_overview

/reports/summary/job_statistics

(GET) /reports/summary/job_statistics

/reports/summary/processed_vms

(GET) /reports/summary/processed_vms

/reports/summary/repository

(GET) /reports/summary/repository

/logonSessions

/logonSessions/{ID}

Sample Scenarios

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

Backup and Restore of SQL Server Databases

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide