API Command: import_jump_shortcut

The import_jump_shortcut command creates a Jump shortcut. When dealing with a large number of Jump shortcuts, it may be easier to import them programmatically than to add them one by one in the access console.

The command API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the Privileged Access API. The API account used to issue this command must have full access to the command API.

Required Parameters for import_jump_shortcut - Local Jump

name=[string]

The name of the endpoint to be accessed by this Jump Item. This name identifies the item in the session tabs. This string has a maximum of 128 characters.

local_jump_hostname=[string]

The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters.

group=[string]

The code name of the Jump Group with which this Jump Item should be associated.

Note: When using the import method, a Jump Item cannot be associated with a personal list of Jump Items.

Optional Parameters for import_jump_shortcut - Local Jump

tag=[string]

You can organize your Jump Items into categories by adding a tag. This string has a maximum of 1024 characters.

comments=[string]

You can add comments to your Jump Items. This string has a maximum of 1024 characters.

jump_policy=[string]

The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item.

session_policy=[string]

The code name of a session policy. You can specify a session policy to manage the permissions available on this Jump Item.

 

Required Parameters for import_jump_shortcut - Remote Jump

name=[string]

The name of the endpoint to be accessed by this Jump Item. This name identifies the item in the session tabs. This string has a maximum of 128 characters.

remote_jump_hostname=[string]

The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters.

jumpoint=[string]

The code name of the Jumpoint through which the endpoint is accessed.

group=[string]

The code name of the Jump Group with which this Jump Item should be associated.

Note: When using the import method, a Jump Item cannot be associated with a personal list of Jump Items.

Optional Parameters for import_jump_shortcut - Remote Jump

tag=[string]

You can organize your Jump Items into categories by adding a tag. This string has a maximum of 1024 characters.

comments=[string]

You can add comments to your Jump Items. This string has a maximum of 1024 characters.

jump_policy=[string]

The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item.

session_policy=[string]

The code name of a session policy. You can specify a session policy to manage the permissions available on this Jump Item.

 

Required Parameters for import_jump_shortcut - VNC

remote_vnc_hostname=[string]

The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters.

jumpoint=[string]

The code name of the Jumpoint through which the endpoint is accessed.

name=[string]

The name of the endpoint to be accessed by this Jump Item. This name identifies the item in the session tabs. This string has a maximum of 128 characters.

group=[string]

The code name of the Jump Group with which this Jump Item should be associated.

Note: When using the import method, a Jump Item cannot be associated with a personal list of Jump Items.

Optional Parameters for import_jump_shortcut - VNC

port=[integer]

A valid port number from 100 to 65535. Defaults to 5900.

tag=[string]

You can organize your Jump Items into categories by adding a tag. This string has a maximum of 1024 characters.

comments=[string]

You can add comments to your Jump Items. This string has a maximum of 1024 characters.

jump_policy=[string]

The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item.

 

Required Parameters for import_jump_shortcut - Remote Desktop Protocol

name=[string]

The name of the endpoint to be accessed by this Jump Item. This name identifies the item in the session tabs. This string has a maximum of 128 characters.

remote_rdp_hostname=[string]

The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters.

jumpoint=[string]

The code name of the Jumpoint through which the endpoint is accessed.

group=[string]

The code name of the Jump Group with which this Jump Item should be associated.

Note: When using the import method, a Jump Item cannot be associated with a personal list of Jump Items.

Optional Parameters for import_jump_shortcut - Remote Desktop Protocol

rdp_username=[string]

The username to sign in as.

domain=[string]

The domain the endpoint is on.

display_size=[string]

The resolution at which to view the remote system. Can be primary (default - the size of your primary monitor), all (the size of all of your monitors combined), or XxY (where X and Y are a supported width and height combination - e.g., 640x480).

quality=[string]

The quality at which to view the remote system. Can be low (2-bit gray scale for the lowest bandwidth consumption), best_perf (default - 8-bit color for fast performance), perf_and_qual (16-bit for medium quality image and performance), best_qual (32-bit for the highest image resolution), or video_opt (VP9 codec for more fluid video). This cannot be changed during the remote desktop protocol (RDP) session.

console=[boolean]

1: Starts a console session.
0: Starts a new session (default).

ignore_untrusted=[boolean]

1: Ignores certificate warnings.
0: Shows a warning if the server's certificate cannot be verified.

tag=[string]

You can organize your Jump Items into categories by adding a tag. This string has a maximum of 1024 characters.

comments=[string]

You can add comments to your Jump Items. This string has a maximum of 1024 characters.

jump_policy=[string]

The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item.

session_policy=[string]

The code name of a session policy. You can specify a session policy to manage the permissions available on this Jump Item.

