Veeam Backup & Replication 11
Veeam Backup Enterprise Manager REST API Reference

Related documents

User Guide for VMware vSphere User Guide for Microsoft Hyper-V Veeam Backup Enterprise Manager Guide Veeam Agent Management Guide Veeam Cloud Connect Guide Veeam Explorers User Guide Veeam Plug-ins for Enterprise Applications Guide Integration with Veeam Backup for AWS Guide Integration with Veeam Backup for Microsoft Azure Guide Veeam PowerShell Reference Veeam Explorers PowerShell Reference REST API Reference Required Permissions for VMware vSphere Quick Start Guide for VMware vSphere Quick Start Guide for Microsoft Hyper-V Veeam Backup & Replication for Nutanix Mine Guide

See more documents

Veeam ONE Documentation Veeam Backup for Microsoft Office 365 Documentation Veeam Agent for Microsoft Windows Documentation Veeam Agent for Linux Documentation Veeam Agent for Mac Documentation Veeam Agent for IBM AIX Documentation Veeam Agent for Oracle Solaris Documentation Veeam Backup for Google Cloud Platform Documentation Veeam Backup for AWS Documentation Veeam Backup for Microsoft Azure Documentation Veeam Backup for Nutanix AHV Documentation Veeam Management Pack Documentation Veeam Veeam Availability Orchestrator Documentation

Search

Veeam Backup & Replication 11
Veeam Backup Enterprise Manager REST 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

Attributes of a Link Element
Link Types and XML Schema Definition

HTTP Requests and Responses

Requests

POST Method
GET Method
PUT Method
DELETE Method

Responses

HTTP Response Codes
Special Characters in Responses

Query Service

Type Parameter
Optional Parameters

format
sortAsc, sortDesc
pageSize, page
filter

Comparison Expressions
Logical AND/OR Operators
Grouping Operators

Lookup Service

Lookup Query

Cloud Connect Service

Tenant Logon Session

Getting Started

Veeam Backup Enterprise Manager Web Client
Authentication and Security

HTTP Authentication
SSL Encryption

Veeam Backup Enterprise Manager REST API Workflow
Veeam Backup Enterprise Manager REST API Specifications
Veeam Backup Enterprise Manager REST API Versions

REST API v1.6 Changelog

Breaking Changes
New Operations
Resource Changes

Beginner Example

Step 1. Access Veeam Backup Enterprise Manager REST API
Step 2. Perform Logon
Step 3. Get a List of Backup Servers
Step 4. Perform Logout

Veeam Backup Enterprise Manager REST API Reference

/backupServers

GET /backupServers
POST /backupServers?action=create

/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

GET /backupServers/{ID}/credentials
POST /backupServers/{ID}/credentials?action=create

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

GET /backupServers/{ID}/credentials/{ID}
PUT /backupServers/{ID}/credentials/{ID}
DELETE /backupServers/{ID}/credentials/{ID}

/backupServers/{ID}/passwords

GET /backupServers/{ID}/passwords
POST /backupServers/{ID}/passwords?action=create

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

GET /backupServers/{ID}/passwords/{ID}
PUT /backupServers/{ID}/passwords/{ID}
DELETE /backupServers/{ID}/passwords/{ID}

/backupServers/{ID}/externalRepositories

GET /backupServers/{ID}/externalRepositories

/managedServers

GET /managedServers

/managedServers/{ID}

GET /managedServers/{ID}

/jobs

GET /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
DELETE /jobs/{ID}

/jobs/{ID}/includes

GET /jobs/{ID}/includes
POST /jobs/{ID}/includes

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

GET /jobs/{ID}/includes/{ID}
DELETE /jobs/{ID}/includes/{ID}

/backupSessions

GET /backupSessions

/backupSessions/{ID}

GET /backupSessions/{ID}
POST /backupSessions/{ID}?action=stop

/backupSessions/{ID}/agentManagementSessions

GET /backupSessions/{ID}/agentManagementSessions

/backupSessions/{ID}/taskSessions

