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

(GET) /agents

Returns a set of links to Veeam Agent Management resources.


To get a list of Veeam Agent Management resources, you need to send the GET HTTP request to the URL of the /agents resource.

HTTP Request

GET http://<Enterprise-Manager>:9399/api/agents

Request Header

The request contains the following headers:






The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.



The request requires a certain format in response. In the header, the client can specify one of the following formats:

  • application/xml
  • application/json

Request Body


Query Parameters



The server returns the following response to the client.

Response Codes

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.




The length of the response body.


The media type and syntax of the request body message. Possible values:

  • application/xml
  • application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /agents resource.


The example below returns a resource representation of the /agents resource.


GET http://localhost:9399/api/agents


Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj



200 Success


Response Body:

<Agents Href="" Type="AgentsService" xmlns="" xmlns:xsd="" xmlns:xsi="">
   <Link Href="" Type="JobReferenceList" Rel="Down"/>
   <Link Href="" Type="AgentRestorePointReferenceList" Rel="Down"/>
   <Link Href="" Type="BackupReferenceList" Rel="Down"/>
   <Link Href="" Type="RestorePointReferenceList" Rel="Down"/>
   <Link Href="" Type="RestorePointReferenceList" Rel="Down"/>
   <Link Href="" Type="BackupJobSessionReferenceList" Rel="Down"/>
   <Link Href="" Type="AgentProtectionGroupReferenceList" Rel="Down"/>
   <Link Href="" Type="DiscoveredComputerReferenceList" Rel="Down"/>
   <Link Href="" Type="JobList" Rel="Down"/>
   <Link Href="" Type="AgentRestorePointList" Rel="Down"/>
   <Link Href="" Type="BackupList" Rel="Down"/>
   <Link Href="" Type="RestorePointList" Rel="Down"/>
   <Link Href="" Type="RestorePointList" Rel="Down"/>
   <Link Href="" Type="BackupJobSessionList" Rel="Down"/>
   <Link Href="" Type="AgentProtectionGroupList" Rel="Down"/>
   <Link Href="" Type="DiscoveredComputerList" Rel="Down"/>

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 Reference

Veeam Availability for Nutanix AHV Documentation

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation