Get Jobs

In this article

    You can get a representation of a collection of Veeam Backup & Replication jobs managed in Veeam Service Provider Console.

    Request

    To get a representation of all backup server jobs managed in Veeam Service Provider Console, send the GET HTTPS request to the URL of the /jobs collection.

    HTTP Request

    GET https://<hostname>:1281/v2/jobs

    Request Headers

    The request header must contain the authorization token for the current logon session.

    Response

    The server returns the following response to the client.

    Response Code

    A successfully completed operation returns response code 200 OK.

    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/json; charset=utf-8

    Response Body

    In the response body, Veeam Service Provider Console returns a representation of the /jobs collection.

    Example Get Jobs

    The following request returns a representation of all jobs managed in Veeam Service Provider Console.

    Request:

    GET https://localhost:1281/v2/jobs

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response Code:

    200 Success

     

    Response Body:

    [
     {
       "id": 2,
       "name": "Webserver Backup to Cloud",
       "status": "Success",
       "type": "Backup",
       "lastRun": "2019-03-01T10:16:48.447Z",
       "endTime": "2019-03-01T10:40:30.627Z",
       "duration": 328,
       "durationUnits": "s",
       "processingRate": 17.66,
       "processingRateUnits": "MB/s",
       "avgDuration": 328,
       "avgDurationUnits": "s",
       "transferredData": 1.52,
       "transferredDataUnits": "GB",
       "bottleneck": "Source",
       "serverName": "BACKUP02",
       "isEnabled": true,
       "protectedVMs": 1,
       "schedulingType": "Periodically",

       "companyId": 2

       "locationId": 2
       "actions": [
         "stop",
         "retry",
         "enable",
         "disable",
         "start"
       ],
       "_links": {
         "self": {
           "href": "https://vac:1281/v2/jobs/2"
         },
         "tenants": {
           "href": "https://vac:1281/v2/tenants/2"
         }
       }
     },
     {
       "id": 1,
       "name": "Sandbox Cloud Replica",
       "status": "Warning",
       "type": "Replication",
       "lastRun": "2019-03-01T10:16:48.68Z",
       "endTime": "2019-03-01T10:17:43.483Z",
       "duration": 256,
       "durationUnits": "s",
       "processingRate": 15.12,
       "processingRateUnits": "MB/s",
       "avgDuration": 315,
       "avgDurationUnits": "s",
       "transferredData": 1.03,
       "transferredDataUnits": "GB",
       "bottleneck": "-",
       "serverName": "BACKUP02",
       "isEnabled": true,
       "protectedVMs": 2,
       "schedulingType": "Periodically",

       "companyId": 3

       "locationId": 3
       "actions": [
         "stop",
         "retry",
         "enable",
         "disable",
         "start"
       ],
       "_links": {
         "self": {
           "href": "https://vac:1281/v2/jobs/1"
         },
         "tenants": {
             "href": "https://vac:1281/v2/tenants/3"
         }
       }
     }
    ]