GET /backupSessions/{ID}/taskSessions

/backupTaskSessions

GET /backupTaskSessions

/backupTaskSessions/{ID}

GET /backupTaskSessions/{ID}

/failoverPlans

GET failoverPlans

/failoverPlans/{ID}

GET /failoverPlans/{ID}
PUT /failoverPlans/{ID}
POST /failoverPlans/{ID}?action=start
POST /failoverPlans/{ID}?action=undo

/hierarchyRoots

GET /hierarchyRoots

/hierarchyRoots/{ID}

GET /hierarchyRoots/{ID}

/repositories

GET /repositories

/repositories/{ID}

GET /repositories/{ID}

/backups

GET /backups

/backups/{ID}

GET /backups/{ID}

/backups/{ID}/childbackups

GET /backups/{ID}/childbackups

/backups/{ID}/restorePoints

GET /backups/{ID}/restorePoints

/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

/restorePoints/{ID}/agentRestorePoints

GET /restorePoints/{ID}/agentRestorePoints

/restoreSessions

GET /restoreSessions

/restoreSessions/{ID}

GET /restoreSessions/{ID}

/vmRestorePoints

GET /vmRestorePoints

/vmRestorePoints/{ID}

GET /vmRestorePoints/{ID}
POST /vmRestorePoints/{ID}?action=restore
POST /vmRestorePoints/{ID}/mounts

/vmRestorePoints/{ID}/mounts

GET /vmRestorePoints/{ID}/mounts

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

GET /vmRestorePoints/{ID}/mounts/{ID}
DELETE /vmRestorePoints/{ID}/mounts/{ID}

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

GET /vmRestorePoints/{ID}/mounts/{ID}/{filepath}
POST /vmRestorePoints/{ID}/mounts/{ID}/{filepath}?action=restore

/vAppRestorePoints

GET /vAppRestorePoints

/vAppRestorePoints/{ID}

GET /vAppRestorePoints/{ID}
POST /vAppRestorePoints/{ID}?action=restore

/vAppReplicaPoints

GET /vAppReplicaPoints

/vAppReplicaPoints/{ID}

GET /vAppReplicaPoints/{ID}
POST /vAppReplicaPoints/{ID}?action=failover

/replicas

GET /replicas

/replicas/{ID}

GET /replicas/{ID}

/replicaSessions

GET /replicaSessions

/replicaSessions/{ID}

GET /replicaSessions/{ID}

/replicaTaskSessions

GET /replicaTaskSessions

/replicaTaskSessions/{ID}

GET /replicaTaskSessions/{ID}

/vmReplicaPoints

GET /vmReplicaPoints

/vmReplicaPoints/{ID}

GET /vmReplicaPoints/{ID}
POST /vmReplicaPoints/{ID}?action=failover
POST /vmReplicaPoints/{ID}/mounts

/vmReplicaPoints/{ID}/mounts

GET /vmReplicaPoints/{ID}/mounts

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

GET /vmReplicaPoints/{ID}/mounts/{ID}
DELETE /vmReplicaPoints/{ID}/mounts/{ID}

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

GET /vmReplicaPoints/{ID}/mounts/{ID}/{filepath}
POST /vmReplicaPoints/{ID}/mounts/{ID}/{filepath}?action=restore

/cdpPolicies

GET /cdpPolicies

/cdpPolicies/{ID}

GET /cdpPolicies/{ID}
PUT /cdpPolicies/{ID}
POST /cdpPolicies/{ID}?action=disable
POST /cdpPolicies/{ID}&action=enable

/cdpPolicies/{ID}/includes

GET /cdpPolicies/{ID}/includes
POST /cdpPolicies/{ID}/includes

/cdpPolicies/{ID}/includes/{ID}

GET /cdpPolicies/{ID}/includes/{ID}
DELETE /cdpPolicies/{ID}/includes/{ID}

/cdpPolicies/{ID}/cdpReplicaSessions

GET /cdpPolicies/{ID}/cdpReplicaSessions

/cdpReplicas

GET /cdpReplicas

