Get Job Configured for Veeam Agent for Microsoft Windows
You can get a resource representation of a Veeam Agent for Microsoft Windows job with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a resource representation of a Veeam Agent for Microsoft Windows job, send the GET HTTP request to the URL of the /infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid} |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
backupAgentUid | Path | String (uuid) | Yes | — | Veeam backup agent UID |
backupAgentJobUid | Path | String (uuid) | Yes | — | Veeam backup agent job UID |
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 resource representation based on the BackupAgentJob schema.
Example 
The following request returns a representation of a Veeam Agent for Microsoft Windows job with UID 724111ac-15f5-bf02-604d-20862fbafece.
Request: GET https://localhost:1280/api/v3/infrastructure/backupAgents/windows/07673b42-89fb-7227-9c6a-95e6908f25de/jobs/724111ac-15f5-bf02-604d-20862fbafece
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data":{ "instanceUid": "724111ac-15f5-bf02-604d-20862fbafece", "backupAgentUid": "07673b42-89fb-7227-9c6a-95e6908f25de", "organizationUid": "20c8486b-8c20-4b24-86a5-7cf31751c504", "name": "Workstation: File level backup. Personal files. Local drive. Daily schedule._restv3em", "configUid": "4610eb17-b41c-4cc5-81d1-938e57d89b7a", "backupPolicyUid": "7d953629-677a-408f-88ed-9b61031b8151", "backupPolicyFailureMessage": null, "status": "success", "operationMode": "workstation", "destination": "C:\VeeamBackup", "restorePoints": 4, "lastRun": "2020-03-01T11:35:00+03:00", "lastEndTime": "2020-03-01T11:45:13+03:00", "lastDuration": 613, "nextRun": "2020-03-02T11:30:00+03:00", "avgDuration": 575, "backupMode": "file", "targetType": "local", "isEnabled": true, "scheduleType": "daily", "scheduleEvents": [], "lastModifiedDate": "2020-02-28T04:17:34.507218+03:00", "lastModifiedBy": "vspc\administrator", "failureMessage": null, "backedUpSize": 12550788 } } |
