HALBs

List

Retrieve a list of the HALB Virtual Server settings.

GET/api/HALB

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.

namenullable string

Appliance name.

siteIdinteger (int32)

The site ID of this HALB Virtual Server.

descriptionnullable string

Appliance description.

publicAddressnullable string

The Public Address of the HALB.

enableGatewayPayloadboolean

Whether the Gateway payload is enabled or not.

enableSSLPayloadboolean

Whether the SSL payload is enabled or not.

enableHALBInstanceboolean

Whether the HALB instance is enabled or not.

enableDeviceManagementboolean

Whether the Device Management is enabled or not.

ipVersionIPVersion (enum)

IP Version

0 = Version4,1 = Version6,2 = BothVersions

virtualIPV4nullable string

Virtual IP Version 4

subNetMasknullable string

SubNet Mask

virtualIPV6nullable string

Virtual IP Version 6

prefixIPV6integer (int32)

Prefix for IP Version 6

devicesnullable array of HALBDevice (object)

A collection of HALB Devices

enableUDPTunnelingboolean

Whether RDP UDP tunneling is enabled or not.

maxTCPConnectionsinteger (int32)

Maximum number of TCP connections.

algorithmLoadBalancingAlgorithm (enum)

Load Balancing Algorithm

0 = SourceIP,1 = Cookie

clientIdleTimeoutinteger (int32)

Client inactivity timeout

gatewayConnectionTimeoutinteger (int32)

Gateway connection timeout

clientQueueTimeoutinteger (int32)

Client connection queue timeout

gatewayIdleTimeoutinteger (int32)

Gateway inactivity timeout

sessionsRateinteger (int32)

Amount of TCP connections per second

gatewayHealthCheckIntervalinteger (int32)

Gateways health check intervals

virtualRouterIDinteger (int32)

VRRP virtual router ID Value between 0 and 255 unique per site. Value should be randomized to increase probability that it's also unique between farms.

vrrpBroadcastIntervalinteger (int32)

VRRP broadcast interval

vrrpHealthCheckIntervalinteger (int32)

VRRP health script check interval

vrrpHealthCheckTimeoutinteger (int32)

VRRP health script check timeout

osUpdateboolean

Whether OS updates are enabled or not

vrrpAdvertIntervalinteger (int32)

VRRP advertisement interval

keepLBProxyConfigboolean

Keep existing load balancing settings

keepVRRPConfigboolean

Keep existing VRRP/keepalived setting

clientManagementConfigHALBClientManagerConfigSettings (object)

HALB Device Manager configuration settings

gatewayConfigHALBGatewayConfigSettings (object)

HALB Gateway configuration settings

sslConfigHALBSSLConfigSettings (object)

HALB SSL configuration settings

Request

JavaScriptCurlPython

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

Response

200401404

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T07:31:26.211Z",
    "timeLastMod": "2024-11-07T07:31:26.211Z",
    "name": "text",
    "description": "text",
    "publicAddress": "text",
    "enableGatewayPayload": false,
    "enableSSLPayload": false,
    "enableHALBInstance": false,
    "enableDeviceManagement": false,
    "ipVersion": [
      "0 = Version4",
      "1 = Version6",
      "2 = BothVersions"
    ],
    "virtualIPV4": "text",
    "subNetMask": "text",
    "virtualIPV6": "text",
    "devices": [
      {
        "deviceIP": "text"
      }
    ],
    "enableUDPTunneling": false,
    "algorithm": [
      "0 = SourceIP",
      "1 = Cookie"
    ],
    "osUpdate": false,
    "keepLBProxyConfig": false,
    "keepVRRPConfig": false,
    "clientManagementConfig": {},
    "gatewayConfig": {},
    "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": false,
      "gatewayConfig": {}
    }
  }
]

Create

Create a new entry for the HALB Virtual Server settings

POST/api/HALB

Query parameters

Body

application/json; api-version=1.0

The HALB Virtual Server settings

descriptionnullable string

The HALB Virtual Server description.

publicAddressnullable string

The HALB Virtual Server Public Address.

virtualIPv4nullable string

The IPv4 of the HALB Virtual Server.

subnetMasknullable string

The Subnet Mask of the HALB Virtual Server.

virtualIPv6nullable string

The IPv6 of the HALB Virtual Server.

prefixIPV6nullable integer (int32)

The IPv6 Prefix of the HALB Virtual Server.

enableTunnelingnullable boolean

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

maxTCPConnectionsnullable integer (int32)

The Maximum allowed TCP Connections to the HALB Virtual Server.

