Update properties on a Remote RDP Jump Item resource.

patch

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

Path Params

int32

required

1 to 2147483647

Body Params

A Remote RDP Jump Item resource with modified properties.

name

string

required

length between 1 and 128

jumpoint_id

int32

required

1 to 2147483647

hostname

string

required

length between 1 and 128

jump_group_id

int32

required

1 to 2147483647

jump_group_type

string

enum

Defaults to shared

Allowed:

quality

string

enum

Defaults to best_performance

Allowed:

console

boolean

Defaults to false

ignore_untrusted

boolean

Defaults to false

tag

string

length between 0 and 64

comments

string

length between 0 and 1024

rdp_username

string

length between 0 and 128

domain

string

length between 0 and 64

jump_policy_id

int32 | null

1 to 2147483647

session_forensics

boolean

Defaults to false

session_policy_id

int32 | null

2 to 2147483647

rds_collection

string

length between 0 and 256

secure_app_type

string

enum

Allowed:

remote_app_name

string

length between 0 and 512

remote_app_params

string

length between 0 and 8000

remote_exe_path

string

length between 0 and 512

remote_exe_params

string

length between 0 and 8000

target_system

string

length between 0 and 250

credential_type

string

length between 0 and 250

Responses

Language

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Indicates the existing Remote RDP Jump Item was successfully updated and returns the updated Remote RDP Jump Item.

404The specified resource was not found.

422One or more request parameters are invalid. The body contains a general error message as well as a validation error dictionary.