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

Resource Representations for Non-Key Resources

For non-key resources, Veeam Backup Enterprise Manager RESTful API provides a reference resource representation. The reference resource representation is used to identify the resource and its relations to other resources.

This type of representation provides the following data about the resource:

  • Basic resource information: its ID (if available), name, URL and type
  • Information about resources that are related to the current resource

For example, a reference representation for a credentials resource looks similar to the following:

<CredentialsInfo xmlns="http://www.veeam.com/ent/v1.0" Type="Credentials" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/credentials/166d7ed7-5a47-4070-ad78-6a9c9966e52e">
 <Links>
   <Link Rel="Up" Type="BackupServer" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018?format=Entity" Name="srv02.veeam.local" />
   <Link Rel="Edit" Type="Credentials" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/credentials/166d7ed7-5a47-4070-ad78-6a9c9966e52e" />
   <Link Rel="Delete" Type="Credentials" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018/credentials/166d7ed7-5a47-4070-ad78-6a9c9966e52e" />
 </Links>
 <Id>166d7ed7-5a47-4070-ad78-6a9c9966e52e</Id>
 <Username>172.16.11.22\Administrator</Username>
 <Description>172.16.11.22\Administrator</Description>
 <Password />
</CredentialsInfo>

 

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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation