This is an archive version of the document. To get the most up-to-date information, see the
current version.
(GET) /jobs
Returns a resource representation of a collection of jobs created on all Veeam backup servers that are connected to Veeam Backup Enterprise Manager.
 Note:
|
Currently the GET method returns jobs of the Backup and Replication types only. |
To get a list of jobs created on all Veeam backup servers connected to Veeam Backup Enterprise Manager, you need to send the GET HTTP request to the URL of the /jobs resource.
HTTP Request
GET http://<Enterprise-Manager>:9399/api/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. |
Request Body
None.
Query Parameters
None.
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: application/xml. |
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /jobs collection resource.
The example below returns a list of all jobs created on all Veeam backup servers connected to Veeam Backup Enterprise Manager.
Request: GET http://localhost:9399/api/jobs Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 Success Response Body: <EntityReferences xmlns="http://www.veeam.com/ent/v1.0">
<Ref Type="JobReference" Href="http://localhost:9399/api/jobs/065c3eed-175d-4fd8-89c8-2da82b0dcd4f" Name="SQL Server Replication" UID="urn:veeam:Job:065c3eed-175d-4fd8-89c8-2da82b0dcd4f">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
<Link Rel="Alternate" Type="Job" Href="http://localhost:9399/api/jobs/065c3eed-175d-4fd8-89c8-2da82b0dcd4f?format=Entity" Name="SQL Server Replication" />
<Link Rel="Down" Type="ReplicaJobSessionReferenceList" Href="http://localhost:9399/api/jobs/065c3eed-175d-4fd8-89c8-2da82b0dcd4f/replicaSessions" />
</Links>
</Ref>
<Ref Type="JobReference" Href="http://localhost:9399/api/jobs/62638c60-74b6-4d6d-8d13-4cd32039f522" Name="Daily NetApp Snapshots" UID="urn:veeam:Job:62638c60-74b6-4d6d-8d13-4cd32039f522">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
<Link Rel="Alternate" Type="Job" Href="http://localhost:9399/api/jobs/62638c60-74b6-4d6d-8d13-4cd32039f522?format=Entity" Name="Daily NetApp Snapshots" />
<Link Rel="Down" Type="BackupJobSessionReferenceList" Href="http://localhost:9399/api/jobs/62638c60-74b6-4d6d-8d13-4cd32039f522/backupSessions" />
</Links>
</Ref>
<Ref Type="JobReference" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720" Name="Oracle Backup" UID="urn:veeam:Job:da4a15c2-04e7-4135-b876-577249d3d720">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
<Link Rel="Alternate" Type="Job" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720?format=Entity" Name="Oracle Backup" />
<Link Rel="Down" Type="BackupJobSessionReferenceList" Href="http://localhost:9399/api/jobs/da4a15c2-04e7-4135-b876-577249d3d720/backupSessions" />
</Links>
</Ref>
<Ref Type="JobReference" Href="http://localhost:9399/api/jobs/2574fb7b-aca3-485c-8e77-67ef12bd23e8" Name="Webserver Backup" UID="urn:veeam:Job:2574fb7b-aca3-485c-8e77-67ef12bd23e8">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
<Link Rel="Alternate" Type="Job" Href="http://localhost:9399/api/jobs/2574fb7b-aca3-485c-8e77-67ef12bd23e8?format=Entity" Name="Webserver Backup" />
<Link Rel="Down" Type="BackupJobSessionReferenceList" Href="http://localhost:9399/api/jobs/2574fb7b-aca3-485c-8e77-67ef12bd23e8/backupSessions" />
</Links>
</Ref>
<Ref Type="JobReference" Href="http://localhost:9399/api/jobs/fc764ba5-a910-416d-8e06-b6e4782f7fef" Name="Mediaserver Backup" UID="urn:veeam:Job:fc764ba5-a910-416d-8e06-b6e4782f7fef">
<Links>
<Link Rel="Up" Type="BackupServerReference" Href="http://localhost:9399/api/backupServers/ce15a8c7-aa49-495e-b05b-ee3398c91018" Name="srv02.veeam.local" />
<Link Rel="Alternate" Type="Job" Href="http://localhost:9399/api/jobs/fc764ba5-a910-416d-8e06-b6e4782f7fef?format=Entity" Name="Mediaserver Backup" />
<Link Rel="Down" Type="BackupJobSessionReferenceList" Href="http://localhost:9399/api/jobs/fc764ba5-a910-416d-8e06-b6e4782f7fef/backupSessions" />
</Links>
</Ref>
</EntityReferences> |
