DocumentationAPI ReferenceRelease Notes
API Reference

Update properties on a Jump Policy resource.

patch
https://support.example.com/api/config/v1/jump-policy/

Modifies an existing Jump Policy resource with the given {id} using the given properties.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
1 to 2147483647

Unique identifier for the resource.

Body Params

The Jump Policy properties to modify.

string
required
length between 1 and 255

The display name of the Jump Policy.

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

The code name of the Jump Policy.

string
length ≤ 1000

The Jump Policy's comments.

boolean
Defaults to true

If true, users are restricted to accessing Jump Items within the scheduled hours.

string
enum
Defaults to global

If set to join, once the first user is in a session, subsequent users will be able to enter the session. The first user will receive a notification that another user has joined the session, but the first user will not have an opportunity to deny access before other user joins. Selecting the global value means that the behavior defined under Jump -> Jump Items will be used.

Allowed:
boolean
Defaults to false

This field is only valid if simultaneous_jumps is set to join; otherwise, this field should be set to false or left unset. If true, a user will be allowed to join a session that was started from another copy of a Jump Client in a different Jump Group. Session permissions will be based on the original Jump Client that started the session. If false, a user will not be allowed to join a session that was started from another copy of a Jump Item unless it is the same Jump Group.

string
enum
Defaults to global

If set to new_session, then a new independent session will start for each user which jumps to a specific RDP Jump Item, and the RDP configuration on the endpoint will control any further behavior regarding simultaneous RDP connections. Selecting the global value means that the behavior defined under Jump -> Jump Items will be used.

Allowed:
boolean
Defaults to false

If true, users are forcefully removed from sessions when the schedule does not permit access. This can only be set to true if schedule_enabled is also true.

boolean
Defaults to false

If true, users must enter a valid ticket ID that will be verified against the Ticket System configured on the Jump → Jump Policies page. This setting has no effect if a Ticket System is not configured.

boolean
Defaults to false

If true, users must have two factor authentication enabled and must complete a two factor challenge before starting a session.

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.