Gateway

PreviousDuplicate NextCertificate

Was this helpful?

List

get

Retrieve a list of all the RAS Secure Gateway Servers.

Query parameters

SiteIdinteger · int32optional

Site ID of which the RAS Secure Gateway Servers will be retrieved (optional)

Serverstringoptional

Filter the result by server name (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Gateway'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-06T01:27:05.371Z",
    "timeLastMod": "2025-04-06T01:27:05.371Z",
    "server": "text",
    "enabled": true,
    "description": "text",
    "siteId": 1,
    "publicAddress": "text",
    "ipVersion": [
      "0 = Version4",
      "1 = Version6",
      "2 = BothVersions"
    ],
    "iPs": "text",
    "bindV4Addresses": "text",
    "optimizeConnectionIPv4": "text",
    "bindV6Addresses": "text",
    "optimizeConnectionIPv6": "text",
    "inheritDefaultModeSettings": true,
    "inheritDefaultNetworkSettings": true,
    "inheritDefaultSslTlsSettings": true,
    "inheritDefaultUserPortalSettings": true,
    "inheritDefaultWyseSettings": true,
    "inheritDefaultSecuritySettings": true,
    "inheritDefaultWebSettings": true,
    "mode": [
      "0 = Normal",
      "1 = Forwarding"
    ],
    "normalModeForwarding": true,
    "forwardGatewayServers": "text",
    "preferredBrokerId": 1,
    "forwardHttpServers": "text",
    "enableGatewayPort": true,
    "gatewayPort": 1,
    "onlyAllowAcmeHttp": true,
    "enableRDP": true,
    "rdpPort": 1,
    "broadcast": true,
    "enableRDPUDP": true,
    "enableDeviceManagerPort": true,
    "dosPro": true,
    "enableSSL": true,
    "sslPort": 1,
    "minSSLVersion": [
      "2 = TLSv1",
      "3 = TLSv1_1",
      "4 = TLSv1_2",
      "5 = TLSv1_3"
    ],
    "cipherStrength": [
      "0 = Low",
      "1 = Medium",
      "2 = High",
      "3 = Custom"
    ],
    "cipher": "text",
    "cipherPreference": true,
    "certificateId": 1,
    "enableHSTS": true,
    "hstsMaxAge": 1,
    "hstsIncludeSubdomains": true,
    "hstsPreload": true,
    "enableUserPortal": true,
    "userPortalPort": 1,
    "launchMethod": [
      "0 = ParallelsClientAndWebClient",
      "1 = ParallelsClient",
      "2 = WebClient"
    ],
    "allowLaunchMethod": true,
    "allowAppsInNewTab": true,
    "usePreWin2000LoginFormat": true,
    "allowEmbed": true,
    "allowFileTransfer": true,
    "fileTransferMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "allowClipboard": true,
    "clipboardDirection": [
      "0 = None",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "allowCORS": true,
    "browserCacheTimeInMonths": 1,
    "allowedDomainsForCORS": [
      "text"
    ],
    "enableAlternateNLBHost": true,
    "alternateNLBHost": "text",
    "enableAlternateNLBPort": true,
    "alternateNLBPort": 1,
    "enableWyseSupport": true,
    "disableWyseCertWarn": true,
    "securityMode": [
      "0 = AllowAllExcept",
      "1 = AllowOnly"
    ],
    "macAllowExcept": [
      "text"
    ],
    "macAllowOnly": [
      "text"
    ],
    "webRequestsURL": "text",
    "webCookie": "text",
    "useSecureWebCookie": true
  }
]

Success

Create

post

Create a new RAS Secure Gateway Server.

Query parameters

noInstallbooleanoptional

If this parameter is included, the RAS Secure Gateway software will not be installed on the target server. The parameter should only be included if the server already has the software installed. If you need to install the software, omit this parameter. When installing the Gateway software, your RAS admin credentials will be used to push install the software. These are the credentials you used to connect to the RAS farm. If needed, you can specify different credentials using the Username and Password parameters.

usernamestringoptional

An administrator account to push install the Gateway software on the target server. If this parameter is omitted, your RAS admin username (and password) will be used

passwordstringoptional

The password of the account specified in the Username parameter.

noRestartbooleanoptional

Specifies not to restart the server after the RAS Gateway is installed. If this parameter is omitted, the server will be restarted if required.

noFireWallRulesbooleanoptional

Specifies not to add firewall rules to allow the RD Session Host Agent to communicate. If this parameter is omitted, the firewall rules will not be added.

