Get Session Data

You can get data on a session with the specified ID.

Request

To retrieve information on a specific session, send the HTTP GET request to the /jobSession/{sessionId} endpoint. {sessionId} is a system ID assigned to the session in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

GET https://<hostname>/api/v2/jobSession/{sessionId}

Query Parameters

To control the amount and order of data in the response, you can use the following query parameters:

Query Parameter

Value

Description

instanceId

string

Returns only the session for the specified instance. For more information, see Filter Parameters.

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

  • application/json
  • application/problem+json

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 session with the specified ID. The Session schema is used for the resource representation.

Get Session DataExample

The following request returns information on a session with the ID 60a7fe13-6155-460b-8beb-42c3243fef05.

Request:

GET https://51.11.247.127/api/v2/jobSessions/60a7fe13-6155-460b-8beb-42c3243fef05

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "id": "60a7fe13-6155-460b-8beb-42c3243fef05",

 "type": "AutoBackup",

 "localizedType": "Auto Backup",

 "executionStartTime": "2020-11-23T08:00:03.629258Z",

 "executionStopTime": "2020-11-23T08:00:35.466351Z",

 "executionDuration": "00:00:31.8370930",

 "status": "Success",

 "usn": 518,

 "_links": {

   "self": {

     "href": "https://13.89.239.221/api/v2/jobSessions/60a7fe13-6155-460b-8beb-42c3243fef05"

   },

   "log": {

     "href": "https://13.89.239.221/api/v2/jobSessions/60a7fe13-6155-460b-8beb-42c3243fef05/log"

   }

 },

 "_embeddedResources": {}

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.