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

GET Method

The GET HTTP method is used to read data or retrieve information about a resource. In case of success, the GET HTTP method returns the HTTP response code 200 Success; in the response body, the method returns a representation of the resource.

In the example below, the GET HTTP method is used to retrieve a resource representation of the default backup repository entity:

Request:

GET http://localhost:9399/api/repositories/3efc471c-04be-4dd1-9ed2-54e7fddc5ecf?format=Entity

 

Response:

200 Success

 

Response Body:

<Repository xmlns="http://www.veeam.com/ent/v1.0" Type="Repository" Href="http://localhost:9399/api/repositories/3efc471c-04be-4dd1-9ed2-54e7fddc5ecf?format=Entity" Name="Default Backup Repository" UID="urn:veeam:Repository:3efc471c-04be-4dd1-9ed2-54e7fddc5ecf">
 <Links>
   <Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/21a631e0-af7f-46ba-afbd-273de2e6fd4a" Name="localhost" />
   <Link Rel="Alternate" Type="RepositoryReference" Href="http://localhost:9399/api/repositories/3efc471c-04be-4dd1-9ed2-54e7fddc5ecf" Name="Default Backup Repository" />
   <Link Rel="Down" Type="BackupReferenceList" Href="http://localhost:9399/api/repositories/3efc471c-04be-4dd1-9ed2-54e7fddc5ecf/backups" />
   <Link Rel="Down" Type="ReplicaReferenceList" Href="http://localhost:9399/api/repositories/3efc471c-04be-4dd1-9ed2-54e7fddc5ecf/replicas" />
 </Links>
 <Capacity>85530243072</Capacity>
 <FreeSpace>20584992768</FreeSpace>
</Repository>

 

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