Veeam Backup & Replication 9.5 Update 4
RESTful API Reference
Related documents

(GET) /agents/jobs

Returns a resource representation of a collection of Veeam Agent backup jobs configured in Veeam Backup & Replication on all Veeam backup servers connected to Veeam Backup Enterprise Manager.

Request

To get a list of Veeam Agent backup jobs configured in Veeam Backup & Replication on all Veeam backup servers connected to Veeam Backup Enterprise Manager, you need to send the GET HTTP request to the URL of the /agents/jobs resource.

HTTP Request

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

Request Headers

The request contains the following headers:

Header

Required

Description

X-RestSvcSessionId

True

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.

Accept

False

Identifies the format of the response. Possible values:

  • application/xml — the client can sent this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body

None.

Query Parameters

None.

Response

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.

Header

Description

Content-length

The length of the response body.

Content-type

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/jobs collection resource.

Example

The example below returns a list of all Agent Management jobs on all Veeam backup servers connected to Veeam Backup Enterprise Manager.

Request:

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

 

Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

 

Response:

200 Success

 

Response Body:

<EntityReferences 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">
 <Ref UID="urn:veeam:AgentBackupJob:92346ee0-5191-4556-a9c6-ed1a38cdc71b" Name="Agent Backup Job 1" Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b" Type="AgentBackupJobReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/35dfeff8-5104-403b-a208-06e2d9a1da0b" Name="win10x64.tech.local" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b?format=Entity" Name="Agent Backup Job 1" Type="Job" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/agents/jobs/92346ee0-5191-4556-a9c6-ed1a38cdc71b/backupSessions" Type="BackupJobSessionReferenceList" Rel="Down"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:AgentBackupJob:4dc5d947-9c23-4e1b-976a-ee5911f6a996" Name="Agent Backup rhel72 lvm" Href="http://local.host:9399/api/agents/jobs/4dc5d947-9c23-4e1b-976a-ee5911f6a996" Type="AgentBackupJobReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/jobs/4dc5d947-9c23-4e1b-976a-ee5911f6a996?format=Entity" Name="Agent Backup rhel72 lvm" Type="Job" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/agents/jobs/4dc5d947-9c23-4e1b-976a-ee5911f6a996/backupSessions" Type="BackupJobSessionReferenceList" Rel="Down"/>
   </Links>
 </Ref>
 <Ref UID="urn:veeam:AgentBackupJob:95f84a48-6e05-459a-8f26-f2330c9efdf5" Name="Agent Backup Job SQL" Href="http://local.host:9399/api/agents/jobs/95f84a48-6e05-459a-8f26-f2330c9efdf5" Type="AgentBackupJobReference">
   <Links>
     <Link Href="http://local.host:9399/api/backupServers/3e1e451a-4718-4475-836b-9547ccae6872" Name="local.host" Type="BackupServerReference" Rel="Up"/>
     <Link Href="http://local.host:9399/api/agents/jobs/95f84a48-6e05-459a-8f26-f2330c9efdf5?format=Entity" Name="Agent Backup Job SQL" Type="Job" Rel="Alternate"/>
     <Link Href="http://local.host:9399/api/agents/jobs/95f84a48-6e05-459a-8f26-f2330c9efdf5/backupSessions" Type="BackupJobSessionReferenceList" Rel="Down"/>
   </Links>
 </Ref>
</EntityReferences>

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VEnterprise Manager User GuideVeeam Cloud Connect GuideVeeam Agent Management GuideVeeam Explorers User GuideBackup and Restore of SQL Server DatabasesVeeam Plug-ins for Enterprise ApplicationsPowerShell ReferenceVeeam Explorers PowerShell ReferenceRESTful API ReferenceRequired Permissions ReferenceQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam Backup for AWS DocumentationVeeam Availability for Nutanix AHV DocumentationVeeam Backup for Microsoft Office 365 DocumentationVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.