Web Session Validation API

Validates web session availability for a specified user, optionally verifying a managed target's online status using a hostname or IP. Requires userID parameter; others are optional. Returns 200 (success), 400 (missing userID), 404 (unresolved user/target), and 503 (target offline).

Table 1. GET /ondemand/api/checkWebSession
Property Description
Summary Check web session availability.
Description Validates if a web session can be established for a specific user. If a hostname or IP is provided, it checks the online status of a managed target; otherwise, it proceeds with an unmanaged flow.
Query Parameters
userID (String, Required)
The email or ID of the requesting user.
targetHostname (String, Optional)
Hostname of the managed target.
targetIP (String, Optional)
IP address of the managed target (fallback).
Responses
  • 200 OK: Session check successful. For example - 
    {
  "sessionTypes": [
    "broker"
  ],
  "sessionModes": [
    "monitor",
    "active"
  ],
  "targetGuid": null,
  "loginURI": "/startWebController?sessionType=<sessionType>&sessionMode=<sessionMode>"
}
  • 400 Bad Request: Missing mandatory parameter userID.
  • 404 Not Found: User or target could not be resolved.
  • 503 Service Unavailable: The resolved target is offline.