Gateway

List

Retrieve a list of all the RAS Secure Gateway Servers.

GET/api/Gateway

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

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.

userPortalPortinteger (int32)

A custom User Portal port number.

launchMethodLaunchMethod (enum)

LaunchMethod

0 = ParallelsClientAndWebClient,1 = ParallelsClient,2 = WebClient

allowLaunchMethodboolean

Allow users to select a resource launch method.

allowAppsInNewTabboolean

Allow users to start applications in a new browser tab.

usePreWin2000LoginFormatboolean

Whether the 'Use Pre Windows 2000 Login Format' option is enabled or disabled.

allowEmbedboolean

Allow embedding of Web Client into other web pages.

allowFileTransferboolean

Whether the 'Allow file transfer' option is enabled or disabled. (deprecated)

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowClipboardboolean

Whether the 'Allow Clipboard' option is enabled or disabled. (deprecated)

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSboolean

Allow cross-origin resource sharing.

browserCacheTimeInMonthsinteger (int32)

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

JavaScriptCurlPython

const response = await fetch('/api/Gateway', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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

Create

Create a new RAS Secure Gateway Server.

POST/api/Gateway

Query parameters

Body

application/json; api-version=1.0

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

201401409

Created

Body

application/json; api-version=1.0

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.

userPortalPortinteger (int32)

A custom User Portal port number.

launchMethodLaunchMethod (enum)

LaunchMethod

0 = ParallelsClientAndWebClient,1 = ParallelsClient,2 = WebClient

allowLaunchMethodboolean

Allow users to select a resource launch method.

allowAppsInNewTabboolean

Allow users to start applications in a new browser tab.

usePreWin2000LoginFormatboolean

Whether the 'Use Pre Windows 2000 Login Format' option is enabled or disabled.

allowEmbedboolean

Allow embedding of Web Client into other web pages.

allowFileTransferboolean

Whether the 'Allow file transfer' option is enabled or disabled. (deprecated)

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowClipboardboolean

Whether the 'Allow Clipboard' option is enabled or disabled. (deprecated)

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSboolean

Allow cross-origin resource sharing.

browserCacheTimeInMonthsinteger (int32)

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

JavaScriptCurlPython

const response = await fetch('/api/Gateway', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "server": "text"
    }),
});
const data = await response.json();

Response

201401409

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

Get

Retrieve a specified RAS Secure Gateway Server.

GET/api/Gateway/{id}

Path parameters

id*integer (int32)

ID of the Gateway server to be retrieved

Response

200401404

Success

Body

application/json; api-version=1.0

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.

userPortalPortinteger (int32)

A custom User Portal port number.

launchMethodLaunchMethod (enum)

LaunchMethod

0 = ParallelsClientAndWebClient,1 = ParallelsClient,2 = WebClient

allowLaunchMethodboolean

Allow users to select a resource launch method.

allowAppsInNewTabboolean

Allow users to start applications in a new browser tab.

usePreWin2000LoginFormatboolean

Whether the 'Use Pre Windows 2000 Login Format' option is enabled or disabled.

allowEmbedboolean

Allow embedding of Web Client into other web pages.

allowFileTransferboolean

Whether the 'Allow file transfer' option is enabled or disabled. (deprecated)

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowClipboardboolean

Whether the 'Allow Clipboard' option is enabled or disabled. (deprecated)

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSboolean

Allow cross-origin resource sharing.

browserCacheTimeInMonthsinteger (int32)

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

JavaScriptCurlPython

const response = await fetch('/api/Gateway/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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

Update

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

application/json; api-version=1.0

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.

userPortalPortnullable integer (int32)

A custom User Portal port number.

launchMethodLaunchMethod (enum)

LaunchMethod

0 = ParallelsClientAndWebClient,1 = ParallelsClient,2 = WebClient

allowLaunchMethodnullable boolean

Allow users to select a resource launch method.

allowAppsInNewTabnullable boolean

Allow users to start applications in a new browser tab.

usePreWin2000LoginFormatnullable boolean

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

allowEmbednullable boolean

Allow embedding of Web Client into other web pages.

fileTransferModeFileTransferControlMode (enum)

File Transfer Control modes.

0 = Disabled,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

clipboardDirectionClipboardDirections (enum)

Clipboard Direction Type.

0 = None,1 = ClientToServer,2 = ServerToClient,3 = Bidirectional

allowCORSnullable boolean

Allow cross-origin resource sharing.

allowedDomainsForCORSnullable array of string

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.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/Gateway/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

Delete a RAS Secure Gateway Server.

DELETE/api/Gateway/{id}

Path parameters

id*integer (int32)

ID of the Gateway server to be deleted

Query parameters

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/Gateway/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}