Create a Remote RDP Jump Item.

post

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

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

New Remote RDP Jump Item properties.

name

string

required

length between 1 and 128

The name of the Remote RDP Jump Item.

jumpoint_id

int32

required

1 to 2147483647

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

hostname

string

required

length between 1 and 128

The hostname or IP address used to connect over RDP.

jump_group_id

int32

required

1 to 2147483647

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

jump_group_type

string

enum

Defaults to shared

The type of Jump Group that owns this Jump Item.

Allowed:

quality

string

enum

Defaults to video

The quality of the connection. One of the following:

low
performance
performance_quality
quality
video
lossless

Allowed:

console

boolean

Defaults to false

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

ignore_untrusted

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.

tag

string

length between 0 and 64

The Jump Item's tag.

comments

string

length between 0 and 1024

The Jump Item's comments.

rdp_username

string

length between 0 and 128

The Endpoint username.

domain

string

length between 0 and 64

The Endpoint domain.

jump_policy_id

int32 | null

1 to 2147483647

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

session_policy_id

int32 | null

2 to 2147483647

The unique identifier of the Session Policy.

Responses

201Indicates the Remote RDP Jump Item was created successfully and contains the new Remote RDP Jump Item instance. The Location header contains the URL of the Remote RDP Jump Item.

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