HALBs | Parallels REST API

Parallels REST API

Products Support Partners Documentation

Create

post

Create a new entry for the HALB Virtual Server settings

Query parameters

noInstallbooleanOptional

Set it to true if HALB Devices should be initialized after being added. (optional)

Body

Create a new HALB Virtual Server

descriptionstring | nullableOptional

The HALB Virtual Server description.

publicAddressstring | nullableOptional

The HALB Virtual Server Public Address.

virtualIPv4string | nullableOptional

The IPv4 of the HALB Virtual Server.

subnetMaskstring | nullableOptional

The Subnet Mask of the HALB Virtual Server.

virtualIPv6string | nullableOptional

The IPv6 of the HALB Virtual Server.

prefixIPV6integer · int32 | nullableOptional

The IPv6 Prefix of the HALB Virtual Server.

enableTunnelingboolean | nullableOptional

Enable/Disable the RDP/UDP of the HALB Virtual Server.

maxTCPConnectionsinteger · int32 | nullableOptional

The Maximum allowed TCP Connections to the HALB Virtual Server.

vrrpAuthenticationPasswordstring | nullableOptional

The VRRP Authentication password.

clientIdleTimeoutinteger · int32 | nullableOptional

The client inactivity timeout.

gatewayConnectionTimeoutinteger · int32 | nullableOptional

The Gateway connection timeout.

clientQueueTimeoutinteger · int32 | nullableOptional

The client queue timeout.

gatewayIdleTimeoutinteger · int32 | nullableOptional

The Gateway inactivity timeout.

sessionRateinteger · int32 | nullableOptional

The amount of TCP connections per second.

gatewayHealthCheckIntervalsinteger · int32 | nullableOptional

The Gateway Health check intervals in seconds.

vrrpVirtualRouterIDinteger · int32 | nullableOptional

The Virtual Router ID of HALB Virtual Server (if not set, the router ID will be automatically computed).

vrrpBroadcastIntervalinteger · int32 | nullableOptional

The VRRP broadcast interval in minutes.

vrrpHealthScriptCheckIntervalinteger · int32 | nullableOptional

The VRRP health script check interval in seconds.

vrrpHealthScriptCheckTimeoutinteger · int32 | nullableOptional

The VRRP health script check timeout in seconds.

vrrpAdvertisementIntervalinteger · int32 | nullableOptional

The VRRP Advertisement interval in seconds.

enableOSUpdatesboolean | nullableOptional

Enable/Disable OS updates.

keepLBProxyConfigboolean | nullableOptional

Enable/Disable keeping of existing loadbalancing settings.

keepVRRPConfigboolean | nullableOptional

Enable/Disable keeping of existing VRRP/keepalive settings.

lbGatewaysstring[] | nullableOptional

The list of the Non-SSL Gateways for HALB Virtual Server.

lbGatewayPortinteger · int32 | nullableOptional

The Non-SSL Gateway port.

sslModestring · enumOptional

Load Balancing SSL Mode

Possible values:

lbsslGatewaysstring[] | nullableOptional

The list of the SSL Gateways for HALB Virtual Server.

lbsslGatewayPortinteger · int32 | nullableOptional

The SSL Gateway port.

acceptedSSLVersionstring · enumOptional

Accepted SSL Versions

Possible values:

cipherStrengthstring · enumOptional

Cipher Strength

Possible values:

cipherPreferenceboolean | nullableOptional

Enable or disable 'Use ciphers according to server preference'.

sslCustomCipherstring | nullableOptional

The SSL custom cipher for SSL Gateways.

certificateIDinteger · int32 | nullableOptional

The certificate ID.

deviceManagerGatewaysstring[] | nullableOptional

The list of the Device Management Gateways for HALB Virtual Server.

namestring | nullableRequired

The HALB Virtual Server name.

siteIdinteger · int32Optional

The site ID where the HALB settings will be created.

ipVersionstring · enumRequired

IP Version

Possible values:

deviceIPsstring[] | nullableOptional

The list of the HALB Device IPs.

enableGatewayPayloadbooleanOptional