Body

Create a new Secure Gateway

serverstring | nullablerequired

FQDN or IP address of the server to be added to a site as a RAS Secure Gateway.

siteIdinteger · int32optional

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.

enableUserPortalboolean | nullableoptional

Enable or disable User Portal connectivity on the Secure Gateway.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/Gateway' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "server": "text",
    "siteId": 1,
    "enableUserPortal": true
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:27:05.371Z",
  "timeLastMod": "2025-04-06T01:27:05.371Z",
  "server": "text",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "publicAddress": "text",
  "ipVersion": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ],
  "iPs": "text",
  "bindV4Addresses": "text",
  "optimizeConnectionIPv4": "text",
  "bindV6Addresses": "text",
  "optimizeConnectionIPv6": "text",
  "inheritDefaultModeSettings": true,
  "inheritDefaultNetworkSettings": true,
  "inheritDefaultSslTlsSettings": true,
  "inheritDefaultUserPortalSettings": true,
  "inheritDefaultWyseSettings": true,
  "inheritDefaultSecuritySettings": true,
  "inheritDefaultWebSettings": true,
  "mode": [
    "0 = Normal",
    "1 = Forwarding"
  ],
  "normalModeForwarding": true,
  "forwardGatewayServers": "text",
  "preferredBrokerId": 1,
  "forwardHttpServers": "text",
  "enableGatewayPort": true,
  "gatewayPort": 1,
  "onlyAllowAcmeHttp": true,
  "enableRDP": true,
  "rdpPort": 1,
  "broadcast": true,
  "enableRDPUDP": true,
  "enableDeviceManagerPort": true,
  "dosPro": true,
  "enableSSL": true,
  "sslPort": 1,
  "minSSLVersion": [
    "2 = TLSv1",
    "3 = TLSv1_1",
    "4 = TLSv1_2",
    "5 = TLSv1_3"
  ],
  "cipherStrength": [
    "0 = Low",
    "1 = Medium",
    "2 = High",
    "3 = Custom"
  ],
  "cipher": "text",
  "cipherPreference": true,
  "certificateId": 1,
  "enableHSTS": true,
  "hstsMaxAge": 1,
  "hstsIncludeSubdomains": true,
  "hstsPreload": true,
  "enableUserPortal": true,
  "userPortalPort": 1,
  "launchMethod": [
    "0 = ParallelsClientAndWebClient",
    "1 = ParallelsClient",
    "2 = WebClient"
  ],
  "allowLaunchMethod": true,
  "allowAppsInNewTab": true,
  "usePreWin2000LoginFormat": true,
  "allowEmbed": true,
  "allowFileTransfer": true,
  "fileTransferMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "allowClipboard": true,
  "clipboardDirection": [
    "0 = None",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "allowCORS": true,
  "browserCacheTimeInMonths": 1,
  "allowedDomainsForCORS": [
    "text"
  ],
  "enableAlternateNLBHost": true,
  "alternateNLBHost": "text",
  "enableAlternateNLBPort": true,
  "alternateNLBPort": 1,
  "enableWyseSupport": true,
  "disableWyseCertWarn": true,
  "securityMode": [
    "0 = AllowAllExcept",
    "1 = AllowOnly"
  ],
  "macAllowExcept": [
    "text"
  ],
  "macAllowOnly": [
    "text"
  ],
  "webRequestsURL": "text",
  "webCookie": "text",
  "useSecureWebCookie": true
}

Created

Get

get

Retrieve a specified RAS Secure Gateway Server.

Path parameters

idinteger · int32required

