GET /systemSessions/{ID}
Returns a resource representation of a system session having the specified ID.
Request
To get a system session, send the GET HTTP request to the URL of the /systemSessions/{ID} resource.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/systemSessions/{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. For details, 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.
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, the REST API returns an entity or an entity reference of the /systemSessions/{ID} resource. The resource entity contains the following parameters and links.
Parameters
Element | Type | Description |
|---|---|---|
UID | UidType | UID of the system session resource, for example: urn:veeam:SystemSession:00057ade-8f1a-4b54-a265-391441981e25. |
Name | String | Name of the system session resource, for example: Collect Job @2023-01-27 17:05:52.069837. |
SessionType | String | Type of the system session. Possible values:
|
CreationTimeUTC | DateTime | Date and time when the system session was started. |
EndTimeUTC | DateTime | Date and time when the system session was ended. |
State | String | State of the system session. Possible values:
|
Result | SessionResultInfoType | Result of the system session. For details, see Session Result. |
Element | Type | Description |
|---|---|---|
Result | UidType | Result of the session. Possible values:
|
Message | String | Message with result details. |
IsCanceled | Bool | Defines whether the session was canceled or not. Possible values:
|
Links
Reference | Relationship | Description |
|---|---|---|
/systemSessions/{ID} | Alternate | Alternate URL of the /systemSessions/{ID} resource. |
/systemSessions/{ID}/events | Down | URL of the /systemSessions/{ID}/events resource — a collection of log events of the system session. |
Example
A sample request below returns an entity representation of the system session resource having ID 00057ade-8f1a-4b54-a265-391441981e25.
Request: GET https://localhost:9398/api/systemSessions/00057ade-8f1a-4b54-a265-391441981e25?format=Entity
Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj
Response: 200 OK
Response Body: <?xml version="1.0" encoding="utf-8"?> |