vrrpAuthenticationPasswordnullable string

The VRRP Authentication password.

clientIdleTimeoutnullable integer (int32)

The client inactivity timeout.

gatewayConnectionTimeoutnullable integer (int32)

The Gateway connection timeout.

clientQueueTimeoutnullable integer (int32)

The client queue timeout.

gatewayIdleTimeoutnullable integer (int32)

The Gateway inactivity timeout.

sessionRatenullable integer (int32)

The amount of TCP connections per second.

gatewayHealthCheckIntervalsnullable integer (int32)

The Gateway Health check intervals in seconds.

vrrpVirtualRouterIDnullable integer (int32)

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

vrrpBroadcastIntervalnullable integer (int32)

The VRRP broadcast interval in minutes.

vrrpHealthScriptCheckIntervalnullable integer (int32)

The VRRP health script check interval in seconds.

vrrpHealthScriptCheckTimeoutnullable integer (int32)

The VRRP health script check timeout in seconds.

vrrpAdvertisementIntervalnullable integer (int32)

The VRRP Advertisement interval in seconds.

enableOSUpdatesnullable boolean

Enable/Disable OS updates.

keepLBProxyConfignullable boolean

Enable/Disable keeping of existing loadbalancing settings.

keepVRRPConfignullable boolean

Enable/Disable keeping of existing VRRP/keepalive settings.

lbGatewaysnullable array of string

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

lbGatewayPortnullable integer (int32)

The Non-SSL Gateway port.

sslModeLoadBalancingSSLMode (enum)

Load Balancing SSL Mode

0 = SSLOffloading,1 = SSLPassthrough

lbsslGatewaysnullable array of string

The list of the SSL Gateways for HALB Virtual Server.

lbsslGatewayPortnullable integer (int32)

The SSL Gateway port.

acceptedSSLVersionAcceptedSSLVersion (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

cipherPreferencenullable boolean

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

sslCustomCiphernullable string

The SSL custom cipher for SSL Gateways.

certificateIDnullable integer (int32)

The certificate ID.

deviceManagerGatewaysnullable array of string

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

name*nullable string

The HALB Virtual Server name.

siteIdinteger (int32)

The site ID where the HALB settings will be created.

ipVersion*IPVersion (enum)

IP Version

0 = Version4,1 = Version6,2 = BothVersions

deviceIPsnullable array of string

The list of the HALB Device IPs.

enableGatewayPayloadboolean

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

enableSSLPayloadboolean

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

enableDeviceManagementboolean

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

Response

201401

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.

namenullable string

Appliance name.

siteIdinteger (int32)

The site ID of this HALB Virtual Server.

descriptionnullable string

Appliance description.

publicAddressnullable string

The Public Address of the HALB.

enableGatewayPayloadboolean

Whether the Gateway payload is enabled or not.

enableSSLPayloadboolean

Whether the SSL payload is enabled or not.

enableHALBInstanceboolean

Whether the HALB instance is enabled or not.

enableDeviceManagementboolean

Whether the Device Management is enabled or not.

ipVersionIPVersion (enum)

IP Version

0 = Version4,1 = Version6,2 = BothVersions

virtualIPV4nullable string

Virtual IP Version 4

subNetMasknullable string

SubNet Mask

virtualIPV6nullable string

Virtual IP Version 6

prefixIPV6integer (int32)

Prefix for IP Version 6

devicesnullable array of HALBDevice (object)

A collection of HALB Devices

enableUDPTunnelingboolean

Whether RDP UDP tunneling is enabled or not.

maxTCPConnectionsinteger (int32)

Maximum number of TCP connections.

algorithmLoadBalancingAlgorithm (enum)

Load Balancing Algorithm

0 = SourceIP,1 = Cookie

clientIdleTimeoutinteger (int32)

Client inactivity timeout

gatewayConnectionTimeoutinteger (int32)

Gateway connection timeout

clientQueueTimeoutinteger (int32)

Client connection queue timeout

gatewayIdleTimeoutinteger (int32)

Gateway inactivity timeout

sessionsRateinteger (int32)

Amount of TCP connections per second

gatewayHealthCheckIntervalinteger (int32)

Gateways health check intervals

virtualRouterIDinteger (int32)

VRRP virtual router ID Value between 0 and 255 unique per site. Value should be randomized to increase probability that it's also unique between farms.

vrrpBroadcastIntervalinteger (int32)

VRRP broadcast interval

vrrpHealthCheckIntervalinteger (int32)

VRRP health script check interval

vrrpHealthCheckTimeoutinteger (int32)

VRRP health script check timeout

osUpdateboolean

Whether OS updates are enabled or not

vrrpAdvertIntervalinteger (int32)

VRRP advertisement interval

keepLBProxyConfigboolean

Keep existing load balancing settings

keepVRRPConfigboolean

Keep existing VRRP/keepalived setting

clientManagementConfigHALBClientManagerConfigSettings (object)

HALB Device Manager configuration settings

gatewayConfigHALBGatewayConfigSettings (object)

HALB Gateway configuration settings

sslConfigHALBSSLConfigSettings (object)

HALB SSL configuration settings

Request

JavaScriptCurlPython

const response = await fetch('/api/HALB', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "ipVersion": [
        "0 = Version4",
        "1 = Version6",
        "2 = BothVersions"
      ],
      "name": "text"
    }),
});
const data = await response.json();