ID of the Gateway server to be retrieved

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/Gateway/{id}'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:27:05.371Z",
  "timeLastMod": "2025-04-06T01:27:05.371Z",
  "server": "text",
  "enabled": true,
  "description": "text",
  "siteId": 1,
  "publicAddress": "text",
  "ipVersion": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ],
  "iPs": "text",
  "bindV4Addresses": "text",
  "optimizeConnectionIPv4": "text",
  "bindV6Addresses": "text",
  "optimizeConnectionIPv6": "text",
  "inheritDefaultModeSettings": true,
  "inheritDefaultNetworkSettings": true,
  "inheritDefaultSslTlsSettings": true,
  "inheritDefaultUserPortalSettings": true,
  "inheritDefaultWyseSettings": true,
  "inheritDefaultSecuritySettings": true,
  "inheritDefaultWebSettings": true,
  "mode": [
    "0 = Normal",
    "1 = Forwarding"
  ],
  "normalModeForwarding": true,
  "forwardGatewayServers": "text",
  "preferredBrokerId": 1,
  "forwardHttpServers": "text",
  "enableGatewayPort": true,
  "gatewayPort": 1,
  "onlyAllowAcmeHttp": true,
  "enableRDP": true,
  "rdpPort": 1,
  "broadcast": true,
  "enableRDPUDP": true,
  "enableDeviceManagerPort": true,
  "dosPro": true,
  "enableSSL": true,
  "sslPort": 1,
  "minSSLVersion": [
    "2 = TLSv1",
    "3 = TLSv1_1",
    "4 = TLSv1_2",
    "5 = TLSv1_3"
  ],
  "cipherStrength": [
    "0 = Low",
    "1 = Medium",
    "2 = High",
    "3 = Custom"
  ],
  "cipher": "text",
  "cipherPreference": true,
  "certificateId": 1,
  "enableHSTS": true,
  "hstsMaxAge": 1,
  "hstsIncludeSubdomains": true,
  "hstsPreload": true,
  "enableUserPortal": true,
  "userPortalPort": 1,
  "launchMethod": [
    "0 = ParallelsClientAndWebClient",
    "1 = ParallelsClient",
    "2 = WebClient"
  ],
  "allowLaunchMethod": true,
  "allowAppsInNewTab": true,
  "usePreWin2000LoginFormat": true,
  "allowEmbed": true,
  "allowFileTransfer": true,
  "fileTransferMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "allowClipboard": true,
  "clipboardDirection": [
    "0 = None",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "allowCORS": true,
  "browserCacheTimeInMonths": 1,
  "allowedDomainsForCORS": [
    "text"
  ],
  "enableAlternateNLBHost": true,
  "alternateNLBHost": "text",
  "enableAlternateNLBPort": true,
  "alternateNLBPort": 1,
  "enableWyseSupport": true,
  "disableWyseCertWarn": true,
  "securityMode": [
    "0 = AllowAllExcept",
    "1 = AllowOnly"
  ],
  "macAllowExcept": [
    "text"
  ],
  "macAllowOnly": [
    "text"
  ],
  "webRequestsURL": "text",
  "webCookie": "text",
  "useSecureWebCookie": true
}

Success

Delete

delete

Delete a RAS Secure Gateway Server.

Path parameters

idinteger · int32required

ID of the Gateway server to be deleted

Query parameters

noUninstallbooleanoptional

When this parameter is included, the Gateway software will not be removed from the server. If you want to remove the software, omit this parameter. When removing the software, your RAS admin credentials will be used to remotely execute the uninstaller on the target server. You can specify different credentials if needed using the Username and Password parameters.

usernamestringoptional

An administrator account name to remotely uninstall the Gateway software from the server. If this parameter is omitted, your RAS admin username (and password) will be used.

passwordstringoptional

The password of the account specified in the Username parameter.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/Gateway/{id}'

204

401

404

No Content

Update

put

Modify the properties of a RAS Secure Gateway Server.

Path parameters

idinteger · int32required

ID of the Gateway server to be updated

Body

Update a Secure Gateway settings

enabledboolean | nullableoptional

Enable or disable the specified Secure Gateway.

serverstring | nullableoptional

The new Secure Gateway name. The name must be either a valid FQDN or a valid IP address.

descriptionstring | nullableoptional

A user-defined Secure Gateway description.

publicAddressstring | nullableoptional

The Public Address of the Secure Gateway.

ipVersionstring · enumoptional

IP Version

Available options:

iPsstring | nullableoptional

One or multiple (separated by comma) IP addresses.

bindV4Addressesstring | nullableoptional

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.

optimizeConnectionIPv4string | nullableoptional

Optimize connection for the list of IPv4 (comma separated values).

bindV6Addressesstring | nullableoptional

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.

optimizeConnectionIPv6string | nullableoptional

Optimize connection for the list of IPv6 (comma separated values).

inheritDefaultModeSettingsboolean | nullableoptional

Enable or disable default mode settings.

inheritDefaultNetworkSettingsboolean | nullableoptional

Enable or disable default network settings.

inheritDefaultSslTlsSettingsboolean | nullableoptional

Enable or disable default SSL/TLS setting.

inheritDefaultUserPortalSettingsboolean | nullableoptional

Enable or disable default User Portal settings.

