Administrator Sessions

List

Retrieve a list of admin sessions. State=1 means that a session is Connected, while State=4 means that a session is Disconnected.

GET/api/Session

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

userIdinteger (int32)

ID of the user of the session.

logonTimestring (date-time)

Session Logon Time.

ipnullable string

IP of the session.

stateSessionState (enum)

Session State

0 = Active,1 = Connected,2 = ConnectQuery,3 = Shadow,4 = Disconnected,5 = Idle,6 = Listen,7 = Reset,8 = Down,9 = Init,-1 = All

computerNamenullable string

Computer name of the session.

languageLanguage (enum)

Language

1 = English,2 = German,3 = Japanese,5 = French,6 = Spanish,7 = Italian,8 = Portuguese,9 = ChineseSimplified,10 = ChineseTraditional,11 = Korean

Request

JavaScriptCurlPython

const response = await fetch('/api/Session', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "logonTime": "2024-11-07T07:33:55.844Z",
    "ip": "text",
    "state": [
      "0 = Active",
      "1 = Connected",
      "2 = ConnectQuery",
      "3 = Shadow",
      "4 = Disconnected",
      "5 = Idle",
      "6 = Listen",
      "7 = Reset",
      "8 = Down",
      "9 = Init",
      "-1 = All"
    ],
    "computerName": "text",
    "language": [
      "1 = English",
      "2 = German",
      "3 = Japanese",
      "5 = French",
      "6 = Spanish",
      "7 = Italian",
      "8 = Portuguese",
      "9 = ChineseSimplified",
      "10 = ChineseTraditional",
      "11 = Korean"
    ]
  }
]