DocumentationAPI ReferenceRelease Notes
API Reference

Create a Jump Client installer

post
https://support.example.com/api/config/v1/jump-client/installer

The response body returns a unique installer identifier that can be used to download the installer for a specific platform, and the key information needed to deploy a Windows MSI installer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

New Jump Client properties.

string
length between 0 and 128

The name for the Jump Clients deployed using this installer. If left blank, the Jump Client name will be set to the name of the computer on which the installer is deployed.

integer
required
1 to 2147483647

The shared Jump Group that will own the Jump Clients deployed using this installer.

string
enum
Defaults to shared

The type of Jump Group that owns this Jump Clients.

Allowed:
integer
1 to 2147483647

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

string
length between 0 and 64

The tag for the Jump Clients deployed using this installer.

string
enum
Defaults to active

The type of Jump Client to deploy. Cloud deployments only allow active installers.

Allowed:
integer | null
2 to 2147483647

The session policy used when an end user is present on the Jump Client system.

integer | null
2 to 2147483647

The session policy used when an end user is not present on the Jump Client system.

string
length between 0 and 1024

The comments for the Jump Clients deployed using this installer.

integer
10 to 525600
Defaults to 1440

The number of minutes that the installer will be valid after it is downloaded. When the installer expires it can no longer be used to deploy new jump clients.

boolean
Defaults to true

If true, the installer will attempt to elevate the Jump Client to make it run as a service.

boolean
Defaults to true

If true, the installer will prompt for elevation credentials if necessary. This parameter is ignored if elevate_install is false.

string
enum
Defaults to normal

This setting determines how sessions are started from the deployed Jump Client. If normal, the customer client will start with the window visible. If minimized, it will start with the window minimized. If hidden, it will start with no visible customer window and will not appear in the taskbar. Hidden mode requires additional permission.

Allowed:
boolean
Defaults to false

If true, the jump group can be specified during installation, which will override the jump group id specified in this API call.

boolean
Defaults to false

If true, the jump policy can be specified during installation, which will override the jump policy id specified in this API call.

boolean
Defaults to false

If true, the name can be specified during installation, which will override the name specified in this API call.

boolean
Defaults to false

If true, the tag can be specified during installation, which will override the tag specified in this API call.

boolean
Defaults to false

If true, the comments can be specified during installation, which will override the comments specified in this API call.

boolean
Defaults to false

If true, the attended session policy can be specified during installation, which will override the value specified in this API call.

boolean
Defaults to false

If true, the unattended session policy can be specified during installation, which will override the value specified in this API call.

string
length ≤ 64

The name of the Jumpoint. It must be online with Jump Zone Proxy enabled.

Responses

Updated 7 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.