Enable/Disable the Non-SSL Gateway configuration of the HALB Virtual Server .

Default: false

enableSSLPayloadbooleanOptional

Enable/Disable the SSL Gateway configuration of the HALB Virtual Server.

Default: false

enableDeviceManagementbooleanOptional

Enable/Disable the Device Management configuration of the HALB Virtual Server.

Default: false

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/HALB HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 1141

{
  "description": "text",
  "publicAddress": "text",
  "virtualIPv4": "text",
  "subnetMask": "text",
  "virtualIPv6": "text",
  "prefixIPV6": 1,
  "enableTunneling": true,
  "maxTCPConnections": 1,
  "vrrpAuthenticationPassword": "text",
  "clientIdleTimeout": 1,
  "gatewayConnectionTimeout": 1,
  "clientQueueTimeout": 1,
  "gatewayIdleTimeout": 1,
  "sessionRate": 1,
  "gatewayHealthCheckIntervals": 1,
  "vrrpVirtualRouterID": 1,
  "vrrpBroadcastInterval": 1,
  "vrrpHealthScriptCheckInterval": 1,
  "vrrpHealthScriptCheckTimeout": 1,
  "vrrpAdvertisementInterval": 1,
  "enableOSUpdates": true,
  "keepLBProxyConfig": true,
  "keepVRRPConfig": true,
  "lbGateways": [
    "text"
  ],
  "lbGatewayPort": 1,
  "sslMode": [
    "0 = SSLOffloading",
    "1 = SSLPassthrough"
  ],
  "lbsslGateways": [
    "text"
  ],
  "lbsslGatewayPort": 1,
  "acceptedSSLVersion": [
    "2 = TLSv1",
    "3 = TLSv1_1",
    "4 = TLSv1_2",
    "5 = TLSv1_3"
  ],
  "cipherStrength": [
    "0 = Low",
    "1 = Medium",
    "2 = High",
    "3 = Custom"
  ],
  "cipherPreference": true,
  "sslCustomCipher": "text",
  "certificateID": 1,
  "deviceManagerGateways": [
    "text"
  ],
  "name": "text",
  "siteId": 1,
  "ipVersion": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ],
  "deviceIPs": [
    "text"
  ],
  "enableGatewayPayload": false,
  "enableSSLPayload": false,
  "enableDeviceManagement": false
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-23T11:19:57.125Z",
  "timeLastMod": "2025-05-23T11:19:57.125Z",
  "name": "text",
  "siteId": 1,
  "description": "text",
  "publicAddress": "text",
  "enableGatewayPayload": true,
  "enableSSLPayload": true,
  "enableHALBInstance": true,
  "enableDeviceManagement": true,
  "ipVersion": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ],
  "virtualIPV4": "text",
  "subNetMask": "text",
  "virtualIPV6": "text",
  "prefixIPV6": 1,
  "devices": [
    {
      "deviceIP": "text",
      "deviceId": 1
    }
  ],
  "enableUDPTunneling": true,
  "maxTCPConnections": 1,
  "algorithm": [
    "0 = SourceIP",
    "1 = Cookie"
  ],
  "clientIdleTimeout": 1,
  "gatewayConnectionTimeout": 1,
  "clientQueueTimeout": 1,
  "gatewayIdleTimeout": 1,
  "sessionsRate": 1,
  "gatewayHealthCheckInterval": 1,
  "virtualRouterID": 1,
  "vrrpBroadcastInterval": 1,
  "vrrpHealthCheckInterval": 1,
  "vrrpHealthCheckTimeout": 1,
  "osUpdate": true,
  "vrrpAdvertInterval": 1,
  "keepLBProxyConfig": true,
  "keepVRRPConfig": true,
  "clientManagementConfig": {
    "gateways": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  },
  "gatewayConfig": {
    "port": 1,
    "gateways": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  },
  "sslConfig": {
    "minSSLVersion": [
      "2 = TLSv1",
      "3 = TLSv1_1",
      "4 = TLSv1_2",
      "5 = TLSv1_3"
    ],
    "sslMode": [
      "0 = SSLOffloading",
      "1 = SSLPassthrough"
    ],
    "sslCustomCipher": "text",
    "sslCipherStrength": [
      "0 = Low",
      "1 = Medium",
      "2 = High",
      "3 = Custom"
    ],
    "sslCipherPreference": true,
    "certID": 1,
    "gatewayConfig": {
      "port": 1,
      "gateways": {
        "ANY_ADDITIONAL_PROPERTY": 1
      }
    }
  }
}