Response

201401

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:31:26.211Z",
  "timeLastMod": "2024-11-07T07:31:26.211Z",
  "name": "text",
  "description": "text",
  "publicAddress": "text",
  "enableGatewayPayload": false,
  "enableSSLPayload": false,
  "enableHALBInstance": false,
  "enableDeviceManagement": false,
  "ipVersion": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ],
  "virtualIPV4": "text",
  "subNetMask": "text",
  "virtualIPV6": "text",
  "devices": [
    {
      "deviceIP": "text"
    }
  ],
  "enableUDPTunneling": false,
  "algorithm": [
    "0 = SourceIP",
    "1 = Cookie"
  ],
  "osUpdate": false,
  "keepLBProxyConfig": false,
  "keepVRRPConfig": false,
  "clientManagementConfig": {},
  "gatewayConfig": {},
  "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": false,
    "gatewayConfig": {}
  }
}

Get

Retrieve a specific HALB Virtual Server

GET/api/HALB/{id}

Path parameters

id*integer (int32)

The ID of the HALB Virtual Server

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.

namenullable string

Appliance name.

siteIdinteger (int32)

The site ID of this HALB Virtual Server.

descriptionnullable string

Appliance description.

publicAddressnullable string

The Public Address of the HALB.

enableGatewayPayloadboolean

Whether the Gateway payload is enabled or not.

enableSSLPayloadboolean

Whether the SSL payload is enabled or not.

enableHALBInstanceboolean

Whether the HALB instance is enabled or not.

enableDeviceManagementboolean

Whether the Device Management is enabled or not.

ipVersionIPVersion (enum)

IP Version

0 = Version4,1 = Version6,2 = BothVersions

virtualIPV4nullable string

Virtual IP Version 4

subNetMasknullable string

SubNet Mask

virtualIPV6nullable string

Virtual IP Version 6

prefixIPV6integer (int32)

Prefix for IP Version 6

devicesnullable array of HALBDevice (object)

A collection of HALB Devices

enableUDPTunnelingboolean

Whether RDP UDP tunneling is enabled or not.

maxTCPConnectionsinteger (int32)

Maximum number of TCP connections.

algorithmLoadBalancingAlgorithm (enum)

Load Balancing Algorithm

0 = SourceIP,1 = Cookie

clientIdleTimeoutinteger (int32)

Client inactivity timeout

gatewayConnectionTimeoutinteger (int32)

Gateway connection timeout

clientQueueTimeoutinteger (int32)

Client connection queue timeout

gatewayIdleTimeoutinteger (int32)

Gateway inactivity timeout

sessionsRateinteger (int32)

Amount of TCP connections per second

gatewayHealthCheckIntervalinteger (int32)

Gateways health check intervals

virtualRouterIDinteger (int32)

VRRP virtual router ID Value between 0 and 255 unique per site. Value should be randomized to increase probability that it's also unique between farms.

vrrpBroadcastIntervalinteger (int32)

VRRP broadcast interval

vrrpHealthCheckIntervalinteger (int32)

VRRP health script check interval

vrrpHealthCheckTimeoutinteger (int32)

VRRP health script check timeout

osUpdateboolean

Whether OS updates are enabled or not

vrrpAdvertIntervalinteger (int32)

VRRP advertisement interval

keepLBProxyConfigboolean

Keep existing load balancing settings

keepVRRPConfigboolean

Keep existing VRRP/keepalived setting

clientManagementConfigHALBClientManagerConfigSettings (object)

HALB Device Manager configuration settings

gatewayConfigHALBGatewayConfigSettings (object)

HALB Gateway configuration settings

sslConfigHALBSSLConfigSettings (object)