sql_server_hostname=[string] The hostname of the SQL Server used to access SQL Server Management Studio. This string has a maximum of 64 characters.
sql_server_port=[integer] The port used to access the SQL Server instance. The port value accepts only integers in the range of 1-65535, with 1433 as the default value.
sql_server_database=[string] The database name of the SQL Server instance being accessed.. This string has a maximum of 520 characters.
custom_app_name=[string] The name of the remote application being accessed. This string has a maximum of 520 characters.
custom_app_params=[string] A space-separated list of parameters to pass to the remote application. Parameters with spaces can be delimited using double-quotes. This string has a maximum of 16,000 characters.

 

Required Parameters for import_jump_shortcut - Shell Jump Shortcut

name=[string]

The name of the endpoint to be accessed by this Jump Item. This name identifies the item in the session tabs. This string has a maximum of 128 characters.

shelljump_hostname=[string]

The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters.

jumpoint=[string]

The code name of the Jumpoint through which the endpoint is accessed.

protocol=[string] Can be either ssh or telnet.
group=[string]

The code name of the Jump Group with which this Jump Item should be associated.

Note: When using the import method, a Jump Item cannot be associated with a personal list of Jump Items.

Optional Parameters for import_jump_shortcut - Shell Jump Shortcut

shelljump_username=[string]

The username to sign in as.

port=[integer]

A valid port number from 1 to 65535. Defaults to 22 if the protocol is ssh or 23 if the protocol is telnet.

terminal=[string]

Can be either xterm (default) or VT100.

keep_alive=[integer]

The number of seconds between each packet sent to keep an idle session from ending. Can be any number from 0 to 300. 0 disables keep-alive (default).

tag=[string]

You can organize your Jump Items into categories by adding a tag. This string has a maximum of 1024 characters.

comments=[string]

You can add comments to your Jump Items. This string has a maximum of 1024 characters.

jump_policy=[string]

The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item.

session_policy=[string]

The code name of a session policy. You can specify a session policy to manage the permissions available on this Jump Item.

 

Required Parameters for import_jump_shortcut - Protocol Tunnel Jump Shortcut

Field Description
protocol_tunnel_hostname

The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters.

jumpoint

The code name of the Jumpoint through which the endpoint is accessed.

tcp_tunnels

The list of one or more tunnel definitions. A tunnel definition is a mapping of a TCP port on the local user's system to a TCP port on the remote endpoint. Any connection made to the local port causes a connection to be made to the remote port, allowing data to be tunnelled between local and remote systems. Multiple mappings should be separated by a semicolon.

Example: auto->22;3306->3306

In the example above, a randomly assigned local port maps to remote port 22, and local port 3306 maps to remote port 3306.

name=[string]

The name of the endpoint to be accessed by this Jump Item. This name identifies the item in the session tabs. This string has a maximum of 128 characters.

group

The code name of the Jump Group with which this Jump Item should be associated.

Note: When using the import method, a Jump Item cannot be associated with a personal list of Jump Items.

Optional Parameters for import_jump_shortcut - Protocol Tunnel Jump Shortcut

Field Description
local_address

The address from which the connection should be made. This can be any address within the 127.x.x.x subrange. The default address is 127.0.0.1.

tag

You can organize your Jump Items into categories by adding a tag. This string has a maximum of 1024 characters.

comments

You can add comments to your Jump Items. This string has a maximum of 1024 characters.

jump_policy

The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item.

 

Required Parameters for import_jump_shortcut - Web Jump Shortcut

Field Description
website_name

The name of the endpoint to be accessed by this Jump Item. This name identifies the item in the session tabs. This string has a maximum of 128 characters.

jumpoint

The code name of the Jumpoint through which the endpoint is accessed.

url

The URL of the website. The URL must begin with either http or https.

group

The code name of the Jump Group with which this Jump Item should be associated.

Note: When using the import method, a Jump Item cannot be associated with a personal list of Jump Items.

Optional Parameters for import_jump_shortcut - Web Jump Shortcut

Field Description
verify_certificate

1: The site certificate is validated before the session starts; if issues are found, the session will not start.
0: The site certificate is not validated.

tag

You can organize your Jump Items into categories by adding a tag. This string has a maximum of 1024 characters.

comments

You can add comments to your Jump Items. This string has a maximum of 1024 characters.

jump_policy

The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item.

session_policy

The code name of a session policy. You can specify a session policy to manage the permissions available on this Jump Item.

 

XML Response for import_jump_shortcut Query

<success> Returns a message of Successfully imported Jump Item shortcut if the import succeeded.
<error> Returns an error message if the import failed.

Query Examples: import_jump_shortcut

Import Local Jump shortcut "Endpoint" to the endpoint with hostname "ABCDEF02", pinning it to Jump Group "remote_access"
  • https://access.example.com/api/command?action=
    import_jump_shortcut&name=Endpoint&local_jump_hostname=
    ABCDEF02&group=remote_access