inheritDefaultWyseSettingsboolean | nullableoptional

Enable or disable default wyse settings.

inheritDefaultSecuritySettingsboolean | nullableoptional

Enable or disable default security settingsd.

inheritDefaultWebSettingsboolean | nullableoptional

Enable or disable default web settings.

modestring · enumoptional

RAS Secure GateWay Mode

Available options:

normalModeForwardingboolean | nullableoptional

Forward requests to HTTP server.

forwardGatewayServersstring | nullableoptional

One or multiple (separated by comma) Forwarding Gateway Servers. E.g. localhost:80, web1

autoPreferredBrokerbooleanoptional

Set preferred Connection Broker Automatically.

Default: false

preferredBrokerIdinteger · int32 | nullableoptional

The preferred Connection Broker ID.

forwardHttpServersstring | nullableoptional

One or multiple (separated by comma) Forwarding HTTP Servers. E.g. localhost:81, web1

enableGatewayPortboolean | nullableoptional

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.

gatewayPortinteger · int32 | nullableoptional

A custom Gateway port number. For this port to take effect, the EnableGatewayPort parameters must be set to $True.

onlyAllowAcmeHttpboolean | nullableoptional

Whether to ignore all incoming requests except for Acme ones received on 'GatewayPort'

enableRDPboolean | nullableoptional

Enable or disable a custom RDP port. To specify a custom port number, use the RDPPort parameter.

rdpPortinteger · int32 | nullableoptional

A custom RDP port number. For this port to take effect, the EnableRDPPort parameter must be set to True.

broadcastboolean | nullableoptional

Enable or disable the 'Broadcast RAS Secure Gateway Address' option.

enableRDPUDPboolean | nullableoptional

Enable or disable the 'RDP UDP Data Tunneling' option.

enableDeviceManagerPortboolean | nullableoptional

Enable or disable the 'Device Manager Port' option.

dosProboolean | nullableoptional

Enable or disable the 'RDP DOS Attack Filter' option.

enableSSLboolean | nullableoptional

Enable or disable SSL on the port specified in the SSLPort parameter.

sslPortinteger · int32 | nullableoptional

SSL port number. To enable the port, set the EnableSSL port parameter to True.

minSSLVersionstring · enumoptional

Accepted SSL Versions

Available options:

cipherStrengthstring · enumoptional

Cipher Strength

Available options:

cipherstring | nullableoptional

Cipher string.

cipherPreferenceboolean | nullableoptional

Enable or disable Use ciphers according to server preference.

autoCertificatebooleanoptional

Set Certificate Automatically.

Default: false

certificateIdinteger · int32 | nullableoptional

The Certificate ID. Certificate Set Priority 2. This value will be ignored if a CertificateObj is specified.

enableHSTSboolean | nullableoptional

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.

hstsMaxAgeinteger · int32 | nullableoptional

Specifies the HSTS maximum age.

hstsIncludeSubdomainsboolean | nullableoptional

Enable or disable the HSTS sub-domains.

hstsPreloadboolean | nullableoptional

Enable or disable the HSTS preload.

enableUserPortalboolean | nullableoptional

Enable or disable User Portal connectivity on the Gateway.

userPortalPortinteger · int32 | nullableoptional

A custom User Portal port number.

launchMethodstring · enumoptional

LaunchMethod

Available options:

allowLaunchMethodboolean | nullableoptional

Allow users to select a resource launch method.

allowAppsInNewTabboolean | nullableoptional

Allow users to start applications in a new browser tab.

usePreWin2000LoginFormatboolean | nullableoptional

Enable or disable the 'Use Pre Windows 2000 Login Format' option.

allowEmbedboolean | nullableoptional

Allow embedding of Web Client into other web pages.

allowFileTransferboolean | nullableoptionalDeprecated

Deprecated: use FileTransferMode instead. Enable or disable the 'Allow file transfer' option.

fileTransferModestring · enumoptional

File Transfer Control modes.

Available options:

allowClipboardboolean | nullableoptionalDeprecated

Enable or disable the 'Allow Clipboard' option.

clipboardDirectionstring[Flag] · enumoptional

Clipboard Direction Type.

Available options:

allowCORSboolean | nullableoptional

Allow cross-origin resource sharing.

allowedDomainsForCORSstring[] | nullableoptional

Allowed domains for cross-origin resource sharing.

browserCacheTimeInMonthsinteger · int32 | nullableoptional

How long should the browser preserve the cache (in months).

