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 representative console.

The command API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the Remote Support API. The API account must have full access to the command API.

Required Parameters for import_jump_shortcut - Local Jump

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 team 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.

public_portal=[string]

The public portal through which this Jump Item should connect.

 

Required Parameters for import_jump_shortcut - Remote Jump

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 team 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.

public_portal=[string]

The public portal through which this Jump Item should connect.

 

Required Parameters for import_jump_shortcut - Remote Desktop Protocol

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 team 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.

public_portal=[string]

The public portal through which this Jump Item should connect.

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 - Local Remote Desktop Protocol

rdp_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 team 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_shortcuts - Local 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.

public_portal=[string]

The public portal through which this Jump Item should connect.

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 - Shell Jump Shortcut

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 team 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.

public_portal=[string]

The public portal through which this Jump Item should connect.

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 - Intel vPro Shortcut

vpro_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 team 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_shortcuts - Intel vPro Shortcut

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.

public_portal=[string]

The public portal through which this Jump Item should connect.

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.

 

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 a Local Jump shortcut to the endpoint with hostname "ABCDEF02", pinning it to team "remote_access"
  • https://support.example.com/api/command?action=import_jump_shortcut&local_jump_hostname=ABCDEF02&group=remote_access
Import a Local Jump shortcut to the endpoint with hostname "ABCDEF02", pinning it to team "remote_access" and specifying its tag, comments, Jump Policy, and Session Policy
  • https://support.example.com/api/command?action=import_jump_shortcut&local_jump_hostname=ABCDEF02&group=remote_access&tag=Frequent%20Access&comments=Web%20server&jump_policy=Notify&session_policy=Servers
Import a Remote Jump shortcut to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London", and pinning it to team "remote_access"
  • https://support.example.com/api/command?action=import_jump_shortcut&remote_jump_hostname=ABCDEF02&jumpoint=London&group=remote_access
Import a Remote Desktop Protocol shortcut to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London", and pinning it to team "remote_access"
  • https://support.example.com/api/command?action=import_jump_shortcut&rdp_hostname=ABCDEF02&jumpoint=London&group=remote_access
Import a Remote Desktop Protocol shortcut to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London", and pinning it to team "remote_access". Set the username, domain, display size, and quality. Make it a console session, and ignore untrusted certificates.
  • https://support.example.com/api/command?action=import_jump_shortcut&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
Import a Shell Jump shortcut to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London" on SSH, and pinning it to team "remote_access"
  • https://support.example.com/api/command?action=import_jump_shortcut&shelljump_hostname=ABCDEF02&jumpoint=London&protocol=ssh&group=remote_access
Import a Shell Jump shortcut to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London" on SSH, and pinning it to team "remote_access". Set the username, port, and terminal type, and set the keep-alive time to two minutes.
  • https://support.example.com/api/command?action=import_jump_shortcut&shelljump_hostname=ABCDEF02&jumpoint=London&protocol=ssh&group=remote_access&shelljump_username=admin&port=25&terminal=vt100&keep_alive=120
Import a Intel® vPro shortcut to the endpoint with hostname "ABCDEF02", accessed through Jumpoint "London", and pinning it to team "remote_access"
  • https://support.example.com/api/command?action=import_jump_shortcut&vpro_hostname=ABCDEF02&jumpoint=London&group=remote_access