This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Job Sessions
You can get a resource representation of a collection of all job sessions created for backup and backup copy jobs.
Request
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following optional parameters can be specified in the URL of the request:
Parameter | Type | Description |
|---|---|---|
jobType | string | Specifies the type of the job session. The following types are available:
|
endTimeLowerBound | UTC | Specifies the date and time starting from which you want to get a collection of job sessions. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
|---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
In the response body, the server returns a resource representation of the /JobSessions collection resource.
Example
The example returns a resource representation of all backup and backup copy job sessions in Veeam Backup for Microsoft 365.
Request: GET https://abc.tech.local:4443/v6/JobSessions
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "offset": 0, "limit": 30, "_links": { "self": { "href": "/v6/JobSessions?offset=0&limit=30" }, "next": { "href": "/v6/JobSessions?offset=30&limit=30" } }, "results": [ { "id": "fcb1c775-edbb-4beb-830f-fb051ef9ab1b", "details": "Transferred: 0 B (0 items) at 0 B/s (0 items/s)", "creationTime": "2022-01-31T16:39:24.008771Z", "endTime": "2022-01-31T16:39:33.402312Z", "retryCount": 0, "progress": 1, "status": "Success", "statistics": { "processingRateBytesPS": 0, "processingRateItemsPS": 0, "readRateBytesPS": 797001305, "writeRateBytesPS": 41, "transferredDataBytes": 0, "processedObjects": 0, "bottleneck": "Target" }, "_links": { "self": { "href": "/v6/jobsessions/fcb1c775-edbb-4beb-830f-fb051ef9ab1b" }, "log": { "href": "/v6/jobsessions/fcb1c775-edbb-4beb-830f-fb051ef9ab1b/logitems" }, "job": { "href": "/v6/jobs/1f6f7c97-0df4-4866-8c37-309fda301894" } } }, { "id": "8b92cfa3-6b94-4f62-b40a-7ecfa988ae08", "details": "Some objects were processed with warnings", "creationTime": "2022-01-31T16:38:59.5293747Z", "endTime": "2022-01-31T16:39:23.6847549Z", "retryCount": 3, "progress": 0, "status": "Warning", "statistics": { "processingRateBytesPS": 30457, "processingRateItemsPS": 0, "readRateBytesPS": 327661, "writeRateBytesPS": 0, "transferredDataBytes": 359459, "processedObjects": 0, "bottleneck": "Target" }, "_links": { "self": { "href": "/v6/jobsessions/8b92cfa3-6b94-4f62-b40a-7ecfa988ae08" }, "log": { "href": "/v6/jobsessions/8b92cfa3-6b94-4f62-b40a-7ecfa988ae08/logitems" }, "job": { "href": "/v6/jobs/b7c1cc0b-2b3c-4096-9ba1-2d665b4ae504" } } }, { "id": "d5f34eeb-17cc-48f9-bab0-4fc5cee225b5", "details": "Transferred: 36.1 KB (6 items) at 2.4 KB/s (0 items/s)", "creationTime": "2022-01-31T16:08:19.6369789Z", "endTime": "2022-01-31T16:11:55.7263477Z", "retryCount": 0, "progress": 76, "status": "Success", "statistics": { "processingRateBytesPS": 2484, "processingRateItemsPS": 0, "readRateBytesPS": 0, "writeRateBytesPS": 17, "transferredDataBytes": 36924, "processedObjects": 6, "bottleneck": "Source" }, "_links": { "self": { "href": "/v6/jobsessions/d5f34eeb-17cc-48f9-bab0-4fc5cee225b5" }, "log": { "href": "/v6/jobsessions/d5f34eeb-17cc-48f9-bab0-4fc5cee225b5/logitems" }, "job": { "href": "/v6/jobs/1f6f7c97-0df4-4866-8c37-309fda301894" } } }, ... ], "setId": "00000000-0000-0000-0000-000000000000" } |
