API v2: UAG - Account Hotseat Status 🆕

Note

  • The hotseat check will return true (i.e., the account is considered in use) only if the rdp_hotseat option is enabled for the server associated with the account.

  • This setting corresponds to the “Inform about existing connection” option in the server configuration UI.

  • Only sessions that are established via |product_name| can be detected by this mechanism. Sessions opened outside of Fudo (e.g., direct RDP connections) will not trigger hotseat: true.

To enable it via API:

curl -s -k -X PATCH \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  -H 'Content-Type: application/json' \
  https://<host>/api/v2/server/<server_id> \
  -d '{"rdp_hotseat": true}'

Without this option, the endpoint will always return hotseat: false, even if a session is active.

Data Structures

AccountHotseatModel

Attribute

Type

Required

Description

account_id

string

yes

ID of an account to check.

server_address

string

yes

Address of a server to check.

server_port

number

yes

Port of a server to check.

Retrieve Available Attributes of the AccountHotseatModel

Request

Method

GET

Path

/api/v2/objspec/account_hotseat

GET /api/v2/objspec/account_hotseat

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/objspec/account_hotseat'

Request Hotseat Status

Request

Method

POST

Path

/api/v2/account/<account_id>/hotseat

Headers

Content-Type: application/json

Body

AccountHotseatModel

POST /api/v2/account/<account_id>/hotseat

Example Request

curl -s -k -X POST \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  -H 'Content-Type: application/json' \
  -d '{"server_address": "10.0.0.1", "server_port": 3389}' \
  https://10.0.0.1/api/v2/account/8169529724050079749/hotseat

Response

{
   "hotseat": true,
   "message": null,
   "result": "success"
}