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

Appendix B. Mapping Link Types to XML Schema Elements

The Type attribute in a link to a resource may differ from the corresponding root element in the XML Schema Definition. Below is a list of Type attribute values and corresponding XML schema elements:

Link Type

XML Schema Element

LogonSession

 <xs:element name="LogonSession" type="LogonSessionType" />

LogonSessionList

 <xs:element name="LogonSessions" type="LogonSessionListType" />

EnterpriseManager

 <xs:element name="EnterpriseManager" type="EnterpriseManagerType" />

<Resource>Reference

 <xs:element name="EntityRef" type="EntityReferenceType" />

<Resource>ReferenceList

 <xs:element name="EntityReferences" type="EntityReferenceListType" />

BackupServer

 <xs:element name="BackupServer" type="BackupServerEntityType" />

BackupServerList

 <xs:element name="BackupServers" type="BackupServerEntityListType" />

ManagedServer

 <xs:element name="ManagedServer" type="ManagedServerEntityType"/>

ManagedServerList

 <xs:element name="ManagedServers" type="ManagedServerEntityListType"/>

Job

 <xs:element name="Job" type="JobEntityType" />

JobList

 <xs:element name="Jobs" type="JobEntityListType" />

FailoverPlan

 <xs:element name="FailoverPlan" type="FailoverPlanEntityType" />

FailoverPlanList

 <xs:element name="FailoverPlans" type="FailoverPlanEntityListType" />

ObjectInJob

 <xs:element name="ObjectInJob" type="ObjectInJobType" />

ObjectInJobList

 <xs:element name="ObjectsInJob" type="ObjectInJobListType" />

FailoveredVm

 <xs:element name="FailoveredVm" type="FailoveredVmType" />

FailoveredVmList

 <xs:element name="FailoveredVms" type="FailoveredVmListType" />

Backup

 <xs:element name="Backup" type="BackupEntityType" />

BackupList

 <xs:element name="Backups" type="BackupEntityListType" />

Replica

 <xs:element name="Replica" type="ReplicaEntityType" />

ReplicaList

 <xs:element name="Replicas" type="ReplicaEntityListType" />

RestorePoint

 <xs:element name="RestorePoint" type="RestorePointEntityType" />

RestorePointList

 <xs:element name="RestorePoints" type="RestorePointEntityListType" />

VmRestorePoint

 <xs:element name="VmRestorePoint" type="VmRestorePointEntityType" />

VmRestorePointList

 <xs:element name="VmRestorePoints" type="VmRestorePointEntityListType" />

VAppRestorePoint

 <xs:element name="VAppRestorePoint" type="VAppRestorePointEntityType" />

VAppRestorePointList

 <xs:element name="VAppRestorePoints" type="VAppRestorePointEntityListType" />

VmReplicaPoint

 <xs:element name="VmReplicaPoint" type="VmReplicaPointEntityType" />

VmReplicaPointList

 <xs:element name="VmReplicaPoints" type="VmReplicaPointEntityListType" />

VmRestorePointMount

 <xs:element name="VmRestorePointMount" type="VmRestorePointMountType" />

VmRestorePointMountList

 <xs:element name="VmRestorePointMounts" type="VmRestorePointMountListType" />

VmReplicaPointMount

 <xs:element name="VmReplicaPointMount" type="VmReplicaPointMountType" />

VmReplicaPointMountList

 <xs:element name="VmReplicaPointMounts" type="VmReplicaPointMountListType" />

FileSystemItems, DirectoryEntry, FileEntry

 <xs:element name="FileSystemEntry" type="FileSystemEntryType" />

FileSystemItems, DirectoryEntryList, FileEntryList

 <xs:element name="FileSystemEntries" type="FileSystemEntriesType" />

HierarchyRoot

 <xs:element name="HierarchyRoot" type="HierarchyRootEntityType" />

HierarchyRootList

 <xs:element name="HierarchyRoots" type="HierarchyRootEntityListType"/>

