Update properties on a Protocol Tunnel Jump Item.

patch

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

Path Params

int32

required

1 to 2147483647

Body Params

A Protocol Tunnel Jump Item object 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:

tag

string

length between 0 and 64

comments

string

length between 0 and 1024

jump_policy_id

int32 | null

1 to 2147483647

session_policy_id

int32 | null

2 to 2147483647

tunnel_listen_address

string

length between 0 and 32

Defaults to 127.0.0.1

tunnel_definitions

string

length between 0 and 5000

tunnel_type

string

enum

Defaults to tcp

Allowed:

username

string

length between 0 and 128

database

string

length between 0 and 128

url

string

length between 1 and 256

ca_certificates

string

length between 1 and 12288

Responses

Language

URL

Response

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

application/json

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

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.