Sessions management¶

Data structures¶

`SessionCommandModel`¶
Parameter	Type	Description
command	string{kill, suspend, resume}	required

`SessionModel`¶
Parameter	Type	Description
account		Required
id	int
name	string
destination_ip	IPv4	IP address of the target server
description_port	int	Port of the target server address
finished_at	DateTime	Datetime of the session termination
handled_by
id	int
listener
id	int	ID of the listener, via which the connection was established
name	string	Name of the listener, via which the connection was established
login_reason	string	Reason of the login into the system
protocol	string{checkout, citrixsf, http, ica, modbus, mysql, oracle, rdp, ssh, system, tcp, tds, telnet, tn3270, tn5250, vnc}
reason	string	Reason of establishing connection
safe		Read only
id	int	ID of the safe, via which the connection was established
name	string	Name of the safe, via which the connection was established
server		Read only
id	int	ID of the server, to which the connection was established
name	string	Name of the server, to which the connection was established
source_ip	IPv4	Source IP address
source_port	int	Port of the source IP address
started_at	DateTime	Datetime of the session start
status	string{approved, terminated}
user
id	int	ID of the user who was connected
name	string	Name of the user who was connected
dump_mode	string{all,none,raw}	Session recording options
paused	bool
ocr_enabled	bool	Enable OCR option
server_address
id	int
host	IPv4
port
http		Settings when `protocol == http`
host
tls_certificate
rdp		Settings when `protocol == rdp`
tls_certificate
public_key
ssh		Settings when `protocol == ssh`
public_key
tls

Request

Method	GET
Path	/api/system/sessions

Note

Results pagination

Every GET request, which returns a collection of objects can be optionally paginated. To achieve it add a pagination parameter to the request path:

/api/system/objects?page=3&page_size=10

Pagination parameters¶
page	int
page_size	int

Possible Response

Status	200 OK
Headers	Content-Type: Application/JSON
Body	[ SessionModel, ... ]

Request

Method	GET
Path	/api/system/sessions/:session_id

Possible Response

Status	200 OK
Headers	Content-Type: Application/JSON
Body	SessionModel

Possible Response

Status

404 NOT FOUND

Request

Method	POST
Path	/api/system/sessions/:session_id/command
Body	`SessionCommandModel`

Possible Response

Status	200 OK
Headers	Content-Type: Application/JSON
Body	SessionCommandModel

Possible Response

Status	400 BAD REQUEST
Headers	Content-Type: Application/JSON
Body	`ValidationErrors`

Possible Response

Status

404 NOT FOUND