List

get

Retrieve a list of the HALB Virtual Server settings.

Query parameters

NamestringOptional

The name of te HALB Virtual Server

SiteIdinteger · int32Optional

The site ID from where to retrieve the HALB Virtual Server Settings (optional)

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/HALB HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-05-23T11:19:57.125Z",
    "timeLastMod": "2025-05-23T11:19:57.125Z",
    "name": "text",
    "siteId": 1,
    "description": "text",
    "publicAddress": "text",
    "enableGatewayPayload": true,
    "enableSSLPayload": true,
    "enableHALBInstance": true,
    "enableDeviceManagement": true,
    "ipVersion": [
      "0 = Version4",
      "1 = Version6",
      "2 = BothVersions"
    ],
    "virtualIPV4": "text",
    "subNetMask": "text",
    "virtualIPV6": "text",
    "prefixIPV6": 1,
    "devices": [
      {
        "deviceIP": "text",
        "deviceId": 1
      }
    ],
    "enableUDPTunneling": true,
    "maxTCPConnections": 1,
    "algorithm": [
      "0 = SourceIP",
      "1 = Cookie"
    ],
    "clientIdleTimeout": 1,
    "gatewayConnectionTimeout": 1,
    "clientQueueTimeout": 1,
    "gatewayIdleTimeout": 1,
    "sessionsRate": 1,
    "gatewayHealthCheckInterval": 1,
    "virtualRouterID": 1,
    "vrrpBroadcastInterval": 1,
    "vrrpHealthCheckInterval": 1,
    "vrrpHealthCheckTimeout": 1,
    "osUpdate": true,
    "vrrpAdvertInterval": 1,
    "keepLBProxyConfig": true,
    "keepVRRPConfig": true,
    "clientManagementConfig": {
      "gateways": {
        "ANY_ADDITIONAL_PROPERTY": 1
      }
    },
    "gatewayConfig": {
      "port": 1,
      "gateways": {
        "ANY_ADDITIONAL_PROPERTY": 1
      }
    },
    "sslConfig": {
      "minSSLVersion": [
        "2 = TLSv1",
        "3 = TLSv1_1",
        "4 = TLSv1_2",
        "5 = TLSv1_3"
      ],
      "sslMode": [
        "0 = SSLOffloading",
        "1 = SSLPassthrough"
      ],
      "sslCustomCipher": "text",
      "sslCipherStrength": [
        "0 = Low",
        "1 = Medium",
        "2 = High",
        "3 = Custom"
      ],
      "sslCipherPreference": true,
      "certID": 1,
      "gatewayConfig": {
        "port": 1,
        "gateways": {
          "ANY_ADDITIONAL_PROPERTY": 1
        }
      }
    }
  }
]

Get

get

Retrieve a specific HALB Virtual Server

Path parameters

idinteger · int32Required

