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

Step 3. Get a List of Veeam Backup Servers

To get a list of all Veeam backup servers, you need to retrieve a resource representation of the /backupServers resource. This resource contains a collection of Veeam backup servers connected to Veeam Backup Enterprise Manager.

  1. In the resource representation of the logon session created at the previous step, find a link to the /backupServers resource. The Rel attribute within the link component has the Down value and the Type attribute is set to BackupServerReferenceList or BackupServerList:

<Link Rel="Down" Type="BackupServerReferenceList" Href="http://localhost:9399/api/backupServers>

  1. Get the URL for the Veeam backup servers collection. The URL is provided in the Href attribute of the link component:

http://localhost:9399/api/backupServers

  1. Send the GET HTTP request to the retrieved URL. Veeam Backup Enterprise Manager will return a representation of all connected Veeam backup servers:

Request:

GET http://localhost:9399/api/backupServers

 

Response:

200 Success

 

Response Body:

<EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
<Ref Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540" Name="backupserver" UID="urn:veeam:BackupServer:f62624c1-8462-4747-8bd4-d686f99b0540">
   <Links>
     <Link Rel="Down" Type="JobReferenceList" Href="http://localhost:9399/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540/jobs" />
     <Link Rel="Down" Type="RepositoryReferenceList" Href="http://localhost:9399/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540/repositories" />
     <Link Rel="Down" Type="CredentialsList" Href="http://localhost:9399/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540/credentials" />
     <Link Rel="Down" Type="PasswordKeyList" Href="http://localhost:9399/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540/passwords" />
     <Link Rel="Alternate" Type="BackupServer" Href="http://localhost:9399/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540?format=Entity" Name="backupserver" />
     <Link Rel="Down" Type="ManagedServerReferenceList" Href="http://localhost:9399/api/backupServers/f62624c1-8462-4747-8bd4-d686f99b0540/managedServers" />
   </Links>
 </Ref>
 <Ref Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/50a1b2fb-b90a-4e05-816f-e298eb2f995c" Name="localhost" UID="urn:veeam:BackupServer:50a1b2fb-b90a-4e05-816f-e298eb2f995c">
   <Links>
     <Link Rel="Down" Type="JobReferenceList" Href="http://localhost:9399/api/backupServers/50a1b2fb-b90a-4e05-816f-e298eb2f995c/jobs" />
     <Link Rel="Down" Type="RepositoryReferenceList" Href="http://localhost:9399/api/backupServers/50a1b2fb-b90a-4e05-816f-e298eb2f995c/repositories" />
     <Link Rel="Down" Type="CredentialsList" Href="http://localhost:9399/api/backupServers/50a1b2fb-b90a-4e05-816f-e298eb2f995c/credentials" />
     <Link Rel="Down" Type="PasswordKeyList" Href="http://localhost:9399/api/backupServers/50a1b2fb-b90a-4e05-816f-e298eb2f995c/passwords" />
     <Link Rel="Alternate" Type="BackupServer" Href="http://localhost:9399/api/backupServers/50a1b2fb-b90a-4e05-816f-e298eb2f995c?format=Entity" Name="localhost" />
     <Link Rel="Down" Type="ManagedServerReferenceList" Href="http://localhost:9399/api/backupServers/50a1b2fb-b90a-4e05-816f-e298eb2f995c/managedServers" />
   </Links>
 </Ref>
</EntityReferences>

 

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