/cdpReplicas/{ID}

GET /cdpReplicas/{ID}

/cdpReplicas/{ID}/vms

GET /cdpReplicas/{ID}/vms

/cdpReplicas/{ID}/vms/{ID}

GET /cdpReplicas/{ID}/vms/{ID}
POST /cdpReplicas/{ID}/vms/{ID}?action=failover
POST /cdpReplicas/{ID}/vms/{ID}?action=intervals

/cdpReplicaSessions

GET /cdpReplicaSessions

/cdpReplicaSessions/{ID}

GET /cdpReplicaSessions/{ID}

/cdpReplicaSessions/{ID}/cdpReplicaTaskSessions

GET /cdpReplicaSessions/{ID}/cdpReplicaTaskSessions

/cdpReplicaTaskSessions

GET /cdpReplicaTaskSessions

/cdpReplicaTaskSessions/{ID}

GET /cdpReplicaTaskSessions/{ID}

/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}

GET /catalog/vms/{vmname}/vmRestorePoints/{ID}
POST /catalog/vms/{vmname}/vmRestorePoints/{ID}?action=browse

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

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

/security

GET /security

/security/roles

GET /security/roles

/security/roles/{ID}

GET /security/roles/{ID}

/security/accounts

GET /security/accounts
POST /security/accounts
POST /security/accounts?action=rebuildScope

/security/accounts/{ID}

GET /security/accounts/{ID}
POST /security/accounts/{ID}
DELETE /security/accounts/{ID}

/security/accounts/{ID}/roles

GET /security/accounts/{ID}/roles
POST /security/accounts/{ID}/roles

/security/accounts/{ID}/roles/{ID}

GET /security/accounts/{ID}/roles/{ID}
DELETE /security/accounts/{ID}/roles/{ID}

/security/accounts/{ID}/scopes

GET /security/accounts/{ID}/scopes
POST /security/accounts/{ID}/scopes

/security/accounts/{ID}/scopes/{ID}

GET /security/accounts/{ID}/scopes/{ID}
DELETE /security/accounts /{ID}/scopes/{ID}

/wanAccelerators

GET /wanAccelerators

/wanAccelerators/{ID}

GET /wanAccelerators/{ID}

/vCloud

GET /vCloud

/vCloud/orgConfigs

GET /vCloud/orgConfigs
POST /vCloud/orgConfigs

/vCloud/orgConfigs/{ID}

GET /vCloud/orgConfigs/{ID}
PUT /vCloud/orgConfigs/{ID}
POST /vCloud/orgConfigs/{ID}?action=disable
DELETE /vCloud/orgConfigs/{ID}

/vCloud/orgConfigs/{ID}/backupJobSettings

GET /vCloud/orgConfigs/{ID}/backupJobSettings

/backupFiles

GET /backupFiles

/backupFiles/{ID}

GET /backupFiles/{ID}

/backupFiles/{ID}/restorePoints

GET /backupFiles/{ID}/restorePoints

/backupFiles/{ID}/vmRestorePoints

GET /backupFiles/{ID}/vmRestorePoints

/externalRepositories

GET /externalRepositories

/externalRepositories/{ID}

GET /externalRepositories/{ID}

/externalRepositories/{ID}/backups

GET /externalRepositories/{ID}/backups

/nas

GET /nas

/nas/jobs

GET /nas/jobs

/nas/jobs/{ID}

GET /nas/jobs/{ID}
POST /nas/jobs/{ID}/start
POST /nas/jobs/{ID}/stop
POST /nas/jobs/{ID}/retry
POST /nas/jobs/{ID}/toggleScheduleEnabled

/nas/jobs/{ID}/includes

GET /nas/jobs/{ID}/includes

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

GET /nas/jobs/{ID}/includes/{ID}

/nas/jobs/{ID}/backupSessions

GET /nas/jobs/{ID}/backupSessions

/nas/fileServers

GET /nas/fileServers

/nas/fileServers/{ID}

GET /nas/fileServers/{ID}

/nas/backupSessions