Import Local Jump shortcut "Endpoint" to the endpoint with hostname "ABCDEF02", pinning it to Jump Group "remote_access" and specifying its tag, comments, Jump Policy, and session policy
  • https://access.example.com/api/command?action=
    import_jump_shortcut&name=Endpoint&local_jump_hostname=
    ABCDEF02&group=remote_access&tag=Frequent%20Access&
    comments=Web%20server&jump_policy=Notify&
    session_policy=Servers
Import Remote Jump shortcut "Endpoint" to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London", pinning it to Jump Group "remote_access"
  • https://access.example.com/api/command?action=
    import_jump_shortcut&name=Endpoint&remote_jump_hostname=
    ABCDEF02&jumpoint=London&group=remote_access
Import VNC shortcut "Endpoint" to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London", pinning it to Jump Group "remote_access"
  • https://access.example.com/api/command?action=
    import_jump_shortcut&name=Endpoint&remote_vnc_hostname=
    ABCDEF02&jumpoint=London&group=remote_access
Import VNC shortcut "Endpoint" to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London", pinning it to Jump Group "remote_access" and specifying its port
  • https://access.example.com/api/command?action=
    import_jump_shortcut&name=Endpoint&remote_vnc_hostname=
    ABCDEF02&jumpoint=London&group=remote_access&port=100
Import RDP shortcut "Endpoint" to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London", pinning it to Jump Group "remote_access"
  • https://access.example.com/api/command?action=
    import_jump_shortcut&name=Endpoint&remote_rdp_hostname=
    ABCDEF02&jumpoint=London&group=remote_access
Import RDP shortcut "Endpoint" to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London", pinning it to Jump Group "remote_access" and specifying its username, domain, display size, quality, console session, untrusted certificate action, sql server name, sql server port, sql server database name, remote app name, and remote app parameters
  • https://access.example.com/api/command?action=
    import_jump_shortcut&name=Endpoint&remote_rdp_hostname=
    ABCDEF02&jumpoint=London&group=remote_access&rdp_username=
    admin&domain=example&display_size=1280x720&quality=
    perf_and_qual&console=1&ignore_untrusted=1&
    sql_server_hostname=example.local&sql_server_port=1500&
    sql_server_database=example&custom_app_name=sql_server&
    custom_app_params=x,y,z
Import Shell Jump shortcut "Endpoint" to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London" over SSH, pinning it to Jump Group "remote_access"
  • https://access.example.com/api/command?action=
    import_jump_shortcut&name=Endpoint&shelljump_hostname=
    ABCDEF02&jumpoint=London&protocol=ssh&group=remote_access
Import Shell Jump shortcut "Endpoint" to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London" over SSH, pinning it to Jump Group "remote_access", and specifying its username, port, terminal type, and keep-alive settings
  • https://access.example.com/api/command?action=
    import_jump_shortcut&name=Endpoint&shelljump_hostname=
    ABCDEF02&jumpoint=London&protocol=ssh&group=remote_access&shelljump_username=admin&port=25&terminal=vt100&
    keep_alive=120
Import Protocol Tunnel Jump shortcut "Endpoint" to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London", pinning it to Jump Group "remote_access", with a randomly assigned local port mapping to remote port 22
  • https://access.example.com/api/command?action=
    import_jump_shortcut&name=Endpoint&
    protocol_tunnel_hostname=ABCDEF02&jumpoint=London&
    group=remote_access&tcp_tunnels=auto->22
Import Protocol Tunnel Jump shortcut "Endpoint" to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London", pinning it to Jump Group "remote_access", with a randomly assigned local port mapping to remote port 22, local port 3306 mapping to port 3306, and a local address of 127.0.0.5
  • https://access.example.com/api/command?action=
    import_jump_shortcut&name=Endpoint&
    protocol_tunnel_hostname=ABCDEF02&jumpoint=London&
    group=remote_access&tcp_tunnels=auto->22;3306->3306&
    local_address=127.0.0.5
Import Web Jump shortcut "Endpoint" to the endpoint with URL "example.com", accessed through Jumpoint "London", pinning it to Jump Group "remote_access"
  • https://access.example.com/api/command?action=
    import_jump_shortcut&website_name=Endpoint&url=
    example.com&jumpoint=London&group=remote_access
Import Web Jump shortcut "Endpoint" to the endpoint with URL "example.com", accessed through Jumpoint "London", pinning it to Jump Group "remote_access" and not requiring certificate validation
  • https://access.example.com/api/command?action=
    import_jump_shortcut&website_name=Endpoint&url=
    example.com&jumpoint=London&group=remote_access&
    verify_certificate=0