The ID of the HALB Virtual Server

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/HALB/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-23T11:19:57.125Z",
  "timeLastMod": "2025-05-23T11:19:57.125Z",
  "name": "text",
  "siteId": 1,
  "description": "text",
  "publicAddress": "text",
  "enableGatewayPayload": true,
  "enableSSLPayload": true,
  "enableHALBInstance": true,
  "enableDeviceManagement": true,
  "ipVersion": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ],
  "virtualIPV4": "text",
  "subNetMask": "text",
  "virtualIPV6": "text",
  "prefixIPV6": 1,
  "devices": [
    {
      "deviceIP": "text",
      "deviceId": 1
    }
  ],
  "enableUDPTunneling": true,
  "maxTCPConnections": 1,
  "algorithm": [
    "0 = SourceIP",
    "1 = Cookie"
  ],
  "clientIdleTimeout": 1,
  "gatewayConnectionTimeout": 1,
  "clientQueueTimeout": 1,
  "gatewayIdleTimeout": 1,
  "sessionsRate": 1,
  "gatewayHealthCheckInterval": 1,
  "virtualRouterID": 1,
  "vrrpBroadcastInterval": 1,
  "vrrpHealthCheckInterval": 1,
  "vrrpHealthCheckTimeout": 1,
  "osUpdate": true,
  "vrrpAdvertInterval": 1,
  "keepLBProxyConfig": true,
  "keepVRRPConfig": true,
  "clientManagementConfig": {
    "gateways": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  },
  "gatewayConfig": {
    "port": 1,
    "gateways": {
      "ANY_ADDITIONAL_PROPERTY": 1
    }
  },
  "sslConfig": {
    "minSSLVersion": [
      "2 = TLSv1",
      "3 = TLSv1_1",
      "4 = TLSv1_2",
      "5 = TLSv1_3"
    ],
    "sslMode": [
      "0 = SSLOffloading",
      "1 = SSLPassthrough"
    ],
    "sslCustomCipher": "text",
    "sslCipherStrength": [
      "0 = Low",
      "1 = Medium",
      "2 = High",
      "3 = Custom"
    ],
    "sslCipherPreference": true,
    "certID": 1,
    "gatewayConfig": {
      "port": 1,
      "gateways": {
        "ANY_ADDITIONAL_PROPERTY": 1
      }
    }
  }
}

Delete

delete

Remove the specific HALB Virtual Server settings and un-initialize any HALB Devices used by it.

Path parameters

idinteger · int32Required

The ID of the HALB Virtual Server

Query parameters

noUnInstallbooleanOptional

