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

/agents

Represents a collection of Veeam Agent Management resources.

In its resource representation, the /agents resource provides a set of links to the following Veeam Agent Management resources:

Resource URL

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

Related Resources

None.

Methods

The following methods are supported for the /agents resource:

(GET) /agents

Resource Representation

The /agents resource has a resource representation of the following type:

<Agents Href="http://local.host:9399/api/agents" Type="AgentsService" xmlns="http://www.veeam.com/ent/v1.0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 <Links>
   <Link Href="http://local.host:9399/api/agents/jobs" Type="JobReferenceList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/agentRestorePoints" Type="AgentRestorePointReferenceList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/backups" Type="BackupReferenceList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/restorePoints" Type="RestorePointReferenceList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/backupFiles" Type="RestorePointReferenceList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/backupSessions" Type="BackupJobSessionReferenceList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/protectionGroups" Type="AgentProtectionGroupReferenceList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/discoveredComputers" Type="DiscoveredComputerReferenceList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/jobs?format=Entity" Type="JobList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/agentRestorePoints?format=Entity" Type="AgentRestorePointList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/backups?format=Entity" Type="BackupList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/restorePoints?format=Entity" Type="RestorePointList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/backupFiles?format=Entity" Type="RestorePointList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/backupSessions?format=Entity" Type="BackupJobSessionList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/protectionGroups?format=Entity" Type="AgentProtectionGroupList" Rel="Down"/>
   <Link Href="http://local.host:9399/api/agents/discoveredComputers?format=Entity" Type="DiscoveredComputerList" Rel="Down"/>
 </Links>
</Agents>

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

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation