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 OK. 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 https://localhost:9398/api/repositories/3efc471c-04be-4dd1-9ed2-54e7fddc5ecf?format=Entity

 

Response:

200 OK

 

Response Body:

<Repository xmlns="http://www.veeam.com/ent/v1.0" Type="Repository" Href="https://localhost:9398/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="https://localhost:9398/api/backupServers/21a631e0-af7f-46ba-afbd-273de2e6fd4a" Name="localhost" />
   <Link Rel="Alternate" Type="RepositoryReference" Href="https://localhost:9398/api/repositories/3efc471c-04be-4dd1-9ed2-54e7fddc5ecf" Name="Default Backup Repository" />
   <Link Rel="Down" Type="BackupReferenceList" Href="https://localhost:9398/api/repositories/3efc471c-04be-4dd1-9ed2-54e7fddc5ecf/backups" />
   <Link Rel="Down" Type="ReplicaReferenceList" Href="https://localhost:9398/api/repositories/3efc471c-04be-4dd1-9ed2-54e7fddc5ecf/replicas" />
 </Links>
 <Capacity>85530243072</Capacity>
 <FreeSpace>20584992768</FreeSpace>
</Repository>

 

Page updated 1/25/2024

Page content applies to build 12.2.0.334