If specified the HALB devices will not be un-initialized.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/HALB/{id} HTTP/1.1
Host: 
Accept: */*

No content

Update

put

Modify the settings of the specific HALB Virtual Server

Path parameters

idinteger · int32Required

The ID of the HALB Virtual Server

Body

Update a HALB Virtual Server

descriptionstring | nullableOptional

The HALB Virtual Server description.

publicAddressstring | nullableOptional

The HALB Virtual Server Public Address.

virtualIPv4string | nullableOptional

The IPv4 of the HALB Virtual Server.

subnetMaskstring | nullableOptional

The Subnet Mask of the HALB Virtual Server.

virtualIPv6string | nullableOptional

The IPv6 of the HALB Virtual Server.

prefixIPV6integer · int32 | nullableOptional

The IPv6 Prefix of the HALB Virtual Server.

enableTunnelingboolean | nullableOptional

Enable/Disable the RDP/UDP of the HALB Virtual Server.

maxTCPConnectionsinteger · int32 | nullableOptional

The Maximum allowed TCP Connections to the HALB Virtual Server.

vrrpAuthenticationPasswordstring | nullableOptional

The VRRP Authentication password.

clientIdleTimeoutinteger · int32 | nullableOptional

The client inactivity timeout.

gatewayConnectionTimeoutinteger · int32 | nullableOptional

The Gateway connection timeout.

clientQueueTimeoutinteger · int32 | nullableOptional

The client queue timeout.

gatewayIdleTimeoutinteger · int32 | nullableOptional

The Gateway inactivity timeout.

sessionRateinteger · int32 | nullableOptional

The amount of TCP connections per second.

gatewayHealthCheckIntervalsinteger · int32 | nullableOptional

The Gateway Health check intervals in seconds.

vrrpVirtualRouterIDinteger · int32 | nullableOptional

The Virtual Router ID of HALB Virtual Server (if not set, the router ID will be automatically computed).

vrrpBroadcastIntervalinteger · int32 | nullableOptional

The VRRP broadcast interval in minutes.

vrrpHealthScriptCheckIntervalinteger · int32 | nullableOptional

The VRRP health script check interval in seconds.

vrrpHealthScriptCheckTimeoutinteger · int32 | nullableOptional

The VRRP health script check timeout in seconds.

vrrpAdvertisementIntervalinteger · int32 | nullableOptional

The VRRP Advertisement interval in seconds.

enableOSUpdatesboolean | nullableOptional

Enable/Disable OS updates.

keepLBProxyConfigboolean | nullableOptional

Enable/Disable keeping of existing loadbalancing settings.

keepVRRPConfigboolean | nullableOptional

Enable/Disable keeping of existing VRRP/keepalive settings.

lbGatewaysstring[] | nullableOptional

The list of the Non-SSL Gateways for HALB Virtual Server.

lbGatewayPortinteger · int32 | nullableOptional

The Non-SSL Gateway port.

sslModestring · enumOptional

Load Balancing SSL Mode

Possible values:

lbsslGatewaysstring[] | nullableOptional

The list of the SSL Gateways for HALB Virtual Server.

lbsslGatewayPortinteger · int32 | nullableOptional

The SSL Gateway port.

acceptedSSLVersionstring · enumOptional

Accepted SSL Versions

Possible values:

cipherStrengthstring · enumOptional

Cipher Strength

Possible values:

cipherPreferenceboolean | nullableOptional

Enable or disable 'Use ciphers according to server preference'.

sslCustomCipherstring | nullableOptional

The SSL custom cipher for SSL Gateways.

certificateIDinteger · int32 | nullableOptional

The certificate ID.

deviceManagerGatewaysstring[] | nullableOptional

The list of the Device Management Gateways for HALB Virtual Server.

namestring | nullableOptional

The new name for the HALB Virtual Server.

enabledboolean | nullableOptional

Enable/Disable HALB Virtual Server.

ipVersionstring · enumOptional

IP Version

Possible values:

enableGatewayPayloadboolean | nullableOptional

Enable/Disable the Non-SSL Gateway configuration of the HALB Virtual Server .

enableSSLPayloadboolean | nullableOptional

Enable/Disable the SSL Gateway configuration of the HALB Virtual Server.

enableDeviceManagementboolean | nullableOptional

Enable/Disable the Device Management configuration of the HALB Virtual Server.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/HALB/{id} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 1121

{
  "description": "text",
  "publicAddress": "text",
  "virtualIPv4": "text",
  "subnetMask": "text",
  "virtualIPv6": "text",
  "prefixIPV6": 1,
  "enableTunneling": true,
  "maxTCPConnections": 1,
  "vrrpAuthenticationPassword": "text",
  "clientIdleTimeout": 1,
  "gatewayConnectionTimeout": 1,
  "clientQueueTimeout": 1,
  "gatewayIdleTimeout": 1,
  "sessionRate": 1,
  "gatewayHealthCheckIntervals": 1,
  "vrrpVirtualRouterID": 1,
  "vrrpBroadcastInterval": 1,
  "vrrpHealthScriptCheckInterval": 1,
  "vrrpHealthScriptCheckTimeout": 1,
  "vrrpAdvertisementInterval": 1,
  "enableOSUpdates": true,
  "keepLBProxyConfig": true,
  "keepVRRPConfig": true,
  "lbGateways": [
    "text"
  ],
  "lbGatewayPort": 1,
  "sslMode": [
    "0 = SSLOffloading",
    "1 = SSLPassthrough"
  ],
  "lbsslGateways": [
    "text"
  ],
  "lbsslGatewayPort": 1,
  "acceptedSSLVersion": [
    "2 = TLSv1",
    "3 = TLSv1_1",
    "4 = TLSv1_2",
    "5 = TLSv1_3"
  ],
  "cipherStrength": [
    "0 = Low",
    "1 = Medium",
    "2 = High",
    "3 = Custom"
  ],
  "cipherPreference": true,
  "sslCustomCipher": "text",
  "certificateID": 1,
  "deviceManagerGateways": [
    "text"
  ],
  "name": "text",
  "enabled": true,
  "ipVersion": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ],
  "enableGatewayPayload": true,
  "enableSSLPayload": true,
  "enableDeviceManagement": true
}

No content