Modify the properties of a RAS Secure Gateway Server.
PUT/api/Gateway/{id}
Path parameters
id*integer (int32)
ID of the Gateway server to be updated
Body
The Gateway server to be updated
enablednullable boolean
Enable or disable the specified Secure Gateway.
servernullable string
The new Secure Gateway name. The name must be either a valid FQDN or a valid IP address.
descriptionnullable string
A user-defined Secure Gateway description.
publicAddressnullable string
The Public Address of the Secure Gateway.
ipVersionIPVersion (enum)
IP Version
0 = Version4,1 = Version6,2 = BothVersions
iPsnullable string
One or multiple (separated by comma) IP addresses.
bindV4Addressesnullable string
IPv4 address to bind to.
If '0.0.0.0' is passed, will bind to all available addresses.
When using a specific address, it has to be available in the IPv4 address list.
optimizeConnectionIPv4nullable string
Optimize connection for the list of IPv4 (comma separated values).
bindV6Addressesnullable string
IPv6 address to bind to.
If '::' is passed, will bind to all available addresses.
When using a specific address, it has to be available in the IPv6 address list.
optimizeConnectionIPv6nullable string
Optimize connection for the list of IPv6 (comma separated values).
inheritDefaultModeSettingsnullable boolean
Enable or disable default mode settings.
inheritDefaultNetworkSettingsnullable boolean
Enable or disable default network settings.
inheritDefaultSslTlsSettingsnullable boolean
Enable or disable default SSL/TLS setting.
inheritDefaultUserPortalSettingsnullable boolean
Enable or disable default User Portal settings.
inheritDefaultWyseSettingsnullable boolean
Enable or disable default wyse settings.
inheritDefaultSecuritySettingsnullable boolean
Enable or disable default security settingsd.
inheritDefaultWebSettingsnullable boolean
Enable or disable default web settings.
modeGatewayMode (enum)
RAS Secure GateWay Mode
0 = Normal,1 = Forwarding
normalModeForwardingnullable boolean
Forward requests to HTTP server.
forwardGatewayServersnullable string
One or multiple (separated by comma) Forwarding Gateway Servers.
E.g. localhost:80, web1
autoPreferredBrokerboolean
Set preferred Connection Broker Automatically.
preferredBrokerIdnullable integer (int32)
The preferred Connection Broker ID.
forwardHttpServersnullable string
One or multiple (separated by comma) Forwarding HTTP Servers.
E.g. localhost:81, web1
enableGatewayPortnullable boolean
Enable or disable a custom RAS Secure Gateway port.
To specify a custom port, set this parameter to True and use the GatewayPort parameter to specify the port number.
gatewayPortnullable integer (int32)
A custom Gateway port number. For this port to take effect, the EnableGatewayPort parameters must be set to $True.
onlyAllowAcmeHttpnullable boolean
Whether to ignore all incoming requests except for Acme ones received on 'GatewayPort'
enableRDPnullable boolean
Enable or disable a custom RDP port.
To specify a custom port number, use the RDPPort parameter.
rdpPortnullable integer (int32)
A custom RDP port number. For this port to take effect, the EnableRDPPort parameter must be set to True.
broadcastnullable boolean
Enable or disable the 'Broadcast RAS Secure Gateway Address' option.
enableRDPUDPnullable boolean
Enable or disable the 'RDP UDP Data Tunneling' option.
enableDeviceManagerPortnullable boolean
Enable or disable the 'Device Manager Port' option.
dosPronullable boolean
Enable or disable the 'RDP DOS Attack Filter' option.
enableSSLnullable boolean
Enable or disable SSL on the port specified in the SSLPort parameter.
sslPortnullable integer (int32)
SSL port number. To enable the port, set the EnableSSL port parameter to True.
minSSLVersionAcceptedSSLVersion (enum)
Accepted SSL Versions
2 = TLSv1,3 = TLSv1_1,4 = TLSv1_2,5 = TLSv1_3
cipherStrengthCipherStrength (enum)
Cipher Strength
0 = Low,1 = Medium,2 = High,3 = Custom
ciphernullable string
Cipher string.
cipherPreferencenullable boolean
Enable or disable Use ciphers according to server preference.
autoCertificateboolean
Set Certificate Automatically.
certificateIdnullable integer (int32)
The Certificate ID.
Certificate Set Priority 2. This value will be ignored if a CertificateObj is specified.
enableHSTSnullable boolean
Enable or disable HSTS.
To specify a custom HSTS Age, set this parameter to True and use the HSTSMaxAge parameter to specify the HSTS maximum age.
hstsMaxAgenullable integer (int32)
Specifies the HSTS maximum age.
hstsIncludeSubdomainsnullable boolean
Enable or disable the HSTS sub-domains.
hstsPreloadnullable boolean
Enable or disable the HSTS preload.
enableUserPortalnullable boolean
Enable or disable User Portal connectivity on the Gateway.
Allowed domains for cross-origin resource sharing.
browserCacheTimeInMonthsnullable integer (int32)
How long should the browser preserve the cache (in months).
enableAlternateNLBHostnullable boolean
Enable or disable Alternate NLB host name specified in the EnableAlternateNLBHost parameter.
alternateNLBHostnullable string
Alternate NLB host name. To enable the host name, set the EnableAlternateNLBHost port parameter to True.
enableAlternateNLBPortnullable boolean
Enable or disable Alternate NLB on the port specified in the AlternateNLBPort parameter.
alternateNLBPortnullable integer (int32)
Alternate NLB port number. To enable the port, set the EnableAlternateNLBPort port parameter to True.
enableWyseSupportnullable boolean
Enable or disable Wyse ThinOS support.
disableWyseCertWarnnullable boolean
Enable or disable the warning if server certificate is not verified.
securityModeGatewaySecurityMode (enum)
Security Mode
0 = AllowAllExcept,1 = AllowOnly
macAllowExceptnullable array of string
Specifies the Security 'MAC Allow Except' MAC addresses.
macAllowOnlynullable array of string
Specifies the Security 'MAC Allow Only' MAC addresses.
webRequestsURLnullable string
Set a URL for Web requests.
This is the URL that will open when a user enters the IP address
of the RAS Secure Gateway server in a web browser.
For the URL to work, the gateway mode must be set to Normal.
webCookienullable string
Set the Web Cookie Name used by RAS.
useSecureWebCookienullable boolean
Enable or disable the addition of the secure attribute to the cookie to the Web Cookie.
How long should the browser preserve the cache (in months).
allowedDomainsForCORSnullable array of string
Allowed domains for cross-origin resource sharing.
enableAlternateNLBHostboolean
Whether alternate NLB Host is enabled or disabled.
alternateNLBHostnullable string
Alternate NLB Host name.
enableAlternateNLBPortboolean
Whether alternate NLB Port is enabled or disabled.
alternateNLBPortinteger (int32)
Alternate NLB Port number.
enableWyseSupportboolean
Whether support for Wyse Thin Client OS is enabled or disabled.
disableWyseCertWarnboolean
Whether warning if server certificate is not verified is enabled or disabled.
securityModeGatewaySecurityMode (enum)
Security Mode
0 = AllowAllExcept,1 = AllowOnly
macAllowExceptnullable array of string
Lists all the Security 'MAC Allow Except' MAC addresses.
macAllowOnlynullable array of string
Lists all the Security 'MAC Allow Only' MAC addresses.
webRequestsURLnullable string
The URL for Web requests.
webCookienullable string
The Web Cookie Name used by RAS.
useSecureWebCookieboolean
Adds the secure attribute to the cookie to the Web Cookie.
Request
Response
Create
Create a new RAS Secure Gateway Server.
POST/api/Gateway
Query parameters
Body
The RAS Secure Gateway server to be created
server*nullable string
FQDN or IP address of the server to be added to a site as a RAS Secure Gateway.
siteIdinteger (int32)
The site ID to which the Secure Gateway should be added.
To obtain the ID of a desired site, use the appropriate command to Get Sites.
If the parameter is omitted, the site ID of the Licensing Server will be used.
enableUserPortalnullable boolean
Enable or disable User Portal connectivity on the Secure Gateway.
Response
Created
Body
idinteger (int32)
ID of the object.
adminCreatenullable string
User who created the object.
adminLastModnullable string
User who last modified the object.
timeCreatestring (date-time)
Time when the object was created.
timeLastModstring (date-time)
Time when the object was last modified.
servernullable string
Server name.
enabledboolean
Whether the server is enabled or not.
descriptionnullable string
Description of the server.
siteIdinteger (int32)
ID of the site.
publicAddressnullable string
The Public Address of the RAS Secure Gateway.
ipVersionIPVersion (enum)
IP Version
0 = Version4,1 = Version6,2 = BothVersions
iPsnullable string
One or multiple (separated by comma) IP addresses.
bindV4Addressesnullable string
IPv4 address to bind to.
optimizeConnectionIPv4nullable string
Optimize connection for the list of IPv4 (comma separated values).
bindV6Addressesnullable string
IPv6 address to bind to.
optimizeConnectionIPv6nullable string
Optimize connection for the list of IPv6 (comma separated values).
inheritDefaultModeSettingsboolean
Whether default mode settings are enabled or disabled.
inheritDefaultNetworkSettingsboolean
Whether default network settings are enabled or disabled.
inheritDefaultSslTlsSettingsboolean
Whether default SSL/TLS settings are enabled or disabled.
inheritDefaultUserPortalSettingsboolean
Whether default User Portal settings are enabled or disabled.
inheritDefaultWyseSettingsboolean
Whether default wyse settings are enabled or disabled.
inheritDefaultSecuritySettingsboolean
Whether default security settings are enabled or disabled.
inheritDefaultWebSettingsboolean
Whether default web settings are enabled or disabled.
modeGatewayMode (enum)
RAS Secure GateWay Mode
0 = Normal,1 = Forwarding
normalModeForwardingboolean
Whether forwarding requests to HTTP server are enabled or disabled.
forwardGatewayServersnullable string
One or multiple (separated by comma) RAS Forwarding Secure Gateway Servers.
preferredBrokerIdinteger (int32)
ID of the Preferred Connection Broker.
forwardHttpServersnullable string
One or multiple (separated by comma) Forwarding HTTP Servers.
enableGatewayPortboolean
Whether a custom RAS Secure Gateway port is enabled or disabled.
gatewayPortinteger (int32)
A custom RAS Secure Gateway port number.
onlyAllowAcmeHttpboolean
Whether to ignore all incoming requests except for Acme ones received on 'GatewayPort'
enableRDPboolean
Whether a custom RDP port is enabled or disabled.
rdpPortinteger (int32)
A custom RDP port number.
broadcastboolean
Whether the 'Broadcast RAS Secure Gateway Address' option is enabled or disabled.
enableRDPUDPboolean
Whether the 'RDP UDP Data Tunneling' option is enabled or disabled.
enableDeviceManagerPortboolean
Whether the 'Device Manager Port' option is enabled or disabled.
dosProboolean
Whether the 'RDP DOS Attack Filter' option is enabled or disabled.
enableSSLboolean
Whether SSL is enabled or disabled.
sslPortinteger (int32)
SSL port number.
minSSLVersionAcceptedSSLVersion (enum)
Accepted SSL Versions
2 = TLSv1,3 = TLSv1_1,4 = TLSv1_2,5 = TLSv1_3
cipherStrengthCipherStrength (enum)
Cipher Strength
0 = Low,1 = Medium,2 = High,3 = Custom
ciphernullable string
Cipher string.
cipherPreferenceboolean
Enable or disable Use ciphers according to server preference.
certificateIdinteger (int32)
The ID of the specific Certificate to be used.
enableHSTSboolean
Whether HSTS is enabled or disabled.
hstsMaxAgeinteger (int32)
Set Maximum Age of HSTS.
hstsIncludeSubdomainsboolean
Whether HSTS to include subdomains option is enabled or disabled.
hstsPreloadboolean
Whether HSTS to preload option is enabled or disabled.
enableUserPortalboolean
Whether User Portal connectivity on the RAS Secure Gateway is enabled or disabled.
