Create a Jump Policy.

post

https://{example.com}/api/config/v1/jump-policy

Adds a new Jump Policy resource.
The response body contains the new Jump Policy.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

New Jump Policy properties.

display_name

string

required

length between 1 and 255

The display name of the Jump Policy.

code_name

string

length between 0 and 64

The code name of the Jump Policy.

description

string

length ≤ 1000

The Jump Policy's comments.

schedule_enabled

boolean

Defaults to true

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

simultaneous_jumps

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:

simultaneous_jump_behavior_applies_to_copies

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.

simultaneous_jumps_rdp

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:

schedule_strict

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.

context_requirement

string

enum

Defaults to none

Controls whether a user must provide context before starting a session on a Jump Item.

none — no context required.
ticket_id — user must enter a valid ticket ID that will be verified against the Ticket System configured on the Jump → Jump Policies page. The setting has no effect if a Ticket System is not configured.
justification — user must enter a written justification for starting the session, which is logged for auditing.

Replaces the legacy boolean ticket_id_required. The API still accepts ticket_id_required on ingress (true → ticket_id, false → none), but the field is no longer returned in responses.

Allowed:

two_factor_challenge_required

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

201Indicates the Jump Policy was created successfully and contains the new instance. The Location header contains the URL of the Jump Policy.

422One or more request parameters are invalid. The body contains a general error message as well as a validation error dictionary.