This is an archive version of the document. To get the most up-to-date information, see the current version.Get Collection of Sessions
You can get a list of sessions stored in the Veeam Backup for AWS database.
Request
To retrieve a representation of a collection of sessions, send the HTTP GET request to the /sessions endpoint.
HTTP Request
GET https://<hostname>:<port>/api/v1/sessions |
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 |
|---|---|---|
Sort |
| Specifies the order of items in the response. For more information, see Sort Parameter. |
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. |
Usn | integer($int64) | Returns only sessions with the specified USN. 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 EC2 instance 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. |
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. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Accept | Optional |
| 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. |
Response
The server returns the following response to the client.
Response Code
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 AWS returns a representation of the /sessions collection. The Session schema is used for the collection representation.
Example
The following request returns a full list of sessions stored in the Veeam Backup for AWS database.
|