Adds a new Protocol Tunnel Jump Item.

post

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

Creates a new Protocol Tunnel Jump Item with the properties given in the request body.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length between 1 and 128

The name of the Protocol Tunnel Jump Item.

jumpoint_id

int32

required

1 to 2147483647

The unique identifier of the Jumpoint through which connections are made. For Kubernetes tunnel Jump Items, only Linux jumpoints are supported.

hostname

string

required

length between 1 and 128

The hostname or IP address. The hostname is not required for Kubernetes tunnel Jump Items. It is automatically set to be the same as the url. If the url is longer than 128 characters the hostname will be truncated.

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:

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.

session_policy_id

int32 | null

2 to 2147483647

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

tunnel_listen_address

string

length between 0 and 32

Defaults to 127.0.0.1

For TCP tunnel Jump Items, this is the IPv4 address on which the users should connect to start tunnels. The value must be within the 127.0.0.0/24 subnet.

tunnel_definitions

string

length between 0 and 5000

For TCP tunnel Jump Items, this describes the tunnels that should be created for the remote system as pairs of local and remote ports.

Example: For a 2-sets of local & remote ports (22,24) and (26,28), this field must be "22;24;26;28".

The local ports must be between 0 and 65535, inclusive and the remote ports must be between 1 and 65535, inclusive.

This is a required field when the tunnel type is 'tcp' and ignored for other types.

tunnel_type

string

enum

Defaults to tcp

One of the following:

tcp
mssql
k8s

Allowed:

username

string

length between 0 and 128

The database username required for MSSQL tunnel Jump Items.

database

string

length between 0 and 128

The database name used for MSSQL tunnel Jump Items.

url

string

length between 1 and 256

The url used for Kubernetes tunnel Jump Items. This field is required when tunnel_type is k8s.

ca_certificates

string

length between 1 and 12288

The certificate used for Kubernetes tunnel Jump Items. This field is required when tunnel_type is k8s.

Responses

201Indicates the Protocol Tunnel Jump Item was created successfully and contains the new instance. The Location header contains the URL of the 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.