DocumentationAPI ReferenceRelease Notes
API Reference

Adds a new Jumpoint.

post
https://support.example.com/api/config/v1/jumpoint

Creates a new Jumpoint with the properties given in the request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 1 and 255

The display name of the Jumpoint. This value must be unique.

string
enum
required

The platform of the Jumpoint. This attribute cannot be modified after the Jumpoint is created.

Allowed:
string
length between 0 and 64
^[a-zA-Z0-9_\\-]+$

The code name of a resource. This value must be unique.

string
length between 0 and 1024

The Jumpoint's comments.

boolean
Defaults to true

If true, the Jumpoint is enabled.

boolean
Defaults to false

If true, the Jumpoint can have more than one node. This attribute cannot be modified after the Jumpoint is created.

boolean
Defaults to false

If true, users are allowed to start Shell Jump sessions with the Jumpoint.

string
length between 0 and 1024

This field is only applicable when the option 'Allow Search for External Jump Items.' is Enabled in Management -> Security. The value must be unique if it is not empty.

boolean
Defaults to false

Indicates whether the Jump Zone Proxy feature is enabled. This value can be null in responses for Jumpoints created before an upgrade until the Jumpoint connects for the first time after the upgrade.

string
length between 0 and 256

The hostname of the Jump Zone Proxy server. This parameter is only used for standalone Jumpoints and is only valid if the Jump Zone Proxy is enabled. This value can be null in responses for Jumpoints created before an upgrade until the Jumpoint connects for the first time after the upgrade.

int32
1 to 65535
Defaults to 9555

TCP Port of the Jump Zone Proxy. Only valid when the Jump Zone Proxy is enabled. This value can be null in responses for Jumpoints created before an upgrade until the Jumpoint connects for the first time after the upgrade.

boolean
Defaults to false

If enabled, HTTP GET requests are permitted through the proxy to the BeyondTrust appliance, and this setting is only applicable if the Jump Zone Proxy is enabled. This value can be null in responses for Jumpoints created before an upgrade until the Jumpoint connects for the first time after the upgrade.

string
enum
Defaults to no_restriction

The type of client address restrictions to apply to the JZP. If set to no_restriction, the jzp_restricted_ips field is ignored. If set to allow_all, the jzp_restricted_ips field is used to specify a list of allowed network address prefixes. If set to deny_all, the jzp_restricted_ips field is used to specify a list of denied network address prefixes.

Allowed:
jzp_restricted_ips
array of strings
Defaults to []

Array of network address prefixes, where netmasks are optional and can be specified in either dotted-decimal or integer bitmask format. If a netmask is omitted, the entry is assumed to be a single IP address. This field is only valid if the jzp_client_address_restrictions_type is set to allow_all or deny_all.

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