enableAlternateNLBHostboolean | nullableoptional

Enable or disable Alternate NLB host name specified in the EnableAlternateNLBHost parameter.

alternateNLBHoststring | nullableoptional

Alternate NLB host name. To enable the host name, set the EnableAlternateNLBHost port parameter to True.

enableAlternateNLBPortboolean | nullableoptional

Enable or disable Alternate NLB on the port specified in the AlternateNLBPort parameter.

alternateNLBPortinteger · int32 | nullableoptional

Alternate NLB port number. To enable the port, set the EnableAlternateNLBPort port parameter to True.

enableWyseSupportboolean | nullableoptional

Enable or disable Wyse ThinOS support.

disableWyseCertWarnboolean | nullableoptional

Enable or disable the warning if server certificate is not verified.

securityModestring · enumoptional

Security Mode

Available options:

macAllowExceptstring[] | nullableoptional

Specifies the Security 'MAC Allow Except' MAC addresses.

macAllowOnlystring[] | nullableoptional

Specifies the Security 'MAC Allow Only' MAC addresses.

webRequestsURLstring | nullableoptional

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.

webCookiestring | nullableoptional

Set the Web Cookie Name used by RAS.

useSecureWebCookieboolean | nullableoptional

Enable or disable the addition of the secure attribute to the cookie to the Web Cookie.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/Gateway/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "enabled": true,
    "server": "text",
    "description": "text",
    "publicAddress": "text",
    "ipVersion": [
      "0 = Version4",
      "1 = Version6",
      "2 = BothVersions"
    ],
    "iPs": "text",
    "bindV4Addresses": "text",
    "optimizeConnectionIPv4": "text",
    "bindV6Addresses": "text",
    "optimizeConnectionIPv6": "text",
    "inheritDefaultModeSettings": true,
    "inheritDefaultNetworkSettings": true,
    "inheritDefaultSslTlsSettings": true,
    "inheritDefaultUserPortalSettings": true,
    "inheritDefaultWyseSettings": true,
    "inheritDefaultSecuritySettings": true,
    "inheritDefaultWebSettings": true,
    "mode": [
      "0 = Normal",
      "1 = Forwarding"
    ],
    "normalModeForwarding": true,
    "forwardGatewayServers": "text",
    "autoPreferredBroker": true,
    "preferredBrokerId": 1,
    "forwardHttpServers": "text",
    "enableGatewayPort": true,
    "gatewayPort": 1,
    "onlyAllowAcmeHttp": true,
    "enableRDP": true,
    "rdpPort": 1,
    "broadcast": true,
    "enableRDPUDP": true,
    "enableDeviceManagerPort": true,
    "dosPro": true,
    "enableSSL": true,
    "sslPort": 1,
    "minSSLVersion": [
      "2 = TLSv1",
      "3 = TLSv1_1",
      "4 = TLSv1_2",
      "5 = TLSv1_3"
    ],
    "cipherStrength": [
      "0 = Low",
      "1 = Medium",
      "2 = High",
      "3 = Custom"
    ],
    "cipher": "text",
    "cipherPreference": true,
    "autoCertificate": true,
    "certificateId": 1,
    "enableHSTS": true,
    "hstsMaxAge": 1,
    "hstsIncludeSubdomains": true,
    "hstsPreload": true,
    "enableUserPortal": true,
    "userPortalPort": 1,
    "launchMethod": [
      "0 = ParallelsClientAndWebClient",
      "1 = ParallelsClient",
      "2 = WebClient"
    ],
    "allowLaunchMethod": true,
    "allowAppsInNewTab": true,
    "usePreWin2000LoginFormat": true,
    "allowEmbed": true,
    "fileTransferMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "clipboardDirection": [
      "0 = None",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "allowCORS": true,
    "allowedDomainsForCORS": [
      "text"
    ],
    "browserCacheTimeInMonths": 1,
    "enableAlternateNLBHost": true,
    "alternateNLBHost": "text",
    "enableAlternateNLBPort": true,
    "alternateNLBPort": 1,
    "enableWyseSupport": true,
    "disableWyseCertWarn": true,
    "securityMode": [
      "0 = AllowAllExcept",
      "1 = AllowOnly"
    ],
    "macAllowExcept": [
      "text"
    ],
    "macAllowOnly": [
      "text"
    ],
    "webRequestsURL": "text",
    "webCookie": "text",
    "useSecureWebCookie": true
  }'

204

401

404

No Content