HALB SSL configuration settings

Request

JavaScriptCurlPython

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

Response

200401404

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:31:26.211Z",
  "timeLastMod": "2024-11-07T07:31:26.211Z",
  "name": "text",
  "description": "text",
  "publicAddress": "text",
  "enableGatewayPayload": false,
  "enableSSLPayload": false,
  "enableHALBInstance": false,
  "enableDeviceManagement": false,
  "ipVersion": [
    "0 = Version4",
    "1 = Version6",
    "2 = BothVersions"
  ],
  "virtualIPV4": "text",
  "subNetMask": "text",
  "virtualIPV6": "text",
  "devices": [
    {
      "deviceIP": "text"
    }
  ],
  "enableUDPTunneling": false,
  "algorithm": [
    "0 = SourceIP",
    "1 = Cookie"
  ],
  "osUpdate": false,
  "keepLBProxyConfig": false,
  "keepVRRPConfig": false,
  "clientManagementConfig": {},
  "gatewayConfig": {},
  "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": false,
    "gatewayConfig": {}
  }
}

Update

Modify the settings of the specific HALB Virtual Server

PUT/api/HALB/{id}

Path parameters

id*integer (int32)

The ID of the HALB Virtual Server

Body

application/json; api-version=1.0

The HALB Virtual Server settings

descriptionnullable string

The HALB Virtual Server description.

publicAddressnullable string

The HALB Virtual Server Public Address.

virtualIPv4nullable string

The IPv4 of the HALB Virtual Server.

subnetMasknullable string

The Subnet Mask of the HALB Virtual Server.

virtualIPv6nullable string

The IPv6 of the HALB Virtual Server.

prefixIPV6nullable integer (int32)

The IPv6 Prefix of the HALB Virtual Server.

enableTunnelingnullable boolean

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

maxTCPConnectionsnullable integer (int32)

The Maximum allowed TCP Connections to the HALB Virtual Server.

vrrpAuthenticationPasswordnullable string

The VRRP Authentication password.

clientIdleTimeoutnullable integer (int32)

The client inactivity timeout.

gatewayConnectionTimeoutnullable integer (int32)

The Gateway connection timeout.

clientQueueTimeoutnullable integer (int32)

The client queue timeout.

gatewayIdleTimeoutnullable integer (int32)

The Gateway inactivity timeout.

sessionRatenullable integer (int32)

The amount of TCP connections per second.

gatewayHealthCheckIntervalsnullable integer (int32)

The Gateway Health check intervals in seconds.

vrrpVirtualRouterIDnullable integer (int32)

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

vrrpBroadcastIntervalnullable integer (int32)

The VRRP broadcast interval in minutes.

vrrpHealthScriptCheckIntervalnullable integer (int32)

The VRRP health script check interval in seconds.

vrrpHealthScriptCheckTimeoutnullable integer (int32)

The VRRP health script check timeout in seconds.

vrrpAdvertisementIntervalnullable integer (int32)

The VRRP Advertisement interval in seconds.

enableOSUpdatesnullable boolean

Enable/Disable OS updates.

keepLBProxyConfignullable boolean

Enable/Disable keeping of existing loadbalancing settings.

keepVRRPConfignullable boolean

Enable/Disable keeping of existing VRRP/keepalive settings.

lbGatewaysnullable array of string

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

lbGatewayPortnullable integer (int32)

The Non-SSL Gateway port.

sslModeLoadBalancingSSLMode (enum)

Load Balancing SSL Mode

0 = SSLOffloading,1 = SSLPassthrough

lbsslGatewaysnullable array of string

The list of the SSL Gateways for HALB Virtual Server.

lbsslGatewayPortnullable integer (int32)

The SSL Gateway port.

acceptedSSLVersionAcceptedSSLVersion (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

cipherPreferencenullable boolean

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

sslCustomCiphernullable string

The SSL custom cipher for SSL Gateways.

certificateIDnullable integer (int32)

The certificate ID.

deviceManagerGatewaysnullable array of string

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

namenullable string

The new name for the HALB Virtual Server.

enablednullable boolean

Enable/Disable HALB Virtual Server.

ipVersionIPVersion (enum)

IP Version

0 = Version4,1 = Version6,2 = BothVersions

enableGatewayPayloadnullable boolean

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

enableSSLPayloadnullable boolean

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

enableDeviceManagementnullable boolean

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

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/HALB/{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

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

DELETE/api/HALB/{id}

Path parameters

id*integer (int32)

The ID of the HALB Virtual Server

Query parameters

Response

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

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