GET /nas/backupSessions

/agents

GET /agents

/agents/jobs

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

GET /agents/agentRestorePoints

/agents/agentRestorePoints/{ID}

GET /agents/agentRestorePoints/{ID}
POST /agents/agentRestorePoints/{ID}/mounts

/agents/agentRestorePoints/{ID}/mounts

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

GET /agents/backups

/agents/restorePoints

GET /agents/restorePoints

/agents/backupFiles

GET /agents/backupFiles

/agents/backupSessions

GET /agents/backupSessions

/agents/protectionGroups

GET /agents/protectionGroups

/agents/protectionGroups/{ID}

GET /agents/protectionGroups/{ID}

/agents/protectionGroups/{ID}/discoveredComputers

GET /agents/protectionGroups/{ID}/discoveredComputers

/agents/discoveredComputers

GET /agents/discoveredComputers

/agents/discoveredComputers/{ID}

GET /agents/discoveredComputers/{ID}

/selfService/vSphere

GET /selfService/vSphere

/selfService/vSphere/Configs

GET /selfService/vSphere/Configs
POST /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

GET /selfService/vSphere/Configs/{ID}/backupJobSettings

/cloud

GET /cloud

/cloud/gateways

GET /cloud/gateways
POST /cloud/gateways

/cloud/gateways/{ID}

GET /cloud/gateways/{ID}
PUT /cloud/gateways/{ID}
DELETE /cloud/gateways/{ID}

/cloud/gatewayPools

GET /cloud/gatewayPools
POST /cloud/gatewayPools

/cloud/gatewayPools/{ID}

GET /cloud/gatewayPools/{ID}
PUT /cloud/gatewayPools/{ID}
DELETE /cloud/gatewayPools/{ID}

/cloud/tenants

GET /cloud/tenants
POST /cloud/tenants

/cloud/tenants/{ID}

GET /cloud/tenants/{ID}
PUT /cloud/tenants/{ID}
DELETE /cloud/tenants/{ID}

/cloud/tenants/{ID}/resources

GET /cloud/tenants/{ID}/resources
POST /cloud/tenants/{ID}/resources

/cloud/tenants/{ID}/resources/{ID}

GET /cloud/tenants/{ID}/resources/{ID}
DELETE /cloud/tenants/{ID}/resources/{ID}

/cloud/tenants/{ID}/computeResources

GET /cloud/tenants/{ID}/computeResources
POST /cloud/tenants/{ID}/computeResources

/cloud/tenants/{ID}/computeResources/{ID}

GET /cloud/tenants/{ID}/computeResources/{ID}
DELETE /cloud/tenants/{ID}/computeResources/{ID}

/cloud/tenants/{ID}/vCloudComputeResources

GET /cloud/tenants/{ID}/vCloudComputeResources
POST /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

GET /cloud/tenants/{ID}/subtenants
POST /cloud/tenants/{ID}/subtenants

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

GET /cloud/tenants/{ID}/subtenants/{ID}
PUT /cloud/tenants/{ID}/subtenants/{ID}
DELETE /cloud/tenants/{ID}/subtenants/{ID}

/cloud/tenants/{ID}/gatewayPools

GET /cloud/tenants/{ID}/gatewayPools

/cloud/tenants/{ID}/freelicenseCounters

GET /cloud/tenants/{ID}/freelicenseCounters

/cloud/hardwarePlans

GET /cloud/hardwarePlans
POST /cloud/hardwarePlans

/cloud/hardwarePlans/{ID}

GET /cloud/hardwarePlans/{ID}
PUT /cloud/hardwarePlans/{ID}
DELETE /cloud/hardwarePlans/{ID}

/cloud/hardwarePlans/{ID}/tenants

GET /cloud/hardwarePlans/{ID}/tenants

/cloud/publicIpAddresses

GET /cloud/publicIpAddresses
POST /cloud/publicIpAddresses

/cloud/publicIpAddresses/{ID}

