Update properties on a Shell Jump Item.

patch

https://{support.example.com}/api/config/v1/jump-item/shell-jump/{id}

Modifies the existing Shell Jump Item resource with the given {id}.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

1 to 2147483647

Unique identifier for the resource.

Body Params

A Shell Jump Item object with modified properties.

name

string

required

length between 1 and 128

The name of the Shell 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 SSH.

protocol

string

enum

required

Allowed:

port

int32

1 to 65535

Defaults to SSH: 22, Telnet: 23

The port to use for SSH or telnet. Must be between 1 and 65535, inclusive. Defaults to 22 if the protocol is SSH or 23 if the protocol is Telnet.

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:

terminal

string

enum

Defaults to xterm

One of the following:

xterm
VT100

Allowed:

keep_alive

int32

0 to 300

The number of seconds between each packet sent to keep an idle session from ending. Must be between 0 and 300, inclusive. 0 disables keep-alive.

tag

string

length between 0 and 64

The Jump Item's tag.

comments

string

length between 0 and 1024

The Jump Item's comments.

jump_policy_id

int32 | null

1 to 2147483647

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

username

string

length ≤ 128

The default username that will be used to authenticate with the remote system. This is only used when credentials are not available from the ECM or Vault.

session_policy_id

int32 | null

2 to 2147483647

The unique identifier of the Session Policy used to control the rep's capabilities in the session.

Response

200Indicates the Shell Jump Item was successfully updated and contains an updated Shell Jump Item instance.