Get Collection of Sessions
You can get a list of sessions stored in the Veeam Backup for Microsoft Azure database.
Request
To retrieve a representation of a collection of sessions, send the HTTP GET request to the /jobSessions endpoint.
HTTP Request
GET https://<hostname>/api/v2/jobSessions |
Query Parameters
To control the amount and order of data in the response, you can use Offset, Limit and the following query parameters:
Query Parameter | Value | Description |
|---|---|---|
Status |
| Returns only sessions with the specified status. For more information, see Filter Parameters. |
Types |
| Returns only sessions of the specified session type. For more information, see Filter Parameters. |
PolicyId | string($uuid) | Returns only sessions of a backup policy with the specified ID. For more information, see Filter Parameters. |
VmId | string($uuid) | Returns only sessions where an Azure VM with the specified ID is processed. For more information, see Filter Parameters. |
FromUtc | string($date-time) | Returns only sessions run after the specified date and time. For more information, see Filter Parameters. |
ToUtc | string($date-time) | Returns only sessions run before the specified date and time. For more information, see Filter Parameters. |
Display |
| Returns full information on restored items or grouped. |
Request Headers
The request contains the following headers.
Header | Required | 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. |
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 HTTP headers.
Header | Value | Description |
|---|---|---|
Content-length | integer | Identifies the length of the response body message, in bytes. |
Content-type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for Microsoft Azure returns a representation of the /jobSessions collection. The JobSessionV2 schema is used for the collection representation.
Example
The following request returns a full list of sessions stored in the Veeam Backup for Microsoft Azure database.
|