GET /cloud/publicIpAddresses/{ID}
PUT /cloud/publicIpAddresses/{ID}
DELETE /cloud/publicIpAddresses/{ID}

/cloud/cloudFailoverPlans

GET /cloud/cloudFailoverPlans

/cloud/cloudFailoverPlans/{ID}

GET /cloud/cloudFailoverPlans/{ID}
PUT /cloud/cloudFailoverPlans/{ID}
POST /cloud/cloudFailoverPlans/{ID}?action=start
POST /cloud/cloudFailoverPlans/{ID}?action=test
POST /cloud/cloudFailoverPlans/{ID}?action=undo
DELETE /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}

GET /cloud/vlans/{ID}
PUT /cloud/vlans/{ID}
DELETE /cloud/vlans/{ID}

/cloud/failoverSessions

GET /cloud/failoverSessions

/cloud/failoverSessions/{ID}

GET /cloud/failoverSessions/{ID}

/tasks

GET /tasks

/tasks/{ID}

GET /tasks/{ID}
DELETE /task/{ID}

/querySvc

GET /querySvc
GET /query?type=AgentBackupJob
GET /query?type=AgentProtectionGroup
GET /query?type=AgentRestorePoint
GET /query?type=Backup
GET /query?type=BackupFile
GET /query?type=BackupJobSession
GET /query?type=BackupServer
GET /query?type=BackupTaskSession
GET /query?type=CdpPolicy
GET /query?type=CdpReplica
GET /query?type=CdpReplicaSession
GET /query?type=CdpReplicaTaskSession
GET /query?type=CloudFailoverPlan
GET /query?type=CloudFailoverSession
GET /query?type=CloudGateway
GET /query?type=CloudGatewayPool
GET /query?type=CloudHardwarePlan
GET /query?type=CloudPublicIpAddress
GET /query?type=CloudReplica
GET /query?type=CloudSubtenant
GET /query?type=CloudTenant
GET /query?type=CloudVmReplicaPoint
GET /query?type=Credentials
GET /query?type=DiscoveredComputer
GET /query?type=FailoverPlan
GET /query?type=FileServer
GET /query?type=HierarchyRoot
GET /query?type=Job
GET /query?type=ManagedServer
GET /query?type=NasJob
GET /query?type=NasObject
GET /query?type=ObjectInJob
GET /query?type=Passwords
GET /query?type=Replica
GET /query?type=ReplicaJobSession
GET /query?type=ReplicaTaskSession
GET /query?type=Repository
GET /query?type=RestorePoint
GET /query?type=RestoreSession
GET /query?type=Task
GET /query?type=vAppReplicaPoint
GET /query?type=vAppRestorePoint
GET /query?type=VCloudOrganizationConfig
GET /query?type=VlanConfiguration
GET /query?type=VmReplicaPoint
GET /query?type=VmRestorePoint
GET /query?type=VsphereSelfServiceConfig
GET /query?type=WanAccelerator

/lookupSvc

GET /lookup?host={hostUID}&hierarchyRef={hierarchyRef}&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

GET /logonSessions
POST /sessionMngr/

/logonSessions/{ID}

GET /logonSessions/{ID}
DELETE /logonSessions/{ID}

Sample Scenarios

Starting Job
Performing 1-Click Restore
Performing Full VM Restore
Assigning Restore Scope

Appendix A. Constructing HierarchyObjRefType
Appendix B. Mapping Link Types to XML Schema Elements

>Veeam Backup Enterprise Manager REST API Reference>Getting Started>Veeam Backup Enterprise Manager REST API Versions>REST API v1.6 Changelog

REST API v1.6 Changelog

In this article

This section describes changes introduced in Veeam Backup Enterprise Manager REST API v1.6.

In This Section

Breaking Changes
New Operations
Resource Changes

Page updated 6/4/2021

Send feedback

Home | Products | Forums | Support | Contact Sales | EULA

©2021 Veeam® Software Privacy Notice | Cookie Notice

This document
Help Center

I want to report a typo

There is a misspelling right here:

I want to let the Veeam Documentation Team know about that.

Submit report