Repository

 <xs:element name="Repository" type="RepositoryEntityType" />

RepositoryList

 <xs:element name="Repositories" type="RepositoryEntityListType" />

BackupJobSession

 <xs:element name="BackupJobSession" type="BackupJobSessionEntityType" />

BackupJobSessionList

 <xs:element name="BackupJobSessions" type="BackupJobSessionEntityListType" />

ReplicaJobSession

 <xs:element name="ReplicaJobSession" type="ReplicaJobSessionEntityType" />

ReplicaJobSessionList

 <xs:element name="ReplicaJobSessions" type="ReplicaJobSessionEntityListType" />

RestoreSession

 <xs:element name="RestoreSession" type="RestoreSessionEntityType" />

RestoreSessionList

 <xs:element name="RestoreSessions" type="RestoreSessionEntityListType" />

BackupTaskSession

 <xs:element name="BackupTaskSession" type="BackupTaskSessionEntityType" />

BackupTaskSessionList

 <xs:element name="BackupTaskSessions" type="BackupTaskSessionEntityListType" />

ReplicaTaskSession

 <xs:element name="ReplicaTaskSession" type="ReplicaTaskSessionEntityType" />

ReplicaTaskSessionList

 <xs:element name="ReplicaTaskSessions" type="ReplicaTaskSessionEntityListType" />

*

 <xs:element name="QueryResult" type="QueryResultType" />

Task

 <xs:element name="Task" type="TaskType" />

TaskList

 <xs:element name="Tasks" type="TaskListType" />

Report

 <xs:element name="SummaryReport" type="SummaryReportType" />

ReportFrame

 <xs:element name="OverviewReportFrame" type="OverviewReportFrameType" />

ReportFrame

 <xs:element name="VmsOverviewReportFrame" type="VmsOverviewReportFrameType" />

ReportFrame

 <xs:element name="JobStatisticsReportFrame" type="JobStatisticsReportFrameType" />

ReportFrame

 <xs:element name="RepositoryReportFrame" type="RepositoryReportFrameType" />

ReportFrame

 <xs:element name="ProcessedVmsReportFrame" type="ProcessedVmsReportFrameType"/>

HierarchyItem

 <xs:element name="HierarchyItem" type="HierarchyItemType"/>

HierarchyItemList

 <xs:element name="HierarchyItems" type="HierarchyItemListType"/>

QueryService

 <xs:element name="QuerySvc" type="QuerySvcType"/>

LookupService

 <xs:element name="LookupSvc" type="LookupSvcType"/>

 <xs:element name="ReportingSvc" type="ReportingSvcType"/>

Credentials

 <xs:element name="CredentialsInfo" type="CredentialsInfoType" />

CredentialsList

 <xs:element name="CredentialsInfoList" type="CredentialsInfoListType" />

PasswordKey

 <xs:element name="PasswordKeyInfo" type="PasswordKeyInfoType" />

PasswordKeyList

 <xs:element name="PasswordKeyInfoList" type="PasswordKeyInfoListType" />

CatalogVm

 <xs:element name="CatalogVm" type="CatalogVmEntityType" />

CatalogVmList

 <xs:element name="CatalogVms" type="CatalogVmEntityListType" />

CatalogVmRestorePoint

 <xs:element name="CatalogVmRestorePoint" type="CatalogVmRestorePointEntityType" />

CatalogVmRestorePointList

 <xs:element name="CatalogVmRestorePoints" type="CatalogVmRestorePointEntityListType" />

EnterpriseRole

 <xs:element name="EnterpriseRole" type="EnterpriseRoleEntityType" />

EnterpriseRoleList

 <xs:element name="EnterpriseRoles" type="EnterpriseRoleEntityListType" />

EnterpriseAccount

 <xs:element name="EnterpriseAccount" type="EnterpriseAccountEntityType" />

EnterpriseAccountList

 <xs:element name="EnterpriseAccounts" type="EnterpriseAccountEntityListType" />

EnterpriseAccountHierarchyScope

 <xs:element name="EnterpriseAccountHierarchyScope" type="EnterpriseAccountHierarchyScopeType" />

EnterpriseAccountHierarchyScopeList

 <xs:element name="EnterpriseAccountHierarchyScopes" type="EnterpriseAccountHierarchyScopeListType" />

EnterpriseAccountInRole

 <xs:element name="EnterpriseAccountInRole" type="EnterpriseAccountInRoleType" />

EnterpriseAccountInRoleList

 <xs:element name="EnterpriseAccountInRoleList" type="EnterpriseAccountInRoleListType" />

EnterpriseSecuritySettings

 <xs:element name="EnterpriseSecuritySettings" type="EnterpriseSecuritySettingsType" />

WanAccelerator

 <xs:element name="WanAccelerator" type="WanAcceleratorEntityType" />

WanAcceleratorList

 <xs:element name="WanAccelerators" type="WanAcceleratorEntityListType" />

CloudGateway

 <xs:element name="CloudGateway" type="CloudGatewayEntityType" />

CloudGatewayList

 <xs:element name="CloudGateways" type="CloudGatewayEntityListType" />

CloudTenant

 <xs:element name="CloudTenant" type="CloudTenantEntityType" />

CloudTenantList

 <xs:element name="CloudTenants" type="CloudTenantEntityListType" />

CloudTenantResource

 <xs:element name="CloudTenantResource" type="CloudTenantResourceType" />

CloudTenantResourceList

 <xs:element name="CloudTenantResources" type="CloudTenantResourceListType" />

CloudHardwarePlanList

 <xs:element name="CloudHardwarePlans" type="CloudHardwarePlanEntityListType" />

CloudHardwarePlan

 <xs:element name="CloudHardwarePlan" type="CloudHardwarePlanEntityType" />

CloudPublicIpAddressList

 <xs:element name="CloudPublicIpAddresses" type="CloudPublicIpAddressEntityListType" />

CloudPublicIpAddress

 <xs:element name="CloudPublicIpAddress" type="CloudPublicIpAddressEntityType" />

CloudTenantComputeResourceList

 <xs:element name="CloudTenantComputeResources" type="CloudTenantComputeResourceListType"/>

CloudTenantComputeResource

 <xs:element name="CloudTenantComputeResource" type="CloudTenantComputeResourceType" />

CloudVmReplicaPointList

 <xs:element name="CloudVmReplicaPoints" type="CloudVmReplicaPointEntityListType" />

CloudVmReplicaPoint

 <xs:element name="CloudVmReplicaPoint" type="CloudVmReplicaPointEntityType" />

CloudFailoverPlanList

 <xs:element name="CloudFailoverPlans" type="CloudFailoverPlanEntityListType" />

CloudFailoverPlan

 <xs:element name="CloudFailoverPlan" type="CloudFailoverPlanEntityType" />

VlanConfigurationList

 <xs:element name="VlanConfigurations" type="VlanConfigurationEntityListType" />

VlanConfiguration

 <xs:element name="VlanConfiguration" type="VlanConfigurationEntityType" />

CloudFailoverSession

 <xs:element name="CloudFailoverSession" type="CloudFailoverSessionEntityType" />

CloudFailoverSessionList

 <xs:element name="CloudFailoverSessions" type="CloudFailoverSessionEntityListType" />

CloudFailoveredVm

 <xs:element name="CloudFailoveredVm" type="CloudFailoveredVmType" />

CloudFailoveredVmList

 <xs:element name="CloudFailoveredVms" type="CloudFailoveredVmListType" />

CloudConnectService

 <xs:element name="CloudConnectService" type ="CloudConnectServiceType" />

CloudReplicaList

 <xs:element name="CloudReplicas" type="CloudReplicaEntityListType" />

CloudReplica

 <xs:element name="CloudReplica" type="CloudReplicaEntityType" />

 

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation