This is an archive version of the document. To get the most up-to-date information, see the current version.(GET) /backupSessions/{ID}
Returns a resource representation of a backup job session having the specified ID.
Request
To get a job session, you need to send the GET HTTP request to the URL of the /backupSessions/{ID} resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/backupSessions/{ID} |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|---|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values:
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Query Parameters
The following parameters can be used in queries.
Parameter | Type | Description | Can Be Used for Filtering | Can Be Used for Sorting |
|---|---|---|---|---|
Uid | URN | ID of the backup job session resource, for example: 88b395e2-81ff-439c-558c-188d97274c15. | True | True |
Name | String | Name of the backup job session resource, for example: exch@2013-08-26 22:28:51. | True | True |
String | Type of the backup job session. Possible values:
| True | True | |
JobUid | URN | ID of the backup job parent to the backup job session resource, for example: urn:veeam:Job:dce85686-59c8-42c4-8766-f1c00a5b8067. | True | True |
JobName | String | Name of the backup job parent to the backup job session resource, for example: SQL Backup. | True | True |
CreationTime | DateTime | Date and time when the backup job session was started. The parameter accepts only UTC-formatted DateTime values. | True | True |
EndTime | DateTime | Date and time when the backup job session was ended. The parameter accepts only UTC-formatted DateTime values. | True | True |
State | String | State of the backup job session. Possible values:
| True | True |
Result | String | Result of the backup job session. Possible values:
| True | True |
IsRetry | Boolean | Defines whether the backup job session has been retried or not. Possible values:
| True | True |
BackupServerUid | URN | ID of the Veeam backup server parent to the backup job session resource. | True | True |
BackupServerName | String | Name of the Veeam backup server parent to the backup session resource. | True | True |
Response
The server returns the following response to the client.
Response Codes
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. Possible values:
|
Response Body
In the response body, Veeam Backup Enterprise Manager returns a representation of the /backupSessions/{ID} resource.
Example
A sample request below returns an entity representation of the backup job session resource having ID d46e39e0-1131-4585-91a7-e828ce7eafae.
Request: GET https://localhost:9398/api/backupSessions/d46e39e0-1131-4585-91a7-e828ce7eafae?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <BackupJobSession xmlns="http://www.veeam.com/ent/v1.0" Type="BackupJobSession" Href="https://localhost:9398/api/backupSessions/d46e39e0-1131-4585-91a7-e828ce7eafae?format=Entity" Name="Fileserver Backup@2014-10-19 05:22:52" UID="urn:veeam:BackupJobSession:d46e39e0-1131-4585-91a7-e828ce7eafae"> |