DocumentationAPI ReferenceRelease Notes
API Reference

Create a Remote RDP Asset.

post
https://sespog-rs.qabeyondtrustcloud.com/api/config/v1/jump-item/remote-rdp

Adds a new Remote RDP Asset resource.
The response body contains the new Remote RDP Asset.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

New Remote RDP Asset properties.

string
required
length between 1 and 128

The name of the Remote RDP Asset.

int32
required
1 to 2147483647

The unique identifier of the Gateway through which connections are made.

string
required
length between 1 and 128

The hostname or IP address used to connect over RDP.

int32
required
1 to 2147483647

The unique identifier of the Asset Group or user that owns this Asset.

string
enum
Defaults to shared

The type of Asset Group that owns this Asset.

Allowed:
string
enum
Defaults to best_performance

The quality of the connection. One of the following:

  • low
  • performance
  • performance_quality
  • quality
  • best_performance
  • lossless
Allowed:
boolean
Defaults to false

If true, starts a console session. If false, starts a new session.

boolean
Defaults to false

If true, untrusted server certificates are ignored. If false, the user is shown a warning when the server's certificate cannot be verified.

string
length between 0 and 64

The Asset's tag.

string
length between 0 and 1024

The Asset's comments.

string
length between 0 and 128

The Endpoint username.

string
length between 0 and 64

The Endpoint domain.

int32 | null
1 to 2147483647

The unique identifier of the Asset Policy used to manage access to this Asset.

boolean
Defaults to false

If true, enables RDP with Session Forensics functionality. If false, uses normal RDP functionality.

int32 | null
2 to 2147483647

The unique identifier of the Session Policy.

string
length between 0 and 256

The name of the RDS collection associated with this Remote RDP Asset.

Responses

Updated 4 days ago

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

Updated 4 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.