DocumentationAPI ReferenceRelease Notes
API Reference

Create session by request ID

post
https://example.com/beyondtrust/api/public/v3/requests//sessions

Creates a new session for an approved access request with specified session configuration.

Required Permission(s)

  • Must be the owner of the request ID.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The ID of the approved request for which to create the session

Body Params

Session configuration including type, resolution, and monitoring preferences

string | null

Type of session (SSH or sshticket, RDP or rdpticket, rdpfile, app, or appfile)

string | null

Resolution of session, e.g. 1024x768, Maximized

uuid | null

ID of the node used to establish the session

boolean | null

True to perform a Remote Administration Session (mstsc /admin switch), otherwise false.

boolean

Indicates if session should span multiple monitors

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 9 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.