Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
RESTful API Reference

Resource Types

Veeam Backup Enterprise Manager is practically a hierarchy of resources. When the client accesses the Veeam Backup Enterprise Manager RESTful API, it obtains a list of resources that the client can use. All Veeam Backup Enterprise Manager resources can be divided into two groups:

  • Key resources, or entities, are top-level objects in Veeam Backup Enterprise Manager. These are primary Veeam Backup Enterprise Manager objects that the client can address: jobs, VMs, restore points and so on. Key resources are uniquely identified by entity IDs in the URN format. The client can get information about key resources and perform actions with them: modify resource properties, create and delete resources and so on.
  • Other resources are auxiliary objects handled by Veeam Backup Enterprise Manager RESTful API, for example: tasks, file system entries, credentials and so on. Typically, these resources do not have any actions associated with them. The client can access such resources to get some information about them but cannot perform any operation with them.

The Veeam Backup Enterprise Manager RESTful API operates with the following types of resources:

Key resources:

  • BackupServer
  • Job
  • FailoverPlan
  • ManagedServer
  • HierarchyRoot
  • Repository
  • Backup
  • RestorePoint
  • VmRestorePoint
  • vAppRestorePoint
  • Replica
  • VmReplicaPoint
  • CatalogVm
  • CatalogVmRestorePoint
  • BackupJobSession
  • ReplicaJobSession
  • RestoreJobSession
  • BackupTaskSession
  • ReplicaTaskSession
  • WanAccelerator
  • BackupFile
  • VCloudOrganizationConfig
  • CloudGateway
  • CloudTenant
  • CloudHardwarePlan
  • CloudPublicIpAddress
  • CloudFailoverPlan
  • CloudVmReplicaPoint
  • CloudReplica
  • VlanConfiguration
  • CloudFailoverSession
  • CloudFailoveredVm
  • EnterpriseRole
  • EnterpriseAccount

Other resources:

  • EnterpriseManager
  • LoginSession
  • Credentials
  • Passwords
  • Task
  • ObjectInJob
  • VmRestorePointMount
  • VmReplicaPointMount
  • DirectoryEntry
  • FileEntry
  • FileSystemItems
  • Report
  • ReportFrame
  • QueryService
  • LookupService
  • EnterpriseAccountInRole
  • EnterpriseAccountHierarchyScope
  • EnterpriseSecuritySettings
  • VCloudService
  • VCloudOrganizationConfigBackupJobSettings
  • CloudConnectService
  • CloudSubtenant

Veeam Backup Enterprise Manager RESTful API resources can be grouped in collections. A resource collection contains objects of the same type: for example, the BackupServers collection contains all Veeam backup servers connected to Veeam Backup Enterprise Manager. The resource collection itself is a resource: you can access it and get information about all objects being a part of the collection.

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation