DocumentationAPI ReferenceRelease Notes
API Reference

Update properties on a Gateway resource.

patch
https://techcomcloudpra.qabeyondtrustcloud.com/api/config/v1/jumpoint/

Modifies an existing Gateway resource with the given {id} using the given properties. The clustered attribute cannot be modified with this API.

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 Gateway properties to modify.

string
required
length between 1 and 255

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

string
enum
required

The platform of the Gateway. This attribute cannot be modified after the Gateway 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 Gateway's comments.

boolean
Defaults to true

If true, the Gateway is enabled.

boolean
Defaults to false

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

boolean
Defaults to false

If true, users are allowed to start SSH sessions with the Gateway.

string
length between 0 and 1024

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

int32 | null
1 to 2147483647
Defaults to null

The unique identifier of the Vault account through which RDP sessions can also receive additional audit capabilities. It must be an generic account or a domain account.

boolean
Defaults to true

If true, users are allowed to start Protocol Tunnel sessions with the Gateway.

boolean
Defaults to true

If true, users are required to approve TCP/UDP connections traversing active Network Tunnels.

managed_ip_ranges
array of objects
Defaults to []

An array of dotted-decimal IPv4 address ranges that should be managed by the network tunnel service on this Gateway. If the Network Tunnel feature will be used on one or more networks which do not provide a DHCP service, provide ranges from which allocations can be made for access sessions. An IP address for each network that the filter rules of a Protocol Tunnel Asset allows will be allocated to a user while participating in a session. Take care to provide ranges that do not contain IP addresses which could be used by other systems on that network.

managed_ip_ranges
boolean
Defaults to false

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

string
length between 0 and 256

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

int32
1 to 65535
Defaults to 9555

TCP Port of the Proxy. Only valid when the Proxy feature is enabled. This value can be null in responses for Gateways created before an upgrade until the Gateway 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 Proxy feature is enabled. This value can be null in responses for Gateways created before an upgrade until the Gateway 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 6 days ago

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

Updated 6 days 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.