DocumentationAPI ReferenceRelease Notes
API Reference

Update properties on a Remote RDP Jump Item resource.

patch
https://{support.example.com}/api/config/v1/jump-item/remote-rdp/

Modifies an existing Remote RDP Jump Item resource with the given {id} using the given properties.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
1 to 2147483647

Unique identifier for the resource.

Body Params

A Remote RDP Jump Item resource with modified properties.

string
required
length between 1 and 128

The name of the Remote RDP Jump Item.

int32
required
1 to 2147483647

The unique identifier of the Jumpoint 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 Jump Group or user that owns this Jump Item.

string
enum
Defaults to shared

The type of Jump Group that owns this Jump Item.

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 Jump Item's tag.

string
length between 0 and 1024

The Jump Item'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 Jump Policy used to manage access to this Jump Item.

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 Jump Item.

Responses

Updated 4 months ago

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

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