DocumentationAPI ReferenceRelease Notes
API Reference

Create Admin Session

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

Creates an Administrative Session.

Required Permission(s)

  • Password Safe Admin Session (Full control)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Administrative Session configuration

Password Safe Admin Session

string | null

(required) Type of session:

  • SSH or sshticket
  • RDP or rdpticket
  • rdpfile
uuid | null

ID of the Session Node to establish the Session. If NodeID is not given or if the Remote Session Proxy feature is disabled, uses the local node.

string | null

(required) Target host Name or IP

int32 | null
Defaults to <configured default port>

Target host Port

string | null

Domain name used to authenticate

string | null

Username used to authenticate

string | null

Password used to authenticate

string | null

Reason for the Session

string | null
Defaults to <configured default resolution>

(RDP-only) RDP Session resolution (i.e 1024x768, 1920x1600, Maximized, etc.)

boolean
Defaults to false

(RDP-only) True to use RDP Smart Sizing, otherwise false (when <see cref="P:BeyondTrust.PasswordSafe.API.Models.SessionAdminModel.SessionType">SessionType</see>=rdpfile)

boolean
Defaults to false

(RDP-only) True to perform a Remote Administration Session (mstsc /admin), otherwise false

boolean
Defaults to false

(RDP-only) True to use all monitors, otherwise false (when <see cref="P:BeyondTrust.PasswordSafe.API.Models.SessionAdminModel.SessionType">SessionType</see>=rdpfile)

boolean
Defaults to true

True to record the Session, otherwise false. Ignored and always recorded if the Global Setting Hide Record Checkbox for Admin Sessions is enabled.

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 